DockerのマルチプラットフォームイメージをGitHub Actionsでビルドして公開する際に、参考にしたドキュメントと便利だったツール

2024-09-25
ENECHANGE I/O Day LT⼤会（社内イベント）

Transcript

1. Dockerのマルチプラットフォームイメージを GitHub Actionsでビルドして公開する際に、 参考にしたドキュメントと便利だったツール 2024-09-25 ENECHANGE I/O Day LT大会（社内イベント） VPoT兼CTO室マネージャー 岩本隆史
2. 前置き 2/20
3. 公開したもの：マルチプラットフォームイメージ2種 イメージ 追加ライブラリ（今はboto3のみ） ghcr.io/iwamot/collmbo:latest-slim 含まない ghcr.io/iwamot/collmbo:latest-full 含む iwamot/collmbo（社内でも使っているSlackbot OSS）の公式イメージ いずれも、linux/amd64とlinux/arm64をサポート https://github.com/iwamot/collmbo/issues/6 でリクエストがあったため対応 3/20
4. レギュレーション：「無料の範囲内」 Docker Build Cloudを使う手もあるが、今回は無料にこだわった GitHub ActionsのArmランナーも今は有料なので回避 4/20
5. 参考にしたドキュメント 5/20
6. Multi-platform image with GitHub Actions https://docs.docker.com/build/ci/github-actions/multi-platform/ Dockerが公開している、GitHub Actionsワークフローの実装例 6/20
7. 3パターンの実装例が掲載 1. docker/build-push-actionで複数のプラットフォームを指定（直列的） 2. 各プラットフォームのビルドを複数ランナーで並列実行、その後マージ 3. 2と同じパターンでdocker/bake-actionを利用 今回は2を採用 1はビルド時間が長くなる 3はBakeの理解が必要 7/20
8. 例を参考に「ビルド4並列・マージ2並列」で実装 matrix: platform: - linux/amd64 - linux/arm64 flavor: - name: slim use_bedrock: false - name: full use_bedrock: true matrix: flavor: - slim - full https://github.com/iwamot/collmbo/blob/main/.github/workflows/publish.yml 8/20
9. Cache management with GitHub Actions https://docs.docker.com/build/ci/github-actions/cache/ Dockerが公開している、GitHub Actionsでのキャッシュ管理の実装例 9/20
10. 5パターンの実装例が掲載 1. インラインキャッシュ（結果イメージのキャッシュのみエクスポート） 2. レジストリキャッシュ（中間レイヤーのキャッシュもエクスポート） 3. GitHubキャッシュ > キャッシュバックエンドAPI 4. GitHubキャッシュ > キャッシュマウント 5. GitHubキャッシュ > ローカルキャッシュ 今回は2を採用 マルチステージビルドのため、中間レイヤーもキャッシュしたい ビルド間隔が長い（GitHubキャッシュは7日アクセスなしのエントリを削除） 10/20
11. docker/build-push-actionでtype=registryを指定 uses: docker/build-push-action@v6 with: platforms: ${{ matrix.platform }} build-args: | USE_BEDROCK=${{ matrix.flavor.use_bedrock }} labels: ${{ steps.meta.outputs.labels }} outputs: type=image,name=${{ env.REGISTRY_IMAGE }},> push-by-digest=true,name-canonical=true,push=true cache-from: type=registry,ref=${{ env.REGISTRY_IMAGE }}:cache-${{ env.PLATFORM_PAIR }}-${{ matrix.flavor.name }} cache-to: type=registry,ref=${{ env.REGISTRY_IMAGE }}:cache-${{ env.PLATFORM_PAIR }}-${{ matrix.flavor.name }},mode=max 11/20
12. 直近のビルドではキャッシュ利用率19%～25% https://github.com/iwamot/collmbo/actions/runs/10916311884 12/20
13. 便利だったツール 13/20
14. Kesin11/actions-timeline：タイムライン可視化 https://github.com/Kesin11/actions-timeline 14/20
15. 実行の結果、並列処理とキャッシュ活用で十分と判断 https://github.com/iwamot/collmbo-test/actions/runs/10576986797 15/20
16. suzuki-shunsuke/ghalint：セキュリティlinter https://github.com/suzuki-shunsuke/ghalint 16/20
17. 初回実行時、2つのポリシー違反を検出 1. action_ref_should_be_full_length_commit_sha https://github.com/suzuki-shunsuke/ghalint/blob/main/docs/policies/008.md actions/checkout@v4 のようなバージョン指定は好ましくない いったん受容（GitHubとDockerのアクションのみ利用中。低リスクと判断） 2. job_timeout_minutes_is_required https://github.com/suzuki-shunsuke/ghalint/blob/main/docs/policies/012.md ジョブにはタイムアウトを指定すべき（デフォルトでは6時間で強制終了） 対応済み 17/20
18. まとめ 18/20
19. 成果：2種のイメージを公開するワークフローが完成 マルチプラットフォームイメージを無料かつ短時間でビルド、公開 セキュリティにも配慮（いったん受容したリスクは、余裕があれば解消したい） 19/20
20. 参考にしたドキュメントと便利だったツール ドキュメント Multi-platform image with GitHub Actions：ワークフローの実装例 https://docs.docker.com/build/ci/github-actions/multi-platform/ Cache management with GitHub Actions：キャッシュ管理の実装例 https://docs.docker.com/build/ci/github-actions/cache/ ツール Kesin11/actions-timeline：タイムライン可視化 https://github.com/Kesin11/actions-timeline suzuki-shunsuke/ghalint：セキュリティlinter https://github.com/suzuki-shunsuke/ghalint 20/20