チュートリアル: CodeBuild がホストする Buildkite ランナーを設定

Buildkite エージェントトークンを生成するには

1. Buildkite クラスターで、[エージェントトークン] を選択し、[新しいトークン] を選択します。

2. トークンに説明を追加し、[トークンを作成] をクリックします。

3. エージェントトークン値は、後で CodeBuild プロジェクトのセットアップ中に使用するため、保存しておきます。

   

ウェブフックを使用して CodeBuild プロジェクトを作成するには

1. AWS CodeBuild コンソール (https://console.aws.amazon.com/codesuite/codebuild/home) を開きます。

2. セルフホスト型ビルドプロジェクトを作成します。詳細については、「ビルドプロジェクトの作成 (コンソール)」および「ビルドの実行 (コンソール)」を参照してください。

   • [プロジェクトの設定] で、[ランナープロジェクト] を選択します。[ランナー] で、次のようにします。

     • [ランナープロバイダー] で、[Buildkite] を選択します。

     • [Buildkite エージェントトークン] で、[シークレットの作成ページを使用して新しいエージェントトークンを作成する] を選択します。上記で生成した Buildkite エージェントトークンと等しいシークレット値を持つ新しいシークレットを AWS Secrets Manager で作成するように求められます。

     • (オプション) ジョブに CodeBuild マネージド認証情報を使用する場合は、[Buildkite ソース認証情報オプション] でジョブのソースリポジトリプロバイダーを選択し、アカウントに認証情報が設定されていることを確認します。さらに、Buildkite パイプラインで HTTPS を使用したチェックアウトが使用されていることを確認します。

     注記

     ジョブのソースをプルするため、Buildkite によりビルド環境内でソース認証情報が求められます。使用可能なソース認証情報オプションについては、「プライベートリポジトリへの Buildkite の認証」を参照してください。

   • (オプション) [環境] で、次のようにします。

     • サポートされている [環境イメージ] と [コンピューティング] を選択します。

       Buildkite YAML ステップのラベルを使用して、イメージとインスタンスの設定を上書きするオプションがあることに注意してください。詳細については、「ステップ 4: Buildkite パイプラインステップを更新する」を参照してください。

   • (オプション) [Buildspec] で、次のようにします。

     • buildspec-override: "true" がラベルとして追加されない限り、buildspec は無視されます。代わりに、CodeBuild は、セルフホスト型ランナーを設定するコマンドを使用するように上書きします。

       注記

       CodeBuild は、Buildkite セルフホスト型ランナービルドの buildspec ファイルをサポートしていません。インライン buildspec の場合、CodeBuild マネージドソース認証情報を設定している場合は、buildspec で git-credential-helper を有効にする必要があります。

3. デフォルト値のまま続行し、[ビルドプロジェクトを作成する] を選択します。

4. [ウェブフックの作成] ポップアップから [ペイロードの URL] と [シークレット] の値を保存します。ポップアップの手順に従って新しい Buildkite 組織のウェブフックを作成するか、次のセクションに進みます。

Buildkite で新しいウェブフックを作成するには

1. Buildkite 組織の [設定] ページに移動します。

2. [統合] で、[通知サービス] を選択します。

3. [ウェブフック] ボックスの横にある [追加] を選択します。[ウェブフック通知の追加] ページで、次の設定を使用します。

   1. [ウェブフックの URL] で、保存された [ペイロードの URL] 値を追加します。

   2. [トークン] で、[X-Buildkite-Token としてトークンを送信] が選択されていることを確認します。ウェブフックの [シークレット] 値を [トークン] フィールドに追加します。

   3. [X-Buildkite-Token としてトークンを送信] が選択されていることを確認します。ウェブフックの [シークレット] 値を [トークン] フィールドに追加します。

   4. [イベント] で、job.scheduled ウェブフックイベントを選択します。

   5. (オプション) [パイプライン] では、オプションで特定のパイプラインのビルドのみをトリガーするように選択できます。

4. [ウェブフック通知の追加] を選択します。

パイプラインステップを更新する

1. Buildkite パイプラインを選択して、[設定] を選択し、[ステップ] を選択して、Buildkite パイプラインステップページに移動します。

   まだの場合は、[YAML ステップに変換] を選択します。

   

2. 少なくとも、CodeBuild パイプラインの名前を参照する Buildkite エージェントタグを指定する必要があります。Buildkite ジョブの AWS 関連の設定を特定の CodeBuild プロジェクトにリンクするには、プロジェクト名が必要です。YAML にプロジェクト名を含めることで、CodeBuild は正しいプロジェクト設定でジョブを呼び出すことができます。

   agents:
     project: "codebuild-<project name>"

   以下は、プロジェクトラベルタグのみを含む Buildkite パイプラインステップの例です。

   agents:
     project: "codebuild-myProject"
   steps:
     - command: "echo \"Hello World\""

   ラベル内のイメージとコンピューティングタイプを上書きすることもできます。使用可能なイメージのリストについては、「CodeBuild がホストする Buildkite ランナーでサポートされているコンピューティングイメージ」を参照してください。ラベル内のコンピューティングタイプとイメージは、プロジェクトの環境設定を上書きします。CodeBuild EC2 または Lambda コンピューティングビルドの環境設定を上書きするには、次の構文を使用します。

   agents:
     project: "codebuild-<project name>"
     image: "<environment-type>-<image-identifier>"
     instance-size: "<instance-size>"

   イメージサイズとインスタンスサイズの上書きを含む Buildkite パイプラインステップの例を次に示します。

   agents:
     project: "codebuild-myProject"
     image: "arm-3.0"
     instance-size: "small"
   steps:
     - command: "echo \"Hello World\""

   ラベル内のビルドに使用するフリートを上書きできます。これにより、プロジェクトで設定されたフリート設定が上書きされ、指定されたフリートが使用されます。詳細については、「リザーブドキャパシティフリートでビルドを実行」を参照してください。

   Amazon EC2 コンピューティングビルドのフリート設定を上書きするには、次の構文を使用します。

   agents:
     project: "codebuild-<project name>"
     fleet: "<fleet-name>"
   

   ビルドに使用されるフリートとイメージの両方を上書きするには、次の構文を使用します。

   agents:
     project: "codebuild-<project name>"
     fleet: "<fleet-name>"
     image: "<environment-type>-<image-identifier>"

   フリートとイメージの上書きを含む Buildkite パイプラインステップの例を次に示します。

   agents:
     project: "codebuild-myProject"
     fleet: "myFleet"
     image: "arm-3.0"
   steps:
     - command: "echo \"Hello World\""

3. セルフホスト型 Buildkite ランナーのビルド中にインライン buildspec コマンドを実行することを選択できます (詳細については、「INSTALL、PRE_BUILD、POST_BUILD フェーズで buildspec コマンドを実行」を参照してください)。Buildkite セルフホスト型ランナーのビルド中に CodeBuild ビルドが buildspec コマンドを実行するように指定するには、次の構文を使用します。

   agents:
     project: "codebuild-<project name>"
     buildspec-override: "true"

   buildspec の上書きを使用する Buildkite パイプラインの例を次に示します。

   agents:
     project: "codebuild-myProject"
     buildspec-override: "true"
   steps:
     - command: "echo \"Hello World\""

4. 必要に応じて、CodeBuild がサポートするラベル以外のラベルを提供できます。これらのラベルは、ビルドの属性を上書きする目的で無視されますが、ウェブフックリクエストは失敗しません。例えば、myLabel: “testLabel" をラベルとして追加しても、ビルドの実行は妨げられません。

CodeBuild で認証するには

CodeBuild は、サポートされているソースタイプのマネージド認証情報処理を行います。CodeBuild ソース認証情報を使用してジョブのソースリポジトリをプルするには、次の手順を使用します。

1. CodeBuild コンソールで、[プロジェクトの編集] に移動するか、「ステップ 2: ウェブフックを使用して CodeBuild プロジェクトを作成」のステップを使用して新しい CodeBuild プロジェクトを作成します。

2. [Buildkite ソース認証情報オプション] で、ジョブのソースリポジトリプロバイダーを選択します。

   1. アカウントレベルの CodeBuild 認証情報を使用する場合は、それらが正しく設定されていることを確認します。さらに、プロジェクトにインライン buildspec が設定されている場合は、git-credential-helper が有効になっていることを確認します。

   2. プロジェクトレベルの CodeBuild 認証情報を使用する場合は、[このプロジェクトの上書き認証情報のみを使用する] を選択し、プロジェクトの認証情報を設定します。

3. Buildkite パイプライン設定で、[リポジトリの設定] に移動します。ソースリポジトリのチェックアウト設定を [HTTPS を使用してチェックアウト] に設定する

   

Buildkite シークレットで認証するには

Buildkite には、ssh キーを使用して外部ソースリポジトリに対してセルフホスト型ランナーを認証するために使用できる ssh-checkout プラグインが維持されます。キー値は Buildkite シークレットとして保存され、プライベートリポジトリをプルしようとすると Buildkite セルフホスト型ランナーエージェントによって自動的に取得されます。Buildkite パイプラインの ssh-checkout プラグインを設定するには、次のステップを使用します。

1. E メールアドレスを使用してプライベートおよびパブリック SSH キーを生成します。例: ssh-keygen -t rsa -b 4096 -C "myEmail@address.com"

2. パブリックキーをプライベートソースリポジトリに追加します。例えば、このガイドに従って GitHub アカウントにキーを追加できます。

3. Buildkite クラスターに新しい SSH キーシークレットを追加します。Buildkite クラスター内で、[シークレット] → [新しいシークレット] を選択します。[キー] フィールドにシークレットの名前を追加し、[値] フィールドにプライベート SSH キーを追加します。

   

4. Buildkite パイプライン内で、リポジトリ設定に移動し、SSH を使用するようにチェックアウトを設定します。

   

5. パイプラインの YAML ステップを更新して、git-ssh-checkout プラグインを使用します。たとえば、次のパイプライン YAML ファイルでは、上記の Buildkite シークレットキーを使用してチェックアウトアクションを使用します。

   agents:
     project: "codebuild-myProject"
   steps:
     - command: "npm run build"
       plugins:
         - git-ssh-checkout#v0.4.1:
             ssh-secret-key-name: 'SOURCE_SSH_KEY'

6. CodeBuild 内で Buildkite セルフホスト型ランナージョブを実行すると、プライベートリポジトリをプルするときに、設定されたシークレット値が Buildkite により自動的に使用されるようになりました。