1.5. GitHub アプリケーションでの Pipelines as Code の使用
GitHub アプリケーションは Red Hat OpenShift Pipeline とのインテグレーションポイントとして機能し、Git ベースのワークフローのメリットを OpenShift Pipelines にもたらします。クラスター管理者は、すべてのクラスターユーザーに単一の GitHub アプリケーションを設定できます。GitHub アプリケーションが Pipelines as Code と連携するには、GitHub アプリケーションの Webhook が GitHub イベントをリッスンする Pipelines as Code イベントリスナールート (または受信エンドポイント) をポイントするようにします。
1.5.1. GitHub アプリケーションの設定 リンクのコピーリンクがクリップボードにコピーされました!
クラスター管理者は、以下のコマンドを実行して GitHub アプリケーションを作成できます。
tkn pac bootstrap github-app
$ tkn pac bootstrap github-app
tkn pac CLI プラグインがインストールされていない場合は、GitHub アプリケーションを手動で作成できます。
手順
Pipelines as Code 用に GitHub アプリケーションを手動で作成および設定するには、以下の手順を実行します。
- GitHub アカウントにサインインします。
-
Settings
Developer settings GitHub Apps に移動し、New GitHub App をクリックします。 GitHub App フォームに以下の情報を入力します。
-
GitHub Application Name:
OpenShift Pipelines - Homepage URL: OpenShift Console の URL
-
Webhook URL: Pipelines as Code ルートまたは受信 URLこれは、コマンド
echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')を実行して見つけることができます。 -
Webhook secret: 任意のシークレット。コマンド
openssl rand -hex 20を実行してシークレットを生成することができます。
-
GitHub Application Name:
以下の リポジトリーのパーミッション を選択します。
-
チェック:
読み取り/書き込み -
コンテンツ:
読み取り/書き込み -
問題:
読み取り/書き込み -
メタデータ:
読み取り専用 -
プルリクエスト:
読み取り/書き込み
-
チェック:
以下の 組織のパーミッション を選択します。
-
メンバー:
読み取り専用 -
プラン:
読み取り専用
-
メンバー:
以下の ユーザーパーミッション を選択します。
- コミットコメント
- 問題のコメント
- プルリクエスト
- プルリクエストのレビュー
- プルリクエストのレビューコメント
- プッシュ
- Create GitHub App をクリックします。
- 新たに作成された GitHub App の Details ページで、上部に表示される App ID を書き留めます。
- Private keys セクションで、Generate Private key をクリックして GitHub アプリケーションの秘密鍵を自動的に生成およびダウンロードします。今後の参照や使用のために秘密鍵を安全に保管します。
1.5.2. GitHub アプリケーションにアクセスするための Pipelines as Code の設定 リンクのコピーリンクがクリップボードにコピーされました!
新たに作成された GitHub アプリケーションにアクセスするために Pipelines as Code を設定するには、以下のコマンドを実行します。
+
oc -n openshift-pipelines create secret generic pipelines-as-code-secret \
--from-literal github-private-key="$(cat <PATH_PRIVATE_KEY>)" \
--from-literal github-application-id="<APP_ID>" \
--from-literal webhook.secret="<WEBHOOK_SECRET>"
$ oc -n openshift-pipelines create secret generic pipelines-as-code-secret \
--from-literal github-private-key="$(cat <PATH_PRIVATE_KEY>)" \
--from-literal github-application-id="<APP_ID>" \
--from-literal webhook.secret="<WEBHOOK_SECRET>"
GitHub Enterprise から設定されたヘッダーを検出し、それを GitHub Enterprise API 承認 URL に使用することで、Pipelines as Code は自動的に GitHub Enterprise と連携します。
1.5.3. 管理者パースペクティブでの GitHub アプリケーションの作成 リンクのコピーリンクがクリップボードにコピーされました!
クラスター管理者は、OpenShift Container Platform クラスターで GitHub アプリケーションを Pipelines as Code を使用するように設定できます。この設定により、ビルドのデプロイに必要な一連のタスクを実行できます。
前提条件
Operator Hub から Red Hat OpenShift Pipelines pipelines-1.10 Operator をインストールしている。
手順
- 管理者パースペクティブで、ナビゲーションペインを使用して Pipelines に移動します。
- Pipelines ページで GitHub アプリのセットアップ をクリックします。
-
GitHub のアプリケーション名を入力します。例:
pipelines-ci-clustername-testui - Setup をクリックします。
- ブラウザーでプロンプトが表示されたら、Git パスワードを入力します。
-
Create GitHub App for <username> を クリックします。ここで、
<username>は GitHub ユーザー名です。
検証
GitHub App の作成に成功すると、OpenShift Container Platform Web コンソールが開き、アプリケーションの詳細を表示します。
GitHub App の詳細は、openShift-pipelines namespace にシークレットとして保存されます。
GitHub アプリケーションに関連付けられている名前、リンク、シークレットなどの詳細を表示するには、パイプライン に移動し、GitHub アプリの表示 をクリックします。