チュートリアル: GitHub と Docker を使用して Jenkins パイプラインを作成する

[アーティクル]
06/08/2023

重要

多くの Azure サービスには Jenkins プラグインがあります。これらのプラグインの一部は、2024 年 2 月 29 日時点ではサポート対象外となります。 Azure CLI は、Jenkins と Azure サービスを統合するために現在推奨されている方法です。詳細については、「Azure 用の Jenkins プラグイン」を参照してください。

アプリケーション開発のビルドおよびテストフェーズを自動化する場合は、継続的インテグレーション/デプロイ (CI/CD) パイプラインを使用できます。このチュートリアルでは、Azure VM で CI/CD パイプラインを作成します｡この作成は､以下のような手順で構成されます｡

Jenkins VM を作成する
Jenkins をインストール､構成する
GitHub と Jenkins 間に webhook 統合を作成する
GitHub コミットから Jenkins ビルドジョブを作成､トリガーする
アプリ用の Docker イメージを作成する
GitHub によって build new Docker image がコミットされ､動作中のアプリが更新されることを確認する

このチュートリアルでは、Azure Cloud Shell で CLI を使用します。このバージョンは常に更新され最新になっています。 Cloud Shell を開くには、コードブロックの上部にある [使ってみる] を選択します。

CLI をローカルにインストールして使用する場合、このチュートリアルでは、Azure CLI バージョン 2.0.30 以降を実行していることが要件です。バージョンを確認するには、az --version を実行します。インストールまたはアップグレードする必要がある場合は、Azure CLI のインストールに関するページを参照してください。

Jenkins インスタンスを作成する

Linux 仮想マシンを初回起動時にカスタマイズする方法に関する先行のチュートリアルで、cloud-init を使用して VM のカスタマイズを自動化する方法を学習しました。このチュートリアルでは、cloud-init ファイルを使用して、Jenkins と Docker を VM にインストールします。 Jenkins は、広く普及しているオープンソースのオートメーションサーバーで、Azure とシームレスに統合することで、継続的インテグレーション (CI) と継続的デリバリー (CD) が可能になります。 Jenkins の使用方法に関する詳しいチュートリアルについては、Azure ハブでの Jenkins に関する記事をご覧ください。

現在のシェルで、cloud-init-jenkins.txt というファイルを作成し、次の構成を貼り付けます。たとえば、ローカルコンピューター上にない Cloud Shell でファイルを作成します。 sensible-editor cloud-init-jenkins.txt を入力し、ファイルを作成して使用可能なエディターの一覧を確認します。 cloud-init ファイル全体 (特に最初の行) が正しくコピーされたことを確認してください。

#cloud-config
package_upgrade: true
write_files:
  - path: /etc/systemd/system/docker.service.d/docker.conf
    content: |
      [Service]
        ExecStart=
        ExecStart=/usr/bin/dockerd
  - path: /etc/docker/daemon.json
    content: |
      {
        "hosts": ["fd://","tcp://127.0.0.1:2375"]
      }
runcmd:
  - apt install openjdk-8-jre-headless -y
  - wget -q -O - https://pkg.jenkins.io/debian/jenkins-ci.org.key | sudo apt-key add -
  - sh -c 'echo deb https://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list'
  - apt-get update && apt-get install jenkins -y
  - curl -sSL https://get.docker.com/ | sh
  - usermod -aG docker azureuser
  - usermod -aG docker jenkins
  - service jenkins restart

VM を作成する前に、az group create を使用してリソースグループを作成します。次の例では、myResourceGroupJenkins という名前のリソースグループを場所 eastus に作成します。

az group create --name myResourceGroupJenkins --location eastus

ここで az vm create を使用して VM を作成します。 --custom-data パラメーターを使用して、cloud-init 構成ファイルを渡します。現在の作業ディレクトリの外部に cloud-init.txt ファイルを保存した場合は、ファイルの完全パスを指定します。

az vm create --resource-group myResourceGroupJenkins \
    --name myVM \
    --image UbuntuLTS \
    --admin-username azureuser \
    --generate-ssh-keys \
    --custom-data cloud-init-jenkins.txt

VM が作成されて構成されるには､数分､時間がかかります｡

VM に対して Web 通信が行えるようにするには､az vm open-port を使用して､Jenkins 通信用にポート 8080､サンプルアプリの実行に使用する Node.js アプリ用にポート 1337 を開きます｡

az vm open-port --resource-group myResourceGroupJenkins --name myVM --port 8080 --priority 1001
az vm open-port --resource-group myResourceGroupJenkins --name myVM --port 1337 --priority 1002

Jenkins を構成する

Jenkins インスタンスにアクセスするには、VM のパブリック IP アドレスを入手します。

az vm show --resource-group myResourceGroupJenkins --name myVM -d --query [publicIps] --o tsv

セキュリティ上､Jenkins のインストールを開始するには VM 上のテキストファイルに格納されている初期管理者パスワードを入力する必要があります｡直前の手順で得られたパブリック IP アドレスを使用して､VM に SSH 接続します｡

