チュートリアル:Service Fabric 上の Java アプリケーションに対して CI/CD を有効にするように Jenkins 環境を構成する

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

このチュートリアルは、シリーズの第 5 部です。 Jenkins を使用してアプリケーションにアップグレードをデプロイする方法を示します。このチュートリアルでは、Service Fabric Jenkins プラグインと、投票アプリケーションをホストする GitHub リポジトリを組み合わせて使用して、アプリケーションをクラスターにデプロイします。

シリーズの第 5 部で学習する内容は次のとおりです。

Service Fabric Jenkins コンテナーをマシンにデプロイする
Service Fabric へのデプロイ用に Jenkins 環境をセットアップする
アプリケーションをアップグレードする

このチュートリアルシリーズで学習する内容は次のとおりです。

前提条件

Git のダウンロードページからローカルコンピューターに Git をインストールしている。 Git の詳細については、Git のドキュメントを参照してください。
Jenkins に関する実践的な知識がある。
GitHub アカウントを作成済みで、GitHub の使い方を理解している。
Docker をコンピューターにインストールしている。

Service Fabric Jenkins コンテナーイメージをプルしてデプロイする

Jenkins は、Service Fabric クラスター内外でセットアップできます。以下の手順では、提供されている Docker イメージを使用して、クラスターの外部でセットアップする方法について説明します。ただし、事前に構成された Jenkins ビルド環境を使用することもできます。次のコンテナーイメージは、Service Fabric プラグインと共にインストールされるため、すぐに Service Fabric で使用できます。

Note

次の例では、パブリックコンテナーイメージを Docker Hub からプルします。匿名の pull request を行うのではなく、最初に Docker Hub アカウント (docker login) で認証を行うことをお勧めします。パブリックコンテンツを使用するときの信頼性を向上させるには、プライベートの Azure Container Registry にイメージをインポートして管理します。パブリックイメージの操作に関する詳細を参照してください。

