GitHub アプリコネクション

概要

Datadog GitHub インテグレーションタイルでアクションを認証する代わりに、独自の GitHub アプリをオンボードする場合は、GitHub アプリコネクションを使用します。

このコネクションにより、Datadog はお客様の GitHubアプリのインストールとして認証を行います。GitHub アプリ ID、インストール ID、および秘密鍵を提供すると、Datadog はこれらの資格情報を使用して短期間有効なアクセストークンを自動的に要求します。このアプローチにより、ワークフローやアプリで使用可能なリポジトリと権限を制御できます。

GitHub アプリを作成してインストールする

アクションに必要な権限を持つ GitHub アプリがすでにインストールされている場合は、コネクション資格情報の収集に進んでください。GitHub アプリ作成オプションの詳細については、GitHub の Registering a GitHub App ガイドを参照してください。

  1. GitHub で、組織の [Settings] (設定) > [Developer settings] (開発者設定) > [GitHub Apps] (GitHub アプリ) に移動します。
  2. [New GitHub App] (新しい GitHub アプリ) をクリックします。
  3. アプリ名とホームページ URL を入力します。
  4. [Webhook] で、アプリの Webhook を他の目的で使用しない限り、[Active] (アクティブ) チェックボックスをオフにします。GitHub アプリコネクションに Webhook は必要ありません。
  5. [Permissions] (権限) で、リポジトリのコンテンツ、プルリクエスト、問題など、アクションに必要なリソースのみへのアクセス権を付与します。
  6. [Create GitHub App] (GitHub アプリを作成) をクリックします。
  7. アプリの設定ページで、[Install App] (アプリをインストール) をクリックします。
  8. アプリをインストールする組織を選択し、アプリがすべてのリポジトリにアクセスできるか、選択したリポジトリのみにアクセスできるかを選択します。
  9. [Install] (インストール) をクリックします。

組織の GitHub アプリポリシーによっては、アプリのインストールに組織所有者の承認が必要になる場合があります。

コネクション資格情報を収集する

GitHub から以下の値を収集します。

  • アプリ ID: GitHub アプリの設定ページで、ページ上部に表示されている数値のアプリ ID をコピーします。
  • インストール ID: アプリのインストール設定を開きます。インストール ID は、URL の末尾にある数値です (例: github.com/organizations/<org>/settings/installations/12345678)。
  • 秘密鍵: GitHub アプリの設定ページの [Private keys] (秘密鍵) で [Generate a private key] (秘密鍵を生成する) をクリックします。GitHub が .pem ファイルをダウンロードします。このファイルは安全に保管してください。同じ秘密鍵を GitHub から再度ダウンロードすることはできません。

Datadog でコネクションを作成する

GitHub アプリをセットアップした後、Datadog でコネクションを作成します。

  1. Action Catalog ページ から [Connections] (コネクション) タブをクリックします。
  2. [New Connection] (新しいコネクション) をクリックします。
  3. GitHub コネクションタイプを選択します。
  4. GitHub App 資格情報タイプを選択します。
  5. コネクション名を入力します。
  6. GitHub からコピーしたアプリ ID とインストール ID を入力します。
  7. [Private Key] フィールドに、.pem ファイルの内容全体を貼り付けます。
  8. GitHub Enterprise Server を使用している場合は、[GitHub Hostname] フィールドにそのホスト名を入力します。github.com の場合は、このフィールドを空白のままにします。
  9. [Create] をクリックします。

コネクションはデフォルトでプライベートになります。他のユーザーがワークフローやアプリでこれを使用できるようにするには、コネクションの権限設定からアクセス権を構成してください。詳細については、Workflow Automation または App Builder の「アクセスと認証」を参照してください。

GitHub アプリの権限を更新する

GitHub アプリのインストール後に権限を追加しても、既存のインストールにはその権限が自動的に付与されません。各組織またはアカウントのアプリのインストール設定を開き、アクションで使用する前に新しい権限を承認してください。

トラブルシューティング

アクションが使用する組織またはリポジトリが間違っている

コネクション内のインストール ID が、想定される組織およびリポジトリのインストールと一致しているかどうかをチェックしてください。インストール ID は、アプリのインストール設定 URL で確認できます。

アクションが権限エラーを返す

GitHub アプリに構成された権限と、そのインストールで利用可能なリポジトリをチェックしてください。アプリのインストール後に権限を追加した場合は、インストール設定を開いて新しい権限リクエストを承認してください。

参考資料

役立つドキュメント、リンク、記事:


ご質問やフィードバックがある場合は、Datadog Community Slack の #workflows または #app-builder チャンネルにご参加ください。