ssh azureuser@<publicIps>

service コマンドを使用して、Jenkins が実行されていることを確認します。

$ service jenkins status
● jenkins.service - LSB: Start Jenkins at boot time
   Loaded: loaded (/etc/init.d/jenkins; generated)
   Active: active (exited) since Tue 2019-02-12 16:16:11 UTC; 55s ago
     Docs: man:systemd-sysv-generator(8)
    Tasks: 0 (limit: 4103)
   CGroup: /system.slice/jenkins.service

Feb 12 16:16:10 myVM systemd[1]: Starting LSB: Start Jenkins at boot time...
...

Jenkins インストール用の initialAdminPassword を表示し､コピーします｡

sudo cat /var/lib/jenkins/secrets/initialAdminPassword

ファイルがまだ使用できない場合、 cloud-init が Jenkins および Docker のインストールを完了するまで、さらに数分待機します。

Web ブラウザーを開いて､http://<publicIps>:8080 に移動します｡次のようにして Jenkins の初期設定を行います｡

[Select plug-ins to install]\(インストールするプラグインの選択\) を選択します。
上部のテキストボックスで GitHub を検索します。 GitHub のチェックボックスをオンにし、[Install]\(インストール\) を選択します
最初の管理者ユーザーを作成します。 admin などのユーザー名を入力し、独自の安全なパスワードを入力します。最後に、フルネームとメールアドレスを入力します。
[Save and Finish]\(保存して終了する\) を選択します
Jenkins が準備ができたら、[Start using Jenkins]\(Jenkins の使用を開始する\) を選択します
- Jenkins の使用を開始したときに Web ブラウザーに空白のページが表示された場合は、Jenkins サービスを再起動します。 SSH セッションから「sudo service jenkins restart」と入力し、Web ブラウザーを最新の情報に更新します。
必要な場合は、作成したユーザー名とパスワードを使用して Jenkins にログインします。

GitHub webhook を作成する

GitHub との統合を構成するには､Azures サンプルリポジトリから Node.js Hello World サンプルアプリを開きます｡自身の GitHub アカウントにリポジトリをフォークするには、右上隅の [Fork] ボタンを選択します。

作成したフォーク内に webhook を作成します｡

[Settings]\(設定\) を選択して、左側の [Integrations & services]\(統合とサービス\) を選択します。
[Webhook の追加] を選択し、フィルターボックスに「Jenkins」と入力します。
[Payload URL]\(ペイロード URL\) に、「http://<publicIps>:8080/github-webhook/」と入力します。末尾のスラッシュ (/) を含めていることを確認します。
[コンテンツの種類] で、[application/x-www-form-urlencoded] を選択します。
[Which events would you like to trigger this webhook?]\(この Webhook でトリガーするイベント\) で、[Just the push event]\(プッシュイベントのみ\) を選択します。
[アクティブ] をオンにします。
[Webhook の追加] を選択します。

Add GitHub webhook to your forked repo

Jenkins ジョブを作成する

コードコミットなどの GitHub 内のイベントに Jenkins が応答するようにするには､Jenkins ジョブを作成します｡自分の GitHub フォークの URL を使用します。

Jenkins Web サイトのホームページから [Create new jobs] を選択します。

