メインコンテンツへスキップ

接続と切断(Terraform PR agent)

このページでは、コンソールから GitHub リポジトリに Terraform PR agent を接続する方法について説明します。設定が完了すると、Terraform PR agent は GitHub 内の Terraform コードを読み取り、早期アクセス期間中に DoiT 提供の CloudFlow を通じて Insight が処理された際に、是正用の pull request を作成できるようになります。

必要な権限​

  • Billing Profiles Admin 権限

  • Terraform リポジトリをホストしている組織に対する GitHub アクセス権。次のいずれかが必要です。

    • GitHub 組織の管理者: セットアップ中に IaC Remediation Agent GitHub App をインストールできます。

    • GitHub 組織の管理者ではない場合: インストールをリクエストできます。接続が確立される前に、GitHub 組織のオーナーがリクエストを承認する必要があります。

GitHub リポジトリを接続する​

Terraform PR agent をセットアップします。

  1. DoiT コンソール にサインインし、上部ナビゲーションのメガメニューから データ取り込みとインテグレーション > インテグレーション を選択します。

  2. Agents カテゴリタブを選択します。

  3. Terraform PR agent インテグレーションカードで Connect + を選択し、セットアップページを開きます。

  4. Connect Github repositories の下で Open GitHub marketplace を選択します。

    Terraform PR agent setup page

  5. GitHub Marketplace のプロンプトに従って、所属組織に IaC Remediation Agent をインストールするか、組織の管理者でない場合はインストールをリクエストし、接続するリポジトリを選択してください。Terraform の root module を保持しているリポジトリを含めてください。これらの module が他のリポジトリ内のプライベート module を参照している場合は、それらのリポジトリも選択してください。アクセス権がないと、エージェントは是正案を生成する際に module 定義を解決できない場合があります。

    このアプリは、是正案を作成し、レビュー担当者からのフィードバックに応答できるように、pull request の作成、ブランチの push、および pull request コメントの読み取り権限を必要とします。

    Select repositories and set permissions

    自身が GitHub 組織の管理者かどうかによって、挙動が異なります。

    • GitHub 組織の管理者: インストールが完了すると、セットアップページに接続済みの組織と選択したリポジトリを含む成功メッセージが表示されます。

      Success confirmation

    • GitHub 組織の管理者ではない場合: アプリが直接インストールされる代わりに、GitHub から組織オーナー宛てにインストールリクエストが送信されます。DoiT コンソールのセットアップページには、次のいずれかの状態が表示されます。

      • Waiting for approval: セットアップページに、GitHub 組織のオーナーによるリクエスト承認待ちであることが表示されます。このページは 10 秒ごとに自動で承認状況を確認するため、手動で更新する必要はありません。オーナーが承認すると、ページが更新され、成功メッセージが表示されます。

      • Request expired: 組織オーナーがリクエストの有効期限までに承認しなかった場合、セットアップページにリクエストの有効期限切れが通知されます。Restart setup を選択して、新しいインストールリクエストを送信してください。

      GitHub でリクエストを承認した組織オーナーには、承認が完了し、DoiT が自動的に接続を完了することを示す確認ページが表示されます。

GitHub リポジトリを切断する​

Terraform PR agent の GitHub アクセスを切断するには、GitHub の組織設定に移動し、IaC Remediation Agent をアンインストールしてください。これにより、エージェントはリポジトリへアクセスしたり、新しい是正用 pull request を作成したりできなくなります。

アプリをアンインストールすると、インテグレーションカタログ内の Terraform PR agent カードは Not connected の状態に戻り、セットアップページには再度 Connect + が表示され、後で再接続できるようになります。