ツールチェーンの作成

コンソールを使用したテンプレートからのツールチェーンの作成

テンプレートを開始点として使用して、特定のツール統合のセットを含む ツールチェーンを作成 できます。 使用するテンプレートに応じて、特定のツールの統合があるツールチェーンを作成するか、空のツールチェーンを作成してそこにツール統合を追加することができます。 テンプレートの使用方法について詳しくは、 IBM Cloud Garage Methodを参照してください。

1. IBM Cloud にログインします。

2. IBM Cloud コンソールで、メニュー・アイコン をクリックし、**「DevOps」**を選択します。

3. **「ツールチェーン」ページで、「ツールチェーンの作成」**をクリックします。

4. **「ツールチェーンの作成」**ページで、ツールチェーン・テンプレートをクリックします。

5. 作成しようとしているツールチェーンの図を確認します。 この図は、ツールチェーン内の各ツール統合とそのライフサイクル・フェーズを示しています。

   一部のツールチェーン・テンプレートには、同じツール統合の複数のインスタンスが含まれています。 例えば、 IBM Cloud Public の「Develop and test microservices with Kubernetes and Helm」ツールチェーン・テンプレートには、 GitHub の 4 つのインスタンスと Delivery Pipelineの 4 つのインスタンスが含まれています。

   次のイメージの図はその例です。 ツールチェーンを作成すると、ツールチェーンを構成する各ツール統合がこの図に表示されます。

   

6. ツールチェーン設定のデフォルト情報を確認します。

   • ツールチェーンの名前は、そのツールチェーンを IBM Cloud 内で識別するためのものです。 別の名前を使用する場合は、ツールチェーンの名前を変更します。
   • ツールチェーンを作成する対象のリージョン。 別のリージョンを利用する場合は、選択可能なリージョンのリストから選んでください。
   • ツールチェーンを作成するリソース・グループ。 別のリソース・グループを使用したい場合は、使用可能なリソース・グループのリストからそのリソース・グループを選択します。
   • GitHub、GitLab、Bitbucket などのソース・リポジトリーのプロバイダー。 別のソース・プロバイダーを利用する場合は、使用可能なリポジトリーのリストから選んでください。

7. 「ツール統合 (Tool Integrations)」セクションで、ツールチェーンに構成する各ツール統合を選択します。 いくつかのツール統合は、構成を必要としません。 ツール統合の構成について詳しくは、ツール統合の構成を参照してください。

   ツールチェーンを構成するツール統合の多くは、Continuous Delivery サービスによる認証のためにシークレットを必要とします。

   シークレットは、パスワード、認証トークン、API キー、または証明書の形式で提供可能な資格情報です。 例えば、Delivery Pipeline ツール統合をツールチェーンに追加するときは、シークレットを API キーの形式で提供する必要があります。

   a. 「ツール統合」セクションで**「Delivery Pipeline」**をクリックします。

   b. **「新規」**をクリックして IBM Cloud® API キーを作成します。

   c. **「OK」**をクリックして、新しい API キーを適用します。

   各ユーザーは、最大 20 の API キーを持つことができます。

   (d) **「OK」**をクリックして、API キーを、そのキーのセキュア・コピーを保存しないで作成します。

   e. API キーを安全に保存して、他のツールチェーン・ワークフローで再度使用できるようにするには、以下のようにします。

   • Key Protect または Secrets Manager シークレット・ストアと統合するには、 「このキーをシークレット・ストアに再利用のために保存する」 チェック・ボックスを選択します。
   • Key Protect または Secrets Managerの既存のインスタンスがない場合は、インスタンスの名前と秘密鍵を指定します。
   • **「OK」**をクリックして、新しい API キーを適用します。

   f. Key Protect または Secrets Manager インスタンスが正常に作成されたことを確認するには、 IBM Cloud® リソース・リスト に移動し、 サービス ツイスティーを展開します。 API キーを表示するには、メニュー・バーから **「管理」>「アクセス (IAM)」**をクリックし、 **IBM Cloud® 「API キー」**を選択します。

   g. 作成して Key Project にコピーした API キーは、「ツールチェーンの作成」ページで使用できるようになりました。 シークレットが必要なツール統合には、鍵アイコンが表示されます。 1 つ以上の Key Protect または Secrets Manager インスタンスからシークレットを取得するには、キー・アイコンをクリックして「シークレット・ピッカー」ダイアログ・ボックスを開きます。

8. 「作成」 をクリックします。 以下のようにいくつかのステップが自動的に実行されて、ツールチェーンがセットアップされます。 セットアップされるツール統合は、選択したツールチェーン・テンプレートによって異なります。 例えば、 IBM Cloud Public で「Develop and test microservices with Kubernetes and Helm」ツールチェーンを作成すると、以下のステップが実行されます。

   • ツールチェーンが作成されます。
   • Delivery Pipeline を構成した場合は、パイプラインが作成されて起動します。
   • Event Notificationsを構成した場合、指定した Event Notifications サービスにイベント通知を送信するようにツールチェーンがセットアップされます。
   • Sauce Labs を構成した場合は、パイプラインに Sauce Labs テスト・ジョブを追加するようにツールチェーンがセットアップされます。
   • PagerDuty を構成した場合は、指定した PagerDuty サービスにアラート通知を送信するようにツールチェーンがセットアップされます。
   • Slack を構成した場合は、指定した Slack チャネルにデプロイメント状況に関する通知を送信するようにツールチェーンがセットアップされます。
   • GitHub などのソース・コード・ツール統合を構成した場合、サンプル GitHub リポジトリーが GitHub アカウントに複製されます。

   Event Notifications ツール統合を使用してイベント通知を配布できるようになりました。 IBM Cloud Event Notifications は、 PagerDuty およびその他の通信チャネル (Slack、E メール、SMS、プッシュ通知、Webhook、Microsoft ® Teams、 ServiceNow、 IBM Cloud Functionsなど) に通知を配布するための推奨される方法です。 Event Notificationsの使用について詳しくは、 ツールチェーンのイベント通知の有効化を参照してください。

