Jenkinsユーザードキュメント(Mavenを使用してJavaアプリケーションを構築)

7276 ワード

Mavenを使用したJavaアプリケーションの構築
このチュートリアルでは、Jenkinsを使用してMavenを使用して簡単なJavaアプリケーションを構築する方法を示します.
Mavenを使用してCI/CDの概念に詳しくないJava開発者である場合、Jenkinsを使用してアプリケーションの構築を実現する方法を知らない場合は、このチュートリアルが適しています.
簡単なJavaアプリケーション(GitHubのサンプル・リポジトリから取得)出力文字列「Hello world!」には、プライマリ・アプリケーションが予想通りに動作しているかどうかを確認するためのユニット・テストが付属しており、これらのテストの結果はJUnit XMLレポートに保存されます.
期間:このチュートリアルは、マシンの速度とDockerのJenkinsを別のチュートリアルから実行したかどうかによって、20~40分かかります(以下の前提条件を満たしていると仮定します).
このチュートリアルをいつでも停止し、最後に停止した場所から続行できます.
別のチュートリアルを実行している場合は、次の前提条件をスキップしてDockerでJenkinsセクションを実行し、サンプル・リポジトリの分析を続行します(Gitがローカルにインストールされていることを確認します).Jenkinsを再起動する必要がある場合は、Jenkinsの再起動の指示に従って停止し、再起動します.
前提条件
このチュートリアルでは、次のことが必要です.
  • macOS、LinuxまたはWindowsマシン:
  • 256 MBのRAMですが、512 MBを超えることをお勧めします.
  • JenkinsおよびDockerミラーとコンテナの10 GBドライブスペース.

  • には、次のソフトウェアがインストールされています.
  • Docker-このチュートリアルでは、JenkinsのインストールページのインストールDockerセクションでDockerのインストールに関する詳細を参照してください.Linuxを使用する場合は、rootユーザーとしてDockerコマンドを実行するのではなく、このチュートリアルで使用する他のツールに単一のユーザーアカウントを使用してアクセスすると仮定します.
  • GitおよびオプションGitHub Desktop.


  • DockerでJenkinsを実行
    このチュートリアルでは、jenkinsci/blueocean DockerミラーからJenkinsをDockerコンテナとして実行します.
    DockerでJenkinsを実行するには、macOSおよびLinuxまたはWindowsの説明に従います.
    JenkinsページをインストールするDockerとDockerでJenkinsをダウンロードして実行する部分で、Dockerコンテナとミラーの概念に関する詳細を読むことができます.
    MacOSとLinuxで
  • ターミナルウィンドウが開きます.
  • 次のdocker runコマンドを使用して、jenkinsci/blueoceanミラーをDockerのコンテナとして実行します(まだ実行されていない場合、このコマンドはミラーを自動的にダウンロードします):
    docker run \
     --rm \
     -u root \
     -p 8080:8080 \
     -v jenkins-data:/var/jenkins_home \
     -v /var/run/docker.sock:/var/run/docker.sock \
     -v "$HOME":/home \
     jenkinsci/blueocean
  • コンテナ内の/var/jenkins_homeディレクトリをjenkins-dataというDockerボリュームにマッピングします.このボリュームが存在しない場合、このdocker runコマンドは自動的にボリュームを作成します.
  • は、ホスト(すなわちローカル)コンピュータ上の$HOMEディレクトリ(通常は/Users/ディレクトリ)をコンテナ内の/homeディレクトリにマッピングする.

  • インストールウィザードを続行します.

  • Windowsで
  • コマンドプロンプトウィンドウを開きます.
  • 次のdocker runコマンドを使用して、jenkinsci/blueoceanミラーをDockerのコンテナとして実行します(このコマンドがまだ実行されていない場合は、ミラーが自動的にダウンロードされます):
    docker run ^
     --rm ^
     -u root ^
     -p 8080:8080 ^
     -v jenkins-data:/var/jenkins_home ^
     -v /var/run/docker.sock:/var/run/docker.sock ^
     -v "%HOMEPATH%":/home ^
     jenkinsci/blueocean
    これらのオプションの説明は、上記のmacOSおよびLinuxの説明を参照してください.
  • インストールウィザードを続行します.

  • Jenkins/Blue Ocean Dockerコンテナへのアクセス
    Dockerを使用した経験があり、docker execコマンドを使用してJenkins/Blue Ocean Dockerコンテナにターミナル/コマンドプロンプトでアクセスする必要がある場合は、--name jenkins-tutorials(上のdocker runコマンド)のようなオプションを追加できます.これはJenkins/Blue Ocean Dockerコンテナに「jenkins-tutorials」と命名されます.
    これは、docker execコマンドを使用してJenkins/Blue Oceanコンテナにアクセスできることを意味します.たとえば、次のようにします.
    docker exec -it jenkins-tutorials bash

    インストールウィザード
    Jenkinsにアクセスする前に、迅速な「使い捨て」ステップを実行する必要があります.
    ロック解除Jenkins
    新しいJenkinsインスタンスに初めてアクセスすると、自動的に生成されたパスワードを使用してロックを解除するように要求されます.
  • 端末/コマンドプロンプトウィンドウに2つのアスタリスクが表示された後、http://localhost:8080に移動し、ロック解除Jenkinsページが表示されるまで待機します.
  • は、自動的に生成されたアルファベット数字のパスワード(2つの星のグループの間)をターミナル/コマンドプロンプトウィンドウからコピーします.
  • [Jenkinsをロック解除]ページで、このパスワードを フィールドに貼り付けて、[続行]をクリックします.

  • プラグインを使用してJenkinsをカスタマイズする
    Jenkinsをロック解除すると、カスタムJenkinsページが表示されます.
    このページで、「推奨プラグインのインストール」をクリックします.
    インストールウィザードには、構成中のJenkinsの進捗状況と、インストール中の推奨プラグインが表示されます.このプロセスには数分かかる場合があります.
    最初の管理者ユーザーの作成
    最後に、Jenkinsはあなたに最初の管理者ユーザーを作成するように要求しました.
  • 最初の管理者ユーザーの作成ページが表示されたら、該当するフィールドに詳細を指定し、「≪保存|Save|ldap≫」をクリックして完了します.
  • Jenkinsが準備完了したとき!ページが表示されたら、[開始]をクリックしてJenkinsを使用します.
  • このページはJenkinsが準備ができていることを示しているかもしれません!逆に、もしそうであれば、「再起動」をクリックします.
  • ページが1分後に自動的にリフレッシュされない場合は、Webブラウザを使用して手動でページをリフレッシュします.

  • 必要に応じて、作成したばかりのユーザーの証明書を使用してJenkinsにログインすると、Jenkinsを使用することができます!

  • Jenkinsの停止と再起動
    このチュートリアルの残りの部分では、上記のdocker run ...コマンドを実行するターミナル/コマンドプロンプトウィンドウにCtrl-Cと入力してJenkins/Blue Ocean Dockerコンテナを停止できます.
    Jenkins/Blue Ocean Dockerコンテナを再起動するには、次の手順に従います.
  • 上記のmacOS、LinuxまたはWindowsと同じdocker run ...コマンドを実行します.注:更新されたミラーがある場合、jenkinsci/blueocean Dockerミラーも更新されます.
  • http://localhost:8080を参照してください.
  • ログインページが表示されてログインするまで待ちます.

  • GitHub上でForkとcloneサンプルリポジトリ
    GitHubから簡単な「Hello world!」Javaアプリケーションを取得し、アプリケーションのソースコードのサンプルリポジトリforkを自分のGitHubアカウントにコピーし、そのforkをローカルにクローンします.
  • GitHubアカウントにログインしていることを確認します.GitHubアカウントがまだない場合は、GitHubサイトに無料アカウントを登録してください.
  • GitHubのsimple-java-maven-appプロジェクトforkをローカルのGitHubアカウントに移動します.この手順については、GitHubのWebサイトのFork A Repoドキュメントを参照してください.
  • forkのsimple-java-maven-appリポジトリ(GitHub上)をクローンしてコンピュータにローカルに移動します.この手順を開始するには、次のいずれかの操作を行います(はオペレーティングシステム上のユーザーアカウントの名前です).
  • コンピュータにGitHub Desktopアプリケーションがインストールされている場合:
  • GitHubでforkのリポジトリの緑のClone or downloadボタンをクリックし、Open in Desktopをクリックします.
  • GitHub DesktopでClone a RepositoryダイアログボックスでCloneをクリックする前に、ローカルパスが次のようになっていることを確認します.
  • macOSは/Users//Documents/GitHub/simple-java-maven-app
  • である.
  • Linuxは/home//GitHub/simple-java-maven-app
  • です
  • WindowsはC:\Users\\Documents\GitHub\simple-java-maven-app

  • それ以外の場合:
  • 端末/コマンドラインプロンプトを開き、cdを対応するディレクトリに移動します.
  • macOS — /Users//Documents/GitHub/
  • Linux — /home//GitHub/
  • Windows-C:\Users\\Documents\GitHub\(通常のMicrosoftコマンドプロンプトではなくGit bashコマンドラインウィンドウを使用する場合でも)
  • 次のコマンドを実行して、forkのリポジトリのクローンを続行/完了します.git clone https://github.com/YOUR-GITHUB-ACCOUNT-NAME/simple-java-maven-appのうち、YOUR-GITHUB-ACCOUNT-NAMEはGitHubアカウントの名前です.



  • Jenkinsでパイプアイテムを作成するには
  • Jenkinsに戻り、必要に応じて再度ログインし、「新規タスク」をクリックします.注意:この内容が表示されない場合は、左上隅の新しいアイテムをクリックします.
  • 「タスク名を入力」フィールドで、新しいパイプ・アイテムの名前(たとえば、simple-java-maven-app)を指定します.
  • を下にスクロールして「パイプライン」をクリックし、ページの最後にある「OK」をクリックします.
  • (オプション)次のページでは、説明フィールドにパイプの簡単な説明を指定します(たとえば、Jenkinsを使用してMavenを使用して簡単なJavaアプリケーションの入門レベルのパイプを構築する方法を説明します).
  • ページ上部のPipelineタブをクリックして、Pipelineセクションにスクロールします.
  • DefinitionフィールドからPipeline script from SCMオプションを選択します.このオプションは、Jenkinsがローカルにクローン化されたGitリポジトリになるパイプラインをソース制御管理(SCM)から取得することを示します.
  • SCMフィールドからGitを選択します.
  • Repository URLフィールドでは、ホスト上のユーザーアカウント/ホームから、Jenkinsコンテナの/homeディレクトリにマッピングされた上でローカルにクローン化されたリポジトリのディレクトリパスを指定します.
  • macOS-/home/Documents/GitHub/simple-java-maven-app
  • Linux-/home/GitHub/simple-java-maven-app
  • Windows-/home/Documents/GitHub/simple-java-maven-app
  • 「保存」をクリックして新しいパイプラインプロジェクトを保存します.Jenkinsfileの作成を開始する準備ができています.ローカルクローンのGitリポジトリにチェックインします.

  • 下一篇:配置