Service Fabric Jenkins コンテナーイメージを取得しますdocker pull rapatchi/jenkins:v10。このイメージは、プリインストールされた Service Fabric Jenkins プラグインから取得されます。
ローカルマシン上の証明書が格納されている場所で、コンテナーイメージを実行します。
```
docker run -itd -p 8080:8080 -v /service-fabric-java-quickstart/AzureCluster rapatchi/jenkins:v10
```
コンテナーイメージインスタンスの ID を取得します。 docker ps –a コマンドを使用して、すべての Docker コンテナーの一覧を取得できます。
次のコマンドを実行して、Jenkins インスタンスのパスワードを取得します。
```
docker exec [first-four-digits-of-container-ID] cat /var/jenkins_home/secrets/initialAdminPassword
```
コンテナー ID が 2d24a73b5964 の場合、2d24 を使用します。
- このパスワードは、ポータルから Jenkins ダッシュボードにサインインする際に必要になります (http://<HOST-IP>:8080)。
- 初めてサインインした後は、自分のユーザーアカウントを作成することも、管理者アカウントを使用することもできます。
「Generating a new SSH key and adding it to the SSH agent (新しい SSH キーの生成と SSH エージェントへの追加)」で説明されている手順を使用して、Jenkins を利用できるように GitHub をセットアップします。コマンドは Docker コンテナーから実行されるため、Linux 環境向けの手順に従ってください。
- GitHub の手順に従って SSH キーを生成します。次に、リポジトリをホストしている GitHub アカウントに SSH キーを追加します。
- (ホストではなく) Jenkins Docker シェルで、前のリンク先に記載されているコマンドを実行します。
- ホストから Jenkins シェルにサインインするには、次のコマンドを使用します。
```
docker exec -t -i [first-four-digits-of-container-ID] /bin/bash
```
  Jenkins コンテナーイメージがホストされているクラスターまたはマシンに公開 IP があることを確認します。この公開 IP を使用することで、Jenkins インスタンスは GitHub から通知を受け取ることができます。

Jenkins ジョブの作成と構成

GitHub で投票プロジェクトをホストするために使用できるリポジトリがない場合は、最初にリポジトリを作成します。このチュートリアルでは、これ以降、このリポジトリを dev_test と呼びます。
Jenkins ダッシュボード (http://<HOST-IP>:8080) で新しい項目を作成します。
項目の名前を入力します (例: MyJob)。 フリースタイルプロジェクトを選択し、 [OK] をクリックします。
ジョブページに移動し、 [Configure (構成)] をクリックします。

a. 全般セクションで [GitHub project](GitHub プロジェクト) を選択し、GitHub プロジェクトの URL を指定します。この URL では、Jenkins の継続的インテグレーション/継続的デプロイ (CI/CD) フローと統合する Service Fabric Java アプリケーションがホストされます (例: https://github.com/testaccount/dev_test)。

b. [Source Code Management (ソースコードの管理)] セクションで [Git] を選択します。 Jenkins CI/CD フローと統合する Service Fabric Java アプリケーションをホストするリポジトリの URL を指定します (例: https://github.com/testaccount/dev_test.git)。ここで、ビルドするブランチを指定することもできます (例: /master)。
Jenkins と対話できるように (リポジトリをホストする) GitHub を構成します。次の手順に従います。

a. GitHub リポジトリページに移動します。次に、 [Settings (設定)]>[Integrations and Services (統合とサービス)] の順に移動します。

b. [Add Service (サービスの追加)] を選択して「Jenkins」と入力し、 [Jenkins-GitHub plugin (Jenkins-GitHub プラグイン)] を選択します。

c. Jenkins webhook の URL を入力します (既定では、http://<PublicIPorFQDN>:8081/github-webhook/ です)。 [Add service (サービスの追加)] または [Update service (サービスの更新)] をクリックします。

d. テストイベントが Jenkins インスタンスに送信されます。 GitHub で webhook の側に緑色のチェックマークが表示され、プロジェクトがビルドされます。
[Build Triggers (ビルドトリガー)] セクションで、目的のビルドオプションを選択します。この例では、リポジトリにプッシュが行われるたびにビルドがトリガーされるようにします。そのため、 [GitHub hook trigger for GITScm polling (GITScm ポーリングの GitHub フックトリガー)] を選択します
[Build (ビルド)] セクションで、 [Add build step (ビルド手順の追加)] ボックスの一覧の [Invoke Gradle Script (Gradle スクリプトの呼び出し)] オプションを選択します。表示されたウィジェットで詳細メニューを開き、 [Root build script](ルートビルドスクリプト) にアプリケーションのパスを指定します。ウィジェットは、指定されたパスから build.gradle を取得し、適切に動作します。
[Post-Build Actions (ビルド後のアクション)] ボックスの一覧の [Deploy Service Fabric Project (Service Fabric プロジェクトのデプロイ)] を選択します。ここでは、Jenkins でコンパイルされた Service Fabric アプリケーションをデプロイするクラスターの詳細を指定する必要があります。証明書のパスは、ボリュームがマウントされた場所です (/tmp/myCerts)。

アプリケーションのデプロイに使用される追加の詳細を指定することもできます。次のスクリーンショットで、アプリケーションの詳細の例を確認してください。

Note

このクラスターは、Service Fabric を使用して Jenkins コンテナーイメージをデプロイする場合に、Jenkins コンテナーアプリケーションをホストするクラスターと同じにすることもできます。
[保存] をクリックします。

既存のアプリケーションを更新する

VotingApplication/VotingWebPkg/Code/wwwroot/index.html ファイル内の HTML のタイトルを Service Fabric Voting Sample V2 で更新します。

<div ng-app="VotingApp" ng-controller="VotingAppController" ng-init="refresh()">
    <div class="container-fluid">
        <div class="row">
            <div class="col-xs-8 col-xs-offset-2 text-center">
                <h2>Service Fabric Voting Sample V2</h2>
            </div>
        </div>
    </div>
</div>

Voting/VotingApplication/ApplicationManifest.xml ファイル内で、ApplicationTypeVersion と ServiceManifestVersion のバージョンを 2.0.0 に更新します。

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<ApplicationManifest xmlns="http://schemas.microsoft.com/2011/01/fabric" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" ApplicationTypeName="VotingApplicationType" ApplicationTypeVersion="2.0.0">
  <Description>Voting Application</Description>
  <ServiceManifestImport>
    <ServiceManifestRef ServiceManifestName="VotingWebPkg" ServiceManifestVersion="2.0.0"/>
  </ServiceManifestImport>
  <ServiceManifestImport>
        <ServiceManifestRef ServiceManifestName="VotingDataServicePkg" ServiceManifestVersion="1.0.0"/>
    </ServiceManifestImport>
    <DefaultServices>
      <Service Name="VotingWeb">
         <StatelessService InstanceCount="1" ServiceTypeName="VotingWebType">
            <SingletonPartition/>
         </StatelessService>
      </Service>
   <Service Name="VotingDataService">
            <StatefulService MinReplicaSetSize="3" ServiceTypeName="VotingDataServiceType" TargetReplicaSetSize="3">
                <UniformInt64Partition HighKey="9223372036854775807" LowKey="-9223372036854775808" PartitionCount="1"/>
            </StatefulService>
        </Service>
    </DefaultServices>
</ApplicationManifest>

Voting/VotingApplication/VotingWebPkg/ServiceManifest.xml ファイル内で、ServiceManifest の Version フィールドと CodePackage タグの Version フィールドを 2.0.0 に更新します。
```
<CodePackage Name="Code" Version="2.0.0">
<EntryPoint>
    <ExeHost>
    <Program>entryPoint.sh</Program>
    </ExeHost>
</EntryPoint>
</CodePackage>
```
アプリケーションのアップグレードを実行する Jenkins ジョブを初期化するには、新しい変更を GitHub リポジトリにプッシュします。
Service Fabric Explorer で、 [アプリケーション] ドロップダウンをクリックします。アップグレードの状態を確認するには、 [アップグレードの進行中] タブをクリックします。
http://<Host-IP>:8080 にアクセスすると、フル機能を備えた投票アプリケーションが実行中になっています。

次のステップ

このチュートリアルでは、以下の内容を学習しました。

Service Fabric Jenkins コンテナーをマシンにデプロイする
Service Fabric へのデプロイ用に Jenkins 環境をセットアップする
アプリケーションをアップグレードする

その他のJava サンプルを確認する