Jenkins で EDAS プラグインを使用してアプリケーションデプロイのジョブをビルドする - Enterprise Distributed Application Service

edas-jenkins-plugin プラグインは Jenkins に組み込まれています。このプラグインを使用すると、Jenkins を使用して Enterprise Distributed Application Service (EDAS) にアプリケーションを継続的にデプロイできます。Jenkins コンソールは、アプリケーションをデプロイするためのグラフィカルユーザーインターフェース (GUI) を提供します。このトピックでは、Jenkins コンソールでアプリケーションをデプロイする方法を示します。アプリケーションをデプロイするためのパイプラインスクリプトを作成したり、Job-dsl を使用してテンプレートを作成し、そのテンプレートを使用してデプロイジョブを生成したりできます。

前提条件

Job-dsl プラグインがインストールされていること。

edas-jenkins-plugin をインストールする

edas-jenkins-plugin のインストールパッケージをダウンロードします。
Jenkins にログインします。Jenkins のホームページで、[jenkinsの管理] をクリックします。[jenkinsの管理] ページで、[プラグインの管理] をクリックします。
[プラグインマネージャー] ページで、[詳細設定] タブを選択します。[プラグインのアップロード] セクションで、[ファイルを選択] をクリックし、ダウンロードしたプラグインを選択して、[アップロード] をクリックします。
[プラグイン/アップグレードのインストール] ページで、プラグインがインストールされるまで待ちます。

アカウント情報を設定する

Jenkins にログインします。Jenkins のホームページで、[jenkinsの管理] をクリックします。[jenkinsの管理] ページで、[システムの設定] をクリックします。

[EDAS にデプロイ] セクションで、アカウント情報を設定し、[追加] をクリックします。次に、[詳細設定] をクリックして、リージョン情報を入力します。

パラメーター	説明
EDAS 認証情報名	AccessKey ペアの名前を指定します。
EDAS Access Key ID	Alibaba Cloud アカウントの AccessKey ID を入力します。AccessKey ペアの作成方法については、「AccessKey ペアを取得する」をご参照ください。
EDAS Access Key Secret	Alibaba Cloud アカウントの AccessKey シークレットを入力します。AccessKey ペアの作成方法については、「AccessKey ペアを取得する」をご参照ください。
EDAS リージョン	アプリケーションをデプロイするリージョン ID (例: cn-hangzhou) を選択します。
エンドポイント	このパラメーターは Apsara Stack に適用されます。Apsara Stack で Jenkins を使用する前に、値を EDAS エンドポイントに設定します。エンドポイントを取得するには、EDAS テクニカルサポートにお問い合わせください。説明 Alibaba Cloud で Jenkins を使用する場合は、このパラメーターは不要です。

上記のパラメーターを設定した後、EDAS に Ping を実行[EDAS にデプロイ] セクションの成功をクリックします。と表示されたら、アカウント情報が設定されています。
説明 [追加] をクリックして、EDAS が有効になっている複数のアカウントを設定できます。

Jenkins でフリースタイルプロジェクトを作成してアプリケーションをデプロイする

Jenkins にログインします。Jenkins のホームページで、[新規アイテム] をクリックします。
[アイテム名を入力] フィールドに、プロジェクト名を入力します。次に、[フリースタイルプロジェクト] を選択し、[OK] をクリックします。
[ビルド後の処理] セクションで、[ビルド後の処理を追加] をクリックします。次に、ドロップダウンリストから [EDAS にデプロイ] を選択します。

[EDAS にデプロイ] セクションで、[追加] をクリックし、ドロップダウンリストからクラスターを選択してアプリケーションをデプロイします。

