第8章 ビルドのトリガーおよび変更

手順

1. add-webhooks-unauth.yaml という名前の YAML ファイルを作成し、次のコンテンツを追加します。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: RoleBinding
   metadata:
     annotations:
       rbac.authorization.kubernetes.io/autoupdate: "true"
     name: webhook-access-unauthenticated
     namespace: <namespace> 1
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: Role
     name: "system:webhook"
   subjects:
     - apiGroup: rbac.authorization.k8s.io
       kind: Group
       name: "system:unauthenticated"

   1

   BuildConfig の namespace。

2. 以下のコマンドを実行して設定を適用します。

   $ oc apply -f add-webhooks-unauth.yaml

手順

1. GitHub Webhook を設定します。

   1. GitHub リポジトリーから BuildConfig オブジェクトを作成した後、次のコマンドを実行します。

      $ oc describe bc/<name_of_your_BuildConfig>

      このコマンドは、Webhook GitHub URL を生成します。

      出力例

      https://api.starter-us-east-1.openshift.com:443/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github

   2. GitHub の Web コンソールから、この URL を GitHub にカットアンドペーストします。
   3. GitHub リポジトリーで、Settings Webhooks から Add Webhook を選択します。
   4. Payload URL フィールドに、URL の出力を貼り付けます。
   5. Content Type を GitHub のデフォルト application/x-www-form-urlencoded から application/json に変更します。

   6. Add webhook をクリックします。

      webhook の設定が正常に完了したことを示す GitHub のメッセージが表示されます。

      これで変更を GitHub リポジトリーにプッシュする際に新しいビルドが自動的に起動し、ビルドに成功すると新しいデプロイメントが起動します。

      注記

      Gogs は、GitHub と同じ webhook のペイロード形式をサポートします。そのため、Gogs サーバーを使用する場合は、GitHub webhook トリガーを BuildConfig に定義すると、Gogs サーバー経由でもトリガーされます。

2. payload.json などの有効な JSON ペイロードを含むファイルを指定すると、次の curl コマンドを使用して Webhook を手動でトリガーできます。

   $ curl -H "X-GitHub-Event: push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/github

   -k の引数は、API サーバーに正しく署名された証明書がない場合にのみ必要です。

手順

1. GitLab Webhook を設定します。

   1. 次のコマンドを入力して、Webhook URL を取得します。

      $ oc describe bc <name>

   2. Webhook URL をコピーします。 <secret> はシークレットの値に置き換えます。
   3. GitLab の設定手順 に従い、GitLab リポジトリーの設定に Webhook URL を貼り付けます。

2. payload.json などの有効な JSON ペイロードを含むファイルを指定すると、次の curl コマンドを使用して Webhook を手動でトリガーできます。

   $ curl -H "X-GitLab-Event: Push Hook" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/gitlab

   -k の引数は、API サーバーに正しく署名された証明書がない場合にのみ必要です。

手順

1. Bitbucket Webhook を設定します。

   1. 次のコマンドを入力して、Webhook URL を取得します。

      $ oc describe bc <name>

   2. Webhook URL をコピーします。 <secret> はシークレットの値に置き換えます。
   3. Bitbucket の設定手順 に従い、Bitbucket リポジトリーの設定に Webhook URL を貼り付けます。

2. payload.json などの有効な JSON ペイロードを含むファイルがある場合は、次の curl コマンドを入力して Webhook を手動でトリガーできます。

   $ curl -H "X-Event-Key: repo:push" -H "Content-Type: application/json" -k -X POST --data-binary @payload.json https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/bitbucket

   -k の引数は、API サーバーに正しく署名された証明書がない場合にのみ必要です。

手順

1. 呼び出し元を設定するには、呼び出しシステムに、ビルドの Generic Webhook エンドポイントの URL を指定します。

   一般的な Webhook エンドポイント URL の例

   https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   呼び出し元は、webhook を POST 操作として呼び出す必要があります。

2. Webhook を手動で呼び出すには、次の curl コマンドを入力します。

   $ curl -X POST -k https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   HTTP 動詞は POST に設定する必要があります。セキュアでない -k フラグを指定して、証明書の検証を無視します。クラスターに正しく署名された証明書がある場合には、2 つ目のフラグは必要ありません。

   エンドポイントは、以下の形式で任意のペイロードを受け入れることができます。

   git:
     uri: "<url to git repository>"
     ref: "<optional git reference>"
     commit: "<commit hash identifying a specific git commit>"
     author:
       name: "<author name>"
       email: "<author e-mail>"
     committer:
       name: "<committer name>"
       email: "<committer e-mail>"
     message: "<commit message>"
   env: 1
      - name: "<variable name>"
        value: "<variable value>"

   1

   BuildConfig 環境変数と同様に、ここで定義されている環境変数はビルドで利用できます。これらの変数が BuildConfig の環境変数と競合する場合には、これらの変数が優先されます。デフォルトでは、webhook 経由で渡された環境変数は無視されます。Webhook 定義の allowEnv フィールドを true に設定して、この動作を有効にします。

3. curl を使用してこのペイロードを渡すには、payload_file.yaml という名前のファイルで定義し、次のコマンドを実行します。

   $ curl -H "Content-Type: application/yaml" --data-binary @payload_file.yaml -X POST -k https://<openshift_api_host:port>/apis/build.openshift.io/v1/namespaces/<namespace>/buildconfigs/<name>/webhooks/<secret>/generic

   引数は、ヘッダーとペイロードを追加した以前の例と同じです。-H の引数は、ペイロードの形式により Content-Type ヘッダーを application/yaml または application/json に設定します。--data-binary の引数を使用すると、POST 要求では、改行を削除せずにバイナリーペイロードを送信します。