ジョブ名として HelloWorld を入力します｡ Freestyle プロジェクトを選択し､[OK] をクリックします｡
[General]\(一般\) セクションから [GitHub project]\(GitHub プロジェクト\) を選択し、フォークしたリポジトリの URL (例: https://github.com/cynthn/nodejs-docs-hello-world) を入力します
[Source code management]\(ソースコードの管理\) セクションで [Git] を選択し、フォークしたリポジトリの .git の URL を入力します (例: https://github.com/cynthn/nodejs-docs-hello-world.git)
[Build Triggers] セクションから GitHub hook trigger for GITscm polling を選択します｡
[ビルド] セクションで [ビルドステップの追加] をクリックします｡ [Execute shell] を選択し、コマンドウィンドウに echo "Test" を入力します。
ジョブウィンドウの下部にある [保存] を選択します。

GitHub 統合をテストする

Jenkins との GitHub の統合をテストするには､フォークの変更をコミットします｡

GitHub の Web UI に戻り、フォークしたレポジトリを選択して、index.js ファイルを選択します。鉛筆アイコンを選択して、このファイルを編集し、6 行目を次のように変更します。

response.end("Hello World!");

変更をコミットするには、下部にある [変更をコミット] ボタンを選択します。

Jenkins ジョブページ左下隅の [Build history] セクションで新しいビルドが開始されます｡ビルド番号のリンクを選択し、左側の [Console output] を選択します。 GitHub からコードが取り込まれ､ビルドアクションによってコンソールにメッセージ Test が出力されるなどの Jenkins が行った処理を確認できます｡このように GitHub でコミットが行われるたびに、webhook は Jenkins にアクセスし、新しいビルドをトリガーします。

Docker ビルドイメージを定義する

GitHub のコミットに基づいて Node.js アプリが実行されていることを確認するには､アプリを実行するための Docker イメージをビルドします｡イメージは､アプリを実行するコンテナーの構成方法を定義した Dockerfile からビルドされます｡

VM への SSH 接続から､前の手順で作成したジョブにちなんだ名前の Jenkins ワークスペーディレクトリに切り替えます｡この例では、名前は HelloWorld でした。

cd /var/lib/jenkins/workspace/HelloWorld

このワークスペースディレクトリに sudo sensible-editor Dockerfile という名前のファイルを作成し、次の内容を貼り付けます。 Dockerfile 全体 (特に最初の行) が正しくコピーされたことを確認してください。

FROM node:alpine

EXPOSE 1337

WORKDIR /var/www
COPY package.json /var/www/
RUN npm install
COPY index.js /var/www/

この Dockerfile は Alpine Linux を使用する Node.js ベースイメージを利用して､Hello World アプリが実行されるポート 1337 を開きます｡そして､アプリのファイルをコピーし､アプリを初期化します｡

Jenkins ビルドルールを作成する

前の手順では、コンソールにメッセージを出力する基本的な Jenkins ビルドルールを作成しました｡ Docker ファイルを利用するビルドステップを作成し､アプリを実行してみましょう｡

Jenkins インスタンスに戻り､前の手順で作成したジョブを選択します｡左側の [Configure] を選択し、下方向にスクロールして [Build] セクションを表示します。

既存の echo "Test" ビルドステップを削除します｡既存のビルドステップボックスの右上隅にある赤い十字を選択します。
[Add build step] を選択して、[Execute shell] を選択します。

[コマンド] ボックスに次の Docker コマンドを入力して、[保存] を選択します。

docker build --tag helloworld:$BUILD_NUMBER .
docker stop helloworld && docker rm helloworld
docker run --name helloworld -p 1337:1337 helloworld:$BUILD_NUMBER node /var/www/index.js &

Docker ビルドステップはイメージを作成し､イメージの履歴を残せるよう､そのイメージに Jenkins ビルド番号のタグを付けます｡アプリを実行する既存のコンテナーは停止､削除されます｡イメージを使用して新しいコンテナーが開始され､GitHub での最新のコミットに基づいて Node.js アプリが実行されます｡

パイプラインをテストする

動作中のパイプライン全体を表示するには、フォークした GitHub レポジトリ内の index.js ファイルを再び編集し、[Commit change] を選択します。 GitHub の webhook に基づき Jenkins で新しいジョブが開始されます｡ Docker イメージを作成して､新しいコンテナー内でアプリを起動するには､数秒の時間がかかります｡

必要に応じて､再度､VM のパブリック IP アドレスを入手します｡

az vm show --resource-group myResourceGroupJenkins --name myVM -d --query [publicIps] --o tsv

Web ブラウザを開いて､http://<publicIps>:1337 を入力します｡ Node.js アプリが表示され､次のようにGitHub フォークに最新のコミットが反映されています｡

Running Node.js app

GitHub 内の index.js ファイルをもう一度編集し､変更をコミットします｡ Jenkins でジョブが完了するのを数秒待って､Web ブラウザを再表示し､新しいコンテナー内で動作するアプリの更新後のバージョンを確認します｡

Running Node.js app after another GitHub commit

次のステップ

このチュートリアルでは、コードのコミットのたびに Jenkins ビルドジョブを実行し、 Docker コンテナーをデプロイしてアプリを実行するように GitHub を構成しました。以下の方法を学習しました。

Jenkins VM を作成する
Jenkins をインストール､構成する
GitHub と Jenkins 間に webhook 統合を作成する
GitHub コミットから Jenkins ビルドジョブを作成､トリガーする
アプリ用の Docker イメージを作成する
GitHub によって build new Docker image がコミットされ､動作中のアプリが更新されることを確認する

次のチュートリアルに進み、Jenkins と Azure DevOps Services を統合する方法を学習してください。

Jenkins と Azure DevOps Services を使用してアプリをデプロイする

次の方法で共有

チュートリアル: GitHub と Docker を使用して Jenkins パイプラインを作成する

Jenkins インスタンスを作成する

Jenkins を構成する

GitHub webhook を作成する

Jenkins ジョブを作成する

GitHub 統合をテストする

Docker ビルドイメージを定義する

Jenkins ビルドルールを作成する

パイプラインをテストする

次のステップ

フィードバック

その他のリソース

次の方法で共有

チュートリアル: GitHub と Docker を使用して Jenkins パイプラインを作成する

Jenkins インスタンスを作成する

Jenkins を構成する

GitHub webhook を作成する

Jenkins ジョブを作成する

GitHub 統合をテストする

Docker ビルド イメージを定義する

Jenkins ビルド ルールを作成する

パイプラインをテストする

次のステップ

フィードバック

その他のリソース

Docker ビルドイメージを定義する

Jenkins ビルドルールを作成する