パラメーター	説明
EDAS ECS アプリケーション	Jenkins を使用して、Elastic Compute Service (ECS) クラスターにデプロイされているアプリケーションをアップグレードします。設定パラメーターの詳細については、「ECS クラスターにアプリケーションをデプロイする」をご参照ください。
EDAS ECS アプリケーションを作成する	Jenkins を使用して、ECS クラスターにアプリケーションを作成およびデプロイします。設定パラメーターの詳細については、「ECS クラスターにアプリケーションを作成およびデプロイする」をご参照ください。
EDAS K8s アプリケーション	Jenkins を使用して、Container Service Kubernetes クラスターにデプロイされているアプリケーションをアップグレードします。設定パラメーターの詳細については、「ACK クラスターにアプリケーションをデプロイする」をご参照ください。
EDAS K8s アプリケーションを作成する	Jenkins を使用して、Container Service Kubernetes クラスターにアプリケーションを作成およびデプロイします。設定パラメーターの詳細については、「ACK クラスターにアプリケーションを作成およびデプロイする」をご参照ください。

設定が完了したら、ページの左下隅にある [保存] または [適用] をクリックします。
プロジェクト詳細ページの左側のナビゲーションペインで、[ビルド実行] をクリックしてプロジェクトをビルドします。
[ビルド履歴] セクションに、プロジェクトのビルドレコードが表示されます。表示するビルドレコードをクリックできます。次に、ビルドレコードの詳細ページが表示されます。

edas-jenkins-plugin を使用して EDAS にアプリケーションをデプロイする

edas-jenkins-plugin プラグインは、Jenkins Pipeline の組み込みスニペットジェネレーターをサポートしています。これにより、Jenkins でパイプラインをビルドし、EDAS にアプリケーションをデプロイできます。

Jenkins にログインします。Jenkins のホームページで、[新規アイテム] をクリックします。
[アイテム名を入力] フィールドに、プロジェクト名を入力します。次に、[パイプライン] を選択し、[OK] をクリックします。
[パイプライン] セクションで、[パイプライン構文] をクリックします。
説明パイプラインを作成済みの場合は、プロジェクトリストでパイプライン名をクリックして、パイプライン管理ページに移動できます。左側のナビゲーションペインで、[パイプライン構文] をクリックします。[スニペットジェネレーター] ページが表示されます。
[スニペットジェネレーター] ページで、Edasclient: EDAS にデプロイ[サンプルステップ] ドロップダウンリストから追加アプリケーションの設定 を選択します。次に、の横にあるをクリックし、クラスタータイプとアプリケーションタイプに基づいて、ドロップダウンリストからデプロイモードを選択します。
デプロイパラメーターを設定します。設定の詳細については、「Jenkins で edas-jenkins-plugin を使用してアプリケーションをデプロイするシナリオでパラメーターを設定する」をご参照ください。
パラメーターを設定した後、[パイプラインスクリプトの生成] をクリックします。次に、生成されたパイプラインスクリプトを複製します。
左側のナビゲーションペインで、[戻る] をクリックしてパイプライン管理ページに戻ります。左側のナビゲーションペインで、[設定] をクリックします。次に、次の図に示すように、[パイプライン] セクションにスクリプトを入力します。
説明次の図では、オレンジ色のボックスの内容を前の手順で生成されたスクリプトに置き換えます。
設定が完了したら、ページの左下隅にある [保存] または [適用] をクリックします。
プロジェクト詳細ページの左側のナビゲーションペインで、[ビルド実行] をクリックしてプロジェクトをビルドします。
[ビルド履歴] セクションに、プロジェクトのビルドレコードが表示されます。表示するビルドレコードをクリックできます。次に、ビルドレコードの詳細ページが表示されます。

Job-dsl を使用してデプロイジョブをビルドする

Jenkins では、Job-dsl を使用してジョブテンプレートをビルドできます。この方法では、テンプレートを使用してデプロイジョブをビルドできます。

