第163回 雲勉 CircleCIで複数リポジトリ間のパイプラインを連携する

下記、勉強会での資料です。
https://youtu.be/KBLuGzMw8Bk

Transcript

1. 第163回 雲勉 CircleCIで複数リポジトリ間の パイプラインを連携する
2. 講師自己紹介 2 ◼ 朝枝 知之（Asaeda Tomoyuki） • クラウドインテグレーション事業部 MSP開発セクション 第一G • Webサービス開発企業で勤務後、2019年8月アイレット入社 • 昨年から少しずつ筋トレをして身体づくりに励んでいます。 • ご質問は YouTubeのコメント欄で受け付けております。 後日回答させていただきます！
3. CircleCI について 3 ◼ 対象の視聴者 • CircleCIの初級〜中級者 • パイプライン／ワークフロー／ジョブ／ステップ 等がわかる • GitHub Actions など他のCI/CDサービスの利用者 CircleCIはGitHubやBitbucketと連携し、コードの変更に応じてビルドやテスト、デプロイを 自動実行できるCI/CDプラットフォームです。ワークフローや条件分岐を駆使した柔軟な運 用が可能です。 ここではCircleCIのジョブ内から他のパイプラインを実行する方法について紹介します。 1つのパイプラインでCI/CDの処理を完結させるだけでなく、異なるリポジトリにあるパイプ ラインを連携させることでより柔軟で効率的なCI/CDのワークフローを実現できます。
4. アジェンダ 4 1. ユースケース 2. 準備とイメージ 3. 実装手順 4. 注意点
5. アジェンダ 5 1. ユースケース 2. 準備とイメージ 3. 実装手順 4. 注意点
6. 1. ユースケース 6
7. 1．ユースケース 7 ◼ その① マイクロサービスの分割管理 • 連携テストや統合デプロイ あるサービスのビルドやテストが完了したタイミングで、依存する他サービスのパイプラインを自 動的にキック リポジトリA パイプライン リポジトリB パイプライン
8. 1．ユースケース 8 ◼ その② マイクロサービスの分割管理 • コードの再利用 共通ライブラリ用リポジトリで変更があった場合、依存する複数のリポジトリのパイプラインを一 斉に実行する リポジトリA パイプライン リポジトリB パイプライン リポジトリC パイプライン リポジトリD パイプライン
9. アジェンダ 9 1. ユースケース 2. 準備とイメージ 3. 実装手順 4. 注意点
10. 2. 準備とイメージ 10
11. 2．準備とイメージ 11 ◼ 今回例として作成するもの 1. パイプラインAのジョブからパイプラインBを実行 2. パイプラインBの実行中、パイプラインAは待機 3. パイプラインAのジョブがパイプラインBの実行結 果（成功 or 失敗）を取得 1. 成功の場合パイプラインAの後続のジョブを続行 し、失敗の場合パイプラインAも失敗で終了させる パイプラインA→BのキックはcurlによるPOSTリクエスト で実施します
12. 2．準備とイメージ 12 ◼ 必要なもの① • CircleCIの パーソナルAPIトークン (後述) →「プロジェクトAPIトークン」ではない (“Project not found” というエラーになる)
13. 2．準備とイメージ 13 ◼ 必要なもの② • GitHubリポジトリ × 2つ (パイプラインのキック元とキック先)
14. アジェンダ 14 1. ユースケース 2. 準備とイメージ 3. 実装手順 4. 注意点
15. 3. 実装手順 15
16. 3．実装手順 16 ◼ 手順① APIトークンの準備 1. CircleCIのユーザー設定画面（User Settings）にアクセス 2. 「Personal API Tokens」のセクションで新しいトークンを発行する 3. キック元のCircleCIプロジェクトで環境変数を新規作成する 1. 変数名を CIRCLECI_API_TOKEN_B とし、値に発行したAPIトークンを入れる
17. 3．実装手順 17 ◼ 手順② 設定ファイル(config.yml)の作成 • リポジトリに config.yml がない場合は新規作成する • 0から始める場合は Faster がおすすめ
18. 3．実装手順 18 ◼ 手順③-1 APIリクエストの実装 • パイプラインBをキックする部分 export CIRCLECI_PRJ_SLUG="github/t-asaeda/circleci-multi-repo-pipeline-b” RESPONSE=$(curl -X POST https://circleci.com/api/v2/project/\\ $CIRCLECI_PRJ_SLUG/pipeline \\ -H "Circle-Token: $CIRCLECI_API_TOKEN_B" \\ -H "Content-Type: application/json" \\ -d '{ "branch": "main" }’) PIPELINE_ID=$(echo "$RESPONSE" | jq -r '.id')
19. 3．実装手順 19 ◼ 手順③-2 APIリクエストの実装 • パイプラインBが完了するまで待機する部分 while true; do STATUS=$(curl -s -H "Circle-Token: $CIRCLECI_API_TOKEN_B" \\ "https://circleci.com/api/v2/pipeline/${PIPELINE_ID}/workflow" | jq -r '.items[0].status') if [ "$STATUS" = "success" ]; then echo "Pipeline succeeded." break elif [ "$STATUS" = "failed" ] || [ "$STATUS" = "error" ] || [ "$STATUS" = "failing" ]; then echo "Pipeline failed with status: $STATUS" exit 1 else echo "Pipeline status: $STATUS. Waiting..." sleep 10 fi done
20. アジェンダ 20 1. ユースケース 2. 準備とイメージ 3. 実装手順 4. 注意点
21. 4．注意点 21 ◼ APIトークンの管理 • APIトークンはCircleCIの Contexts やCircleCIプロジェクトの環境変数で安全に管理する • config.yml には直接記述しない • 複数のCircleCIプロジェクトを連携させる可能性があれば Contexts に保存する ◼ エラーレスポンスの確認 • キックしたリクエストのレスポンスを echo して原因がわかるようにする
22. 最後に 22 https://iret.media/149633 iret.media でも記事を公開しています