Automation Pipelines を Gerrit と統合する方法

Automation Pipelines では、Gerrit プロジェクトでコードレビューが発生したときにパイプラインをトリガできます。Gerrit 用トリガの定義には、イベントタイプに応じて実行する必要がある Gerrit プロジェクトとパイプラインが含まれます。

Gerrit 用トリガは、監視対象の Gerrit サーバにある Gerrit リスナーを使用します。Automation Pipelines で Gerrit エンドポイントを定義するには、プロジェクトを選択し、Gerrit サーバの URL を入力します。次に、そのサーバに Gerrit リスナーを作成するときに、エンドポイントを指定します。

FIPS が有効になっている VMware Aria Automation インスタンスで Gerrit サーバを Automation Pipelines エンドポイントとして使用している場合は、Gerrit 構成ファイルに正しいメッセージ認証キーが含まれていることを確認する必要があります。Gerrit サーバの構成ファイルに正しいメッセージ認証キーが含まれていない場合は、サーバが正常に起動せず、「PrivateKey/PassPhrase is incorrect」というメッセージが表示されます。

次の手順は、Gerrit リスナー定義で使用できる Gerrit エンドポイントを定義する方法を示しています。エンドポイントの編集が必要な場合のために、手順の最後にあるオプションの手順で、更新を実行する方法とタイミングを説明しています。

前提条件

接続する Gerrit サーバにアクセスできることを確認します。
Automation Pipelines で、プロジェクトのメンバーであることを確認します。メンバーでない場合は、プロジェクトにメンバーとして追加するように Automation Pipelines 管理者に依頼します。Automation Pipelinesでプロジェクトを追加する方法を参照してください。

手順

Gerrit エンドポイントを定義します。
1. [構成] > [エンドポイント] の順にクリックして、[新規エンドポイント] をクリックします。
2. プロジェクトを選択し、エンドポイントのタイプとして [Gerrit] を選択します。次に、名前と説明を入力します。
3. このエンドポイントがインフラストラクチャのビジネスクリティカルなコンポーネントである場合は、[制限付きとしてマーク] を有効にします。
4. Gerrit サーバの URL を入力します。
  デフォルトポートを使用するには、URL でポート番号を指定するか、値を空白のままにします。
5. Gerrit サーバのユーザー名とパスワードを入力します。
  パスワードを暗号化する必要がある場合は、 [変数の作成] をクリックし、次のいずれかのタイプを選択します。
  - シークレット。パスワードは、何らかのロールを持つユーザーがパイプラインを実行すると解決されます。
  - 制限付き。パスワードは、管理者ロールを持つユーザーがパイプラインを実行すると解決されます。
  値には、Jenkins サーバのパスワードなど、保護する必要があるパスワードを入力します。
6. プライベートキーの場合は、Gerrit サーバへの安全なアクセスに使用する SSH キーを入力します。
  このキーは、 .ssh ディレクトリにある RSA プライベートキーです。
7. （オプション） プライベートキーにパスフレーズが関連付けられている場合は、そのパスフレーズを入力します。
  パスフレーズを暗号化するには、 [変数の作成] をクリックし、次のいずれかのタイプを選択します。
  - シークレット。パスワードは、何らかのロールを持つユーザーがパイプラインを実行すると解決されます。
  - 制限付き。パスワードは、管理者ロールを持つユーザーがパイプラインを実行すると解決されます。
  値には、SSH サーバのパスフレーズなど、保護するパスフレーズを入力します。
[検証] をクリックし、Automation Pipelines の Gerrit エンドポイントが Gerrit サーバに接続されていることを確認します。
接続されていない場合は、エラーを修正し、もう一度 [検証] をクリックします。
[作成] をクリックします。
VMware Aria Automation 環境で FIPS が有効になっていることを確認します。または、Jenkins ジョブで Jenkins URL を使用して、FIPS が有効な環境を作成します。
1. コマンドラインからコマンドを実行するには、SSH 経由で VMware Aria Automation 8.x アプライアンスに接続し、root ユーザーとしてログインします。たとえば、https://cava-1-234-567.yourcompanyFQDN.com などの完全修飾ドメイン名 URL にポート 22、5480、または 443 で接続します。
2. VMware Aria Automation の FIPS を確認するには、コマンド vracli security fips を実行します。
3. コマンドが FIPS mode: strict を返すことを確認します。
Gerrit サーバが、FIPS が有効な VMware Aria Automation インスタンスのエンドポイントである場合は、Gerrit 構成ファイルに正しいメッセージ認証 (MAC) キーが含まれていることを確認します。
1. Gerrit を開き、SSH キーペアを作成します。
2. '$site_path'/etc/gerrit.config の Gerrit サーバ構成ファイルを見つけます。
3. Gerrit サーバ構成ファイルに、hmac-MD5 を除くメッセージ認証コード (MAC) キーが 1 つ以上含まれていることを確認します。
  
  注： FIPS モードでは、 hmac-MD5 はサポートされる MAC アルゴリズムではありません。Gerrit サーバが正しく起動するようにするには、Gerrit サーバ構成ファイルでこのアルゴリズムを除外する必要があります。Gerrit サーバが正常に起動しない場合は、「 PrivateKey/PassPhrase is incorrect」というメッセージが表示されます。
  プラス記号 (+) で始まる、サポートされているメッセージ認証コード (MAC) のキー名が有効です。ハイフン (-) で始まる MAC キー名は、デフォルトの MAC のリストから削除されます。デフォルトでは、これらのサポートされる MAC は Gerrit サーバの Automation Pipelines で使用できます。
  - hmac-md5-96
  - hmac-sha1
  - hmac-sha1-96
  - hmac-sha2-256
  - hmac-sha2-512
（オプション） URL またはプライベートキーを変更するなどの目的で Gerrit エンドポイントを更新する前に、エンドポイントが Gerrit リスナーに接続されているかどうかを確認します。
- エンドポイントが Gerrit リスナーに接続されていない場合は、次の手順を実行してエンドポイントを更新します。
  1. [構成] > [エンドポイント] の順にクリックし、更新するエンドポイントで [開く] をクリックします。
  2. エンドポイント定義を更新します。
  3. [検証] をクリックして、Automation Pipelines の Gerrit エンドポイントが Gerrit サーバに接続されていることを確認します。
  4. [保存] をクリックします。
- エンドポイントが Gerrit リスナーに接続されている場合は、次の手順を実行してエンドポイントを更新します。
  1. 接続されている Gerrit リスナーを切断します。Automation Pipelines で Gerrit トリガを使用してパイプラインを実行する方法を参照してください。
  2. 新しいエンドポイントを構成する手順を実行します。
  3. 更新されたエンドポイント定義を検証して保存します。
  4. Gerrit リスナーを再接続します。
  注： Gerrit リスナーが切断されない場合は、現在の Gerrit エンドポイントの値が変更され、そのためにリスナーが Gerrit サーバと通信できなくなっていることが原因である可能性があります。この問題が発生した場合は、まず、リスナーが Gerrit サーバと通信できるようにエンドポイント定義を変更します。次に、Gerrit リスナーを切断し、再接続します。

次のタスク

詳細については、他のセクションを参照してください。Automation Pipelines で Gerrit トリガを使用してパイプラインを実行する方法を参照してください。