Jenkins にログインします。Jenkins のホームページで、[新規アイテム] をクリックします。
[アイテム名を入力] フィールドに、プロジェクト名を入力します。次に、[フリースタイルプロジェクト] を選択し、[OK] をクリックします。
[ビルド] セクションで、[ビルド手順の追加] をクリックし、ドロップダウンリストから [job DSL の処理] を選択します。
説明パイプラインを作成済みの場合は、プロジェクトリストでパイプライン名をクリックして、パイプライン管理ページに移動できます。左側のナビゲーションペインで、[パイプライン構文] をクリックします。[スニペットジェネレーター] ページが表示されます。

[job DSL の処理] セクションで、[指定された DSL スクリプトを使用する] をクリックします。[DSL スクリプト] フィールドに、設定スクリプトを入力します。

job('edas') {    // ビルドするジョブの名前。
  publishers { // EDAS プラグインのタイプ。
    edasClient { // EDAS プラグインを呼び出すクライアントの名前。
      deployApplication('', '', '', '', '') // EDAS にデプロイされるアプリケーションを呼び出すために使用されるメソッド。
    }
  }
}

次のデプロイメソッドがサポートされています:

// ECS クラスターにアプリケーションをデプロイします。
void deployApplication(
        String namespace,
        String credentialsString,
        String group,
        String appId,
        String targetObject);

void deployApplication(
        String namespace,
        String credentialsString,
        String group,
        String appId,
        String targetObject,
        String versionLabelFormat,
        String versionDescriptionFormat,
        String batch,
        String batchWaitTime,
        String releaseType);

// ECS クラスターにアプリケーションを作成およびデプロイします。
void insertApplication(
        String namespace,
        String credentialsString,
        String applicationName,
        String packageType,
        String clusterId,
        String targetObject,
        String ecuInfo);

void insertApplication(
        String namespace,
        String credentialsString,
        String applicationName,
        String packageType,
        String clusterId,
        String targetObject,
        String ecuInfo,
        String versionLabelFormat,
        String versionDescriptionFormat,
        String buildPackId,
        String healthCheckUrl);

// Container Service Kubernetes クラスターにアプリケーションをデプロイします。
void deployK8sApplication(
        String namespace,
        String credentialsString,
        String appId,
        String targetObject,
        Boolean image);

void deployK8sApplication(
        String namespace,
        String credentialsString,
        String appId,
        String targetObject,
        Boolean image,
        String edasContainerVersion,
        String webContainer,
        String jdk,
        String versionLabelFormat,
        String envs,
        String startupCommand,
        String args,
        String cpuLimit,
        String memoryLimit,
        String cpuRequest,
        String memoryRequest,
        String replicas,
        String postStart,
        String preStop,
        String readiness,
        String liveness,
        String updateStrategy);

// Container Service Kubernetes クラスターにアプリケーションを作成およびデプロイします。
void insertK8sApplication(
        String namespace,
        String credentialsString,
        String applicationName,
        String packageType,
        String clusterId,
        String targetObject,
        String k8sNamespace,
        String jdk);

 void insertK8sApplication(
        String namespace,
        String credentialsString,
        String applicationName,
        String packageType,
        String clusterId,
        String targetObject,
        String k8sNamespace,
        String jdk,
        String descFormat,
        String edasContainerVersion,
        String webContainer,
        String versionLabelFormat,
        String envs,
        String startupCommand,
        String args,
        String cpuLimit,
        String memoryLimit,
        String cpuRequest,
        String memoryRequest,
        String replicas,
        String postStart,
        String preStop,
        String readiness,
        String liveness);

設定が完了したら、ページの左下隅にある [保存] または [適用] をクリックします。
プロジェクト詳細ページの左側のナビゲーションペインで、[ビルド実行] をクリックしてプロジェクトをビルドします。
[ビルド履歴] セクションに、プロジェクトのビルドレコードが表示されます。表示するビルドレコードをクリックできます。次に、ビルドレコードの詳細ページが表示されます。

詳細情報

Jenkins で edas-jenkins-plugin を使用してアプリケーションをデプロイするシナリオでパラメーターを設定する