第1章 RHTAP 用の GitHub アプリケーションの作成
RHTAP 用の GitHub アプリケーションを作成すると、開発者が Red Hat Developer Hub に対して認証できるようになります。Developer Hub は、RHTAP を使用できる開発者向けのユーザーインターフェイス (UI) です。また、この GitHub アプリケーションにより、RHTAP が GitHub でホストされている開発者のソースコードにアクセスできるようになります。
この新しいアプリケーションは、お客様が所有し、Red Hat Trusted Application Pipeline のインスタンスに使用する GitHub 組織に作成してインストールする必要があることに注意してください。その後、その組織内に RHTAP が新しいリポジトリーを作成し、構築するアプリケーションのソースコードを提供します。
前提条件
- GitHub 組織の所有権
手順
- GitHub にログインし、組織 (Settings > Organizations) に移動します。
- お客様が所有し、RHTAP のこのインスタンスに使用する組織をクリックします。または、New organization を選択して新しい組織を作成することもできます。
- 組織のコンテキストで、GitHub Apps ページ (Settings > Developer settings > GitHub Apps) に移動します。
- ページの右側、上部のバナーの近くにある New GitHub App を選択します。
- プロンプトが表示されたら、必要に応じて認証します。
- GitHub App name フィールドに一意の名前を入力します。
- Homepage URL フィールドにプレースホルダー値 (例: https://www.placeholder.com) を入力します。
- Callback URL フィールドにプレースホルダー値を入力します。同じプレースホルダー値 (例: https://www.placeholder.com) を使用できます。
- Webhook URL フィールドにプレースホルダー値を入力します。同じプレースホルダー値 (例: https://www.placeholder.com) を使用できます。また、Active チェックボックスがオンになっていることを確認します (GitHub ではデフォルトでオンになっているはずです)。
ローカルシステムに新しいファイルを作成します。このファイルには、インストールプロセスの後の手順で必要になるいくつかの値を保存します。このファイルに値を入力するときは、後で各値が何であるかを思い出せるように必ずラベルを付けてください。
$ touch ~/install_values.txtCLI でシークレットを生成し、ラベルを付けて
~/install_values.txtに保存します。OpenSSL をお持ちでない場合は、ダウンロード手順 に従ってください。
$ openssl rand -hex 20 >> ~/install_values.txt重要このコマンドの出力を必ず保存してください。
- GitHub の Webhook secret フィールドに、先ほどのコマンドの出力を入力します。
Repository permissions で、次の権限を設定します。
- Administration: Read and write
- Checks: Read and write
- Contents: Read and write
- Issues: Read and write
- Metadata: Read-only (すでに正しく設定されているはずですが、値を確認してください)
- Pull requests: Read and write
Organization permissions で、次の権限を設定します。
- Members: Read-only
- Plan: Read-only
Subscribe to events で、次のサブスクリプションを選択します。
- Check run
- Check suite
- Commit comment
- Issue comment
- Pull request
- Push
- Where can this GitHub App be installed? で Any account を選択します。
- Create GitHub App をクリックします。すると、Developer Settings ページが表示されます。
Client ID と Application ID を取得します。ラベルを付けて
~install_values.txtに保存します。重要次の 2 つの手順では、クライアントシークレットと秘密鍵を収集する方法を説明します。RHTAP のインストールプロセスを完了するには、クライアントシークレットと秘密鍵を保存し、アクセス可能な状態にしておく必要があります。
-
新しいアプリケーションのページで、Client secrets の横にある Generate a new client secret を選択します。クライアントシークレットにラベルを付けて、
~/install_values.txtに保存します。 -
GitHub の同じページの Private keys で、Generate a private key ボタンを選択します。秘密鍵を含む
private-keyファイルがダウンロードされます。秘密鍵ファイルの内容にラベルを付けて、~/install_values.txtに保存します。秘密鍵は-----BEGIN RSA PRIVATE KEY-----で始まり、-----END RSA PRIVATE KEY-----で終わるようにする必要があります。 - 引き続き GitHub の同じページで、左側のタブから Install App を選択します。
- 組織名の横にある緑色の Install ボタンを使用します。
- プロンプトが表示されたら、All repositories を選択して、RHTAP が組織内に新しいリポジトリーを作成できるようにします。緑色の Install ボタンをクリックします。