コンソールを使用したアプリからのツールチェーンの作成

アプリからツールチェーンを作成することができます。 ツールチェーンは、継続的な開発、デプロイメント、モニターなどをサポートすることができ、アプリと関連付けられます。 各アプリをツールチェーンと関連付けることができます。 ツールチェーンの GitHub リポジトリーに変更をプッシュすると、パイプラインは自動的にアプリをビルドしてデプロイします。

1. IBM Cloud Public を使用してアプリを作成した場合、そのアプリは、アプリのスターター・コードが取り込まれた新しい GitHub リポジトリーから継続的デリバリー用に構成されます。

2. ツールチェーン構成ページで、作成しようとしているツールチェーンの図を確認します。 この図は、ツールチェーン内の各ツール統合とそのライフサイクル・フェーズを示しています。

3. ツールチェーン設定のデフォルト情報を確認します。 ツールチェーンの名前は、そのツールチェーンを IBM Cloud 内で識別するためのものです。 別の名前を使用する場合は、ツールチェーンの名前を変更します。

4. 「ツール統合 (Tool Integrations)」セクションで、ツールチェーンに構成する各ツール統合を選択します。 いくつかのツール統合は、構成を必要としません。 ツール統合の構成について詳しくは、ツール統合の構成を参照してください。

5. 「作成」 をクリックします。 以下のようにいくつかのステップが自動的に実行されて、ツールチェーンがセットアップされます。 例えば、IBM Cloud Public でアプリからツールチェーンを作成する場合、以下のステップが実行されます。

   • ツールチェーンが作成されます。
   • Delivery Pipeline を構成した場合は、パイプラインが作成されて起動します。
   • GitHub を構成した場合は、GitHub アカウントにサンプル GitHub リポジトリーが複製されます。

API を使用したツールチェーンの作成

1. IAM ベアラー・トークンを取得します。 あるいは、SDK を使用している場合は、 IAM API キーを取得 し、環境変数を使用してクライアント・オプションを設定します。

   export CD_TOOLCHAIN_AUTH_TYPE=iam && \
   export CD_TOOLCHAIN_APIKEY={iam_api_key} && \
   export CD_TOOLCHAIN_URL={base_url}
   

2. ツールチェーンを作成したい リソース・グループの ID を検索 します。

3. ツールチェーンを作成する場所となるリージョンを選択します。

4. ツールチェーンのインスタンスを作成します。

   curl -X POST \
     "{base_url}/toolchains" \
     -H 'Authorization: Bearer {token}' \
     -H 'Content-Type: application/json' \
       -d '{
       "name": "{toolchain_name}",
       "resource_group_id": "{resource_group_id}"
     }'
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   const toolchainService = CdToolchainV2.newInstance();
   ...
   (async() => {
      const toolchainPrototypeModel = {
         description: {toolchain_description},
         name: {toolchain_name},
         resourceGroupId: {resource_group_id}
      };
      const response = await toolchainService.createToolchain(toolchainPrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createToolchainOptions := toolchainClient.NewCreateToolchainOptions({toolchain_name}, {resource_group_id})
   createToolchainOptions.SetDescription({toolchain_description})
   toolchain, response, err := toolchainClient.CreateToolchain(createToolchainOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   toolchain = toolchain_service.create_toolchain(
      description = {toolchain_description},
      name = {toolchain_name},
      resource_group_id = {resource_group_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   CreateToolchainOptions createToolchainOptions = new CreateToolchainOptions.Builder()
      .description({toolchain_description})
      .name({toolchain_name})
      .resourceGroupId({resource_group_id})
      .build();
   Response<ToolchainPost> response = toolchainService.createToolchain(createToolchainOptions).execute();
   ToolchainPost toolchain = response.getResult();
   

以下の表では、前のステップで使用された各変数をリストして説明します。

API を使用したツールチェーンの作成について詳しくは、 IBM Cloud API 資料の ツールチェーンの作成 を参照してください。

Terraform を使用したツールチェーンの作成

1. Terraform CLI をインストールし、Terraform 用の IBM Cloud Provider プラグインを構成するために、Terraform on IBM Cloud® 入門のチュートリアルに従ってください。

2. main.tfという名前の Terraform 構成ファイルを作成します。 このファイルで、 HashiCorp 構成言語を使用してツールチェーンを作成するための構成を追加します。 この構成言語の使用について詳しくは、 Terraform の資料を参照してください。

   以下の例では、 ibm_cd_toolchain リソースを使用してツールチェーンを作成します。

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "cd_toolchain" {
     name              = "my toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   

   ibm_cd_toolchainについて詳しくは、 Terraform レジストリー Documentationの引数参照の詳細を参照してください。

3. Terraform CLI を初期設定します。

   terraform init
   

4. Terraform 実行プランを作成します。 このプランは、ツールチェーンを作成するために実行する必要があるすべてのアクションを要約します。

   terraform plan
   

5. Terraform 実行プランを適用します。 Terraform は、ツールチェーンを作成するために必要なすべてのアクションを実行します。

   terraform apply