コードを読んで理解するko build

Jagu'e'r Cloud Native #17 ハイブリッド Meetup ~ 推しの CNCF プロジェクトを紹介するぜ LT ~ の登壇資料です。
https://jaguer-cloud-native.connpass.com/event/342024/

参考リンク・画像など引用元一覧
https://ko.build/
https://github.com/ko-build/ko
https://github.com/google/go-containerregistry
https://github.com/sigstore/cosign
https://github.com/opencontainers/image-spec
https://github.com/cncf/sandbox/issues/17
https://github.com/ko-build/ko/issues/791
https://github.com/cncf/sandbox/issues/163
https://github.com/cncf/artwork/blob/main/projects/ko/stacked/color/ko-stacked-color.png
https://github.com/cncf/artwork/blob/main/projects/ko/icon/color/ko-icon-color.png

Transcript

1. コードを読んで理解するko build Jagu'e'r Cloud Native # 1 7 ハイブリッド Meetup ( 2 0 2 5 / 0 2 / 1 9 ) @bells 1 7
2. ▶ @bells 1 7 ▶ Software Engineer@ 3 -shake inc. ▶ CNCF Ambassadors ▶ Kubernetes Novice Tokyo Organizer ▶ X(Twitter): @bells 1 7 _ ▶ GitHub: @bells 1 7
3. ko ▶ GoアプリケーションをDocker fi le無しでコンテナ化してくれるツール ▶ Googleが開発→現在はCNCF Sandboxプロジェクト化 ▶ cgoやOSパッケージの依存関係がない単 一 の Go アプリケーションが対象 ▶ Dockerなどのコンテナランタイム不要でイメージビルドが可能 ▶ Goアプリケーションのビルドは 手 元環境のgoコマンドに依存 ▶ ko本体に加えて、GitHub ActionsとTerraform Providerを提供 今回の検証バージョンは0.17.1となります
4. Sandboxプロジェクト登録時期
5. https://github.com/cncf/sandbox/issues/ 1 7
6. https://github.com/ko-build/ko/issues/ 7 9 1
7. https://github.com/cncf/sandbox/issues/ 1 6 3
8. なんか商標関連の 手 続きが放置気味みたい
9. ko buildを動かしてみる
10. コンテナレジストリにリポジトリを作成 Docker Hubだとうまく設定できなかったのでGoogle Cloud Art fi fact Registryを利 用
11. $ gcloud auth con fi gure-docker asia-northeast 1 -docker.pkg.dev { "credHelpers": { "asia-northeast 1 -docker.pkg.dev": "gcloud" } } Adding credentials for: asia-northeast 1 -docker.pkg.dev gcloud credential helpers already registered correctly. 事前にレジストリの認証を 行 う
12. $ KO_DOCKER_REPO=asia-northeast 1 -docker.pkg.dev/xxx/ko-sample ko build . 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Using base cgr.dev/chainguard/ static:latest@sha 2 5 6 : 8 5 3 bfd 4 4 9 5 abb 4 b 6 5 ede 8 fc 9 3 3 2 5 1 3 ca 2 6 2 6 2 3 5 5 8 9 c 2 cef 5 9 b 4 fce 5 0 8 2 d 0 8 3 6 d for ko-sample 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 git doesn't contain any tags. Tag info will not be available git is in a dirty state Please check in your pipeline what can be changing the following fi les: M main.go 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Building ko-sample for linux/amd 6 4 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Publishing asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample- 0 e 7 4 e 5 a 8 7 2 2 1 dc 7 fa 8 3 7 ed 7 da 0 8 8 dd 4 c:latest … 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Published SBOM asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample- 0 e 7 4 e 5 a 8 7 2 2 1 dc 7 fa 8 3 7 ed 7 da 0 8 8 dd 4 c:sha 2 5 6 - eae 3 0 b 0 0 dae 2 b 2 fee 4 d 0 c 9 6 7 e 9 ece 7 0 c 5 f 0 d 6 c 8 6 6 b 6 e 2 9 f 7 bda 5 c 3 4 9 cf 6 3 3 0 6 b.sbom 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Published asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample- 0 e 7 4 e 5 a 8 7 2 2 1 dc 7 fa 8 3 7 ed 7 da 0 8 8 dd 4 c@sha 2 5 6 :eae 3 0 b 0 0 dae 2 b 2 fee 4 d 0 c 9 6 7 e 9 ece 7 0 c 5 f 0 d 6 c 8 6 6 b 6 e 2 9 f 7 bda 5 c 3 4 9 cf 6 3 3 0 6 b asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample- 0 e 7 4 e 5 a 8 7 2 2 1 dc 7 fa 8 3 7 ed 7 da 0 8 8 dd 4 c@sha 2 5 6 :eae 3 0 b 0 0 dae 2 b 2 fee 4 d 0 c 9 6 7 e 9 ece 7 0 c 5 f 0 d 6 c 8 6 6 b 6 e 2 9 f 7 bda 5 c 3 4 9 cf 6 3 3 0 6 b KO_DOCKER_REPOでレジストリを指定して ko build を実 行 してイメージビルド & push buildサブコマンドだけどデフォルトでpushするしSBOM情報もpushする
13. $ KO_DOCKER_REPO=asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample \ ko build --bare --tags v 1 . 0 . 0 ,latest . ... asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample@sha 2 5 6 :eae 3 0 b 0 0 dae 2 b 2 fee 4 d 0 c 9 6 7 e 9 ece 7 0 c 5 f 0 d 6 c 8 6 6 b 6 e 2 9 f 7 bda 5 c 3 4 9 cf 6 3 3 0 6 b イメージ名を固定したい場合は --bare オプションを使 用 ここでは --tags も指定してる
14. $ KO_DEFAULTBASEIMAGE=gcr.io/distroless/static \ KO_DOCKER_REPO=asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample \ ko build --bare --tags v 1 . 0 . 0 ,latest . 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Using base gcr.io/distroless/ static@sha 2 5 6 : 3 f 2 b 6 4 ef 9 7 bd 2 8 5 e 3 6 1 3 2 c 6 8 4 e 6 b 2 ae 8 f 2 7 2 3 2 9 3 d 0 9 aae 0 4 6 1 9 6 cca 6 4 2 5 1 acac for ko-sample 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 git doesn't contain any tags. Tag info will not be available git is in a dirty state Please check in your pipeline what can be changing the following fi les: M main.go ... asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample@sha 2 5 6 :c 2 bdbc 2 3 0 2 a 4 3 c 1 4 6 5 d 1 6 d 8 2 4 9 fae 6 9 9 b 7 b 8 f 1 1 9 2 d 8 b 0 d 2 5 9 9 9 9 4 5 7 3 e 1 ae 6 b 1 8 ベースイメージを変えたい場合はKO_DEFAULTBASEIMAGEを使 用
15. $ cosign download sbom asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample:v 1 . 0 . 0 { "SPDXID": "SPDXRef-DOCUMENT", "name": "sbom- sha 2 5 6 :c 2 bdbc 2 3 0 2 a 4 3 c 1 4 6 5 d 1 6 d 8 2 4 9 fae 6 9 9 b 7 b 8 f 1 1 9 2 d 8 b 0 d 2 5 9 9 9 9 4 5 7 3 e 1 ae 6 b 1 8 ", "spdxVersion": "SPDX- 2 . 3 ", "creationInfo": { "created": " 0 0 0 1 - 0 1 - 0 1 T 0 0 : 0 0 : 0 0 Z", "creators": [ "Tool: ko 0 . 1 7 . 1 " ] }, ... cosign download sbomでSBOM情報を確認する Cosignはsigstoreプロジェクトが提供するコマンドラインツール(主にイメージ署名 用 のツール)
16. $ KO_DEFAULTBASEIMAGE=gcr.io/distroless/static KO_DEFAULTPLATFORMS=darwin/arm 6 4 \ KO_DOCKER_REPO=asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample \ ko build --bare --local --tags v 1 . 0 . 0 ,latest . 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Using base gcr.io/distroless/ static@sha 2 5 6 : 3 f 2 b 6 4 ef 9 7 bd 2 8 5 e 3 6 1 3 2 c 6 8 4 e 6 b 2 ae 8 f 2 7 2 3 2 9 3 d 0 9 aae 0 4 6 1 9 6 cca 6 4 2 5 1 acac for ko-sample … 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Building ko-sample for darwin/arm 6 4 /v 8 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Loading asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample: 0 2 6 8 2 5 d 4 b 4 3 8 f 0 ce 0 c 4 7 1 d 9 d 2 0 0 8 1 6 2 c 9 ea 7 8 e 2 7 e 5 0 8 9 3 cfbbdee 5 7 6 6 0 8 b 8 2 4 4 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Loaded asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample: 0 2 6 8 2 5 d 4 b 4 3 8 f 0 ce 0 c 4 7 1 d 9 d 2 0 0 8 1 6 2 c 9 ea 7 8 e 2 7 e 5 0 8 9 3 cfbbdee 5 7 6 6 0 8 b 8 2 4 4 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Adding tag v 1 . 0 . 0 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Added tag v 1 . 0 . 0 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Adding tag latest 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Added tag latest asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample: 0 2 6 8 2 5 d 4 b 4 3 8 f 0 ce 0 c 4 7 1 d 9 d 2 0 0 8 1 6 2 c 9 ea 7 8 e 2 7 e 5 0 8 9 3 cfbbdee 5 7 6 6 0 8 b 8 2 4 4 --localオプションを付けるとイメージをローカルに保存してくれる Arm系のMacで動くようにこちらも指定: KO_DEFAULTPLATFORMS=linux/arm 6 4
17. $ docker images asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample REPOSITORY TAG IMAGE ID CREATED SIZE asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample 0 2 6 8 2 5 d 4 b 4 3 8 f 0 ce 0 c 4 7 1 d 9 d 2 0 0 8 1 6 2 c 9 ea 7 8 e 2 7 e 5 0 8 9 3 cfbbdee 5 7 6 6 0 8 b 8 2 4 4 ec 4 6 c 4 6 c 6 5 1 0 N/A 3 . 9 3 MB asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample latest ec 4 6 c 4 6 c 6 5 1 0 N/A 3 . 9 3 MB asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample v 1 . 0 . 0 ec 4 6 c 4 6 c 6 5 1 0 N/A 3 . 9 3 MB $ docker run --rm asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample:v 1 . 0 . 0 Hello World! イメージがローカルにあることが確認できる
18. cat << EOF > .ko.yaml defaultBaseImage: gcr.io/distroless/static EOF KO_DOCKER_REPO=asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko-sample \ ko build . --bare --tags v 2 . 0 . 0 2 0 2 5 / 0 1 / 0 1 0 0 : 0 0 : 0 0 Using base gcr.io/distroless/ static@sha 2 5 6 : 3 f 2 b 6 4 ef 9 7 bd 2 8 5 e 3 6 1 3 2 c 6 8 4 e 6 b 2 ae 8 f 2 7 2 3 2 9 3 d 0 9 aae 0 4 6 1 9 6 cca 6 4 2 5 1 acac for ko-sample ... asia-northeast 1 -docker.pkg.dev/xxx/ko-sample/ko- sample:v 2 . 0 . 0 @sha 2 5 6 :c 2 bdbc 2 3 0 2 a 4 3 c 1 4 6 5 d 1 6 d 8 2 4 9 fae 6 9 9 b 7 b 8 f 1 1 9 2 d 8 b 0 d 2 5 9 9 9 9 4 5 7 3 e 1 ae 6 b 1 8 .ko.yaml でオプションを設定ファイル化することも可能 KO_DOCKER_REPO は設定ファイル化できない模様
19. defaultBaseImage: gcr.io/distroless/static defaultPlatforms: - linux/arm 6 4 - linux/amd 6 4 - darwin/arm 6 4 - darwin/amd 6 4 defaultEnv: - FOO=foo defaultLd fl ags: - -s 結構いろんなオプションを設定することが可能 ちなみにコンテナ内のENVを設定する 方 法はなさそうだった(個 人 的にはこれが気になる)
20. ko buildでできること 下記のようにコンテナイメージを build & pushしてくれる ▶ cgr.dev/chainguard/static イメージを利 用 (変更可能) ▶ Goのアプリケーションのビルド時のフラグや環境変数を設定可能 ▶ (KO_DATA_PATHを設定することで)static fi leをコンテナに設定可能 ▶ Multi Platformなイメージビルドをサポート(デフォルトはlinux/amd 6 4 ) ▶ SBOMを 生 成~レジストリにpushしてくれる(—sbom=noneで無効化可能) ▶ ローカルにもビルドしたイメージを保存可能(—localを使 用 ) ▶ Goのデバッガをプログラムに設定可能(—debugを使 用 ) ▶ 生 成するイメージのmetadataを設定可能(—image-xxxを使 用 ) 主要な設定はこのあたり
21. ko buildが何をやっているのか調べる
22. $ cd /path/to/dir $ git clone git@github.com:ko-build/ko.git $ git checkout v 0 . 1 7 . 1 cloneして指定バージョンに切り替え
23. まずはエントリーポイントから main.go
24. cobraでコマンドラインを構成 pkg/commands/root.go
25. buildサブコマンドが追加されている pkg/commands/commands.go
26. buildサブコマンドで実 行 される処理 po/boについてはこちら pkg/commands/build.go (わかりやすさのため 一 部コードを削ってます) やってること ▶ デフォルト引数を "." に設定 ▶ builderを作成 ▶ publisherを作成 ▶ buildとpush処理を実 行
27. まず全体像を掴むためにpublishImagesの中 身 から pkg/commands/publisher.go やってること ▶ ビルドなどを実 行 するパス単位で 処理を実 行 (for) ▶ 対象ディレクトリのパッケージ チェック ▶ イメージのビルド ▶ イメージのpush
28. makeBuilderでbuilderを 生 成 pkg/commands/resolver.go (わかりやすさのため 一 部コードを削ってます) やってること ▶ Con fi gからOptionを 生 成 ▶ innerBuilderを 生 成 ▶ builderを 生 成してreturn
29. build.NewCaching pkg/build/shared.go コメントで 「指定されたパスのビルド結果を共有 する」 みたいなこと書いてるけど使うケース なさそう (ko build a/b ./a/b みたいなこと やらないだろうし)
30. NewGobuilds pkg/build/gobuilds.go ざっくり説明 後半の for の部分は無視してしまってOK (パスごとのビルド設定を変える場合なので) NewGo()というのがdefaultBuilderに設定 されていることがわかる
31. NewGo pkg/build/gobuilds.go やってること ▶ gobuildOpenerを 生 成 ▶ optionを設定 ▶ gbo.Openでgobuildを 生 成してreturn
32. 再掲 pkg/commands/publisher.go やってること ▶ ビルドなどを実 行 するパス単位で 処理を実 行 (for) ▶ 対象ディレクトリのパッケージ チェック ▶ イメージのビルド ▶ イメージのpush
33. *Cacheing.Build pkg/build/shared.go ざっくり説明 newFeatureの引数に渡した関数を goroutineで 非 同期に実 行 して その結果をchannelで受け取れる形で c.inner.Buildを実 行 してる ↓ この中でc.inner.Buildを実 行 してる ↓ c.inner.Buildがビルド処理の実体
34. *gobuild.Build pkg/build/gobuild.go (わかりやすさのため 一 部コードを削ってます) ざっくり説明 ▶ ベースイメージを取得 (デフォルトはcgr.dev/chainguard/static) ▶ マルチプラットフォーム向けビルド かどうかで処理分岐 ▶ 今回は簡単にするために単 一 プラット フォームだった場合で話を進めます → g.buildOneが実 行 される場合 (g.buildAllもループして中でg.buildOneを 実 行 してるだけ)
35. build
36. buildOne: 1 (イメージビルドのメイン) pkg/build/gobuild.go こっからしばらくbuildOneの解説 長 いので必要なところだけコード乗せ てく感じにします
37. buildOne: 2 pkg/build/gobuild.go ざっくり説明 buildEnvでGoアプリケーション ビルド時のenvを設定 (これと似たようなのでgo fl agの設定 なんかもある)
38. buildOne: 3 ざっくり説明 g.buildで 手 元のgoコマンドを使って バイナリをビルド (デフォルトはtmpdirに 生 成)
39. buildOne: 4 pkg/build/gobuild.go ざっくり説明 コンテナレイヤーを表すlayers変数を作成 ↓ KO_DATA_PATHで設定したstatic assetsを レイヤーに追加してる (要はDocker fi leでADDしてるみたいな感じ)
40. buildOne: 5 pkg/build/gobuild.go ざっくり説明 先ほどビルドしたアプリケーションを /ko-app/<name> に設置するレイヤーを追加
41. buildOne: 6 オプション設定に応じてデバッガー(delve)を レイヤーに追加 デバッガーはなぜか 手 元に無くてもダウンロードして 入 れてくれる デバッガが起動するようにオプションなども設定する
42. buildOne: 7 pkg/build/gobuild.go ざっくり説明 mutate.Appendでレイヤーを重ねた変数を 生 成 ↓ entrypointなどのmetadataを設定
43. buildOne: 8 pkg/build/gobuild.go ざっくり説明 mutate.Con fi gFileでentrypointなどの設定を イメージに追加 ↓ SBOM有り設定ならSBOMを 生 成して追加 ↓ イメージビルドが完了
44. build編まとめ 主に下記のようなことを 行 いイメージを作成している ▶ Goアプリケーションのビルド設定を整える(環境変数やGoの fl agなど) ▶ 手 元のgoバイナリを使 用 してアプリケーションをビルド ▶ KO_DATA_PATHで設定したstatic assetsをレイヤーとして追加 ▶ ビルドしたバイナリをレイヤーとして追加 ▶ (Optional)デバッガーをレイヤーとして追加 ▶ entrypointなどのmetadataをイメージに追加 ▶ (Optional)SBOM情報を追加 ということでコンテナのデフォルト環境変数などを設定する余地はなさそうだった(ベースイメージで設定するしかなさそう)
45. publish
46. 再掲 po/boについてはこちら pkg/commands/build.go (わかりやすさのため 一 部コードを削ってます) やってること ▶ デフォルト引数を “.” に設定 ▶ builderを作成 ▶ publisherを作成 ▶ buildとpush処理を実 行
47. 再掲 pkg/commands/publisher.go やってること ▶ ビルドなどを実 行 するパス単位で 処理を実 行 (for) ▶ 対象ディレクトリのパッケージ チェック ▶ イメージのビルド ▶ イメージのpush
48. publishの流れもbuildに結構近い ▶ publish.caching というラッパーがc.inner.Publishを呼び出す ▶ Publisherは設定に応じて複数設定されることがある(ここはbuildと違う) ▶ c.inner.Publishがそれぞれのpublisherを実 行 する
49. c.inner.Publishの中 身 pkg/publish/multi.go ざっくり説明 登録された各publisherを 実 行 してくだけ
50. リモートレジストリにpushするpublilsherはこれ pkg/commands/resolver.go 他にもローカルに保存したりする やつなどでpublisherが分れてる
51. NewDefault pkg/publish/default.go これもbuilderと同じく~Opener というのを介して処理する作り
52. Open defaltというpush処理をするやつを 生 成 pkg/publish/default.go (わかりやすさのため 一 部コードを削ってます)
53. Publish: 1 ざっくり説明 設定するタグごとに並列処理 ↓ 初回のみd.pushResultでイメージ+SBOMを push 2回 目 以降はタグのみpush pkg/publish/default.go (わかりやすさのため 一 部コードを削ってます)
54. pushResult: 1 ざっくり説明 まずはイメージをpush (d.pusher.Push(ctx, tag, br)) pkg/publish/default.go (わかりやすさのため 一 部コードを削ってます)
55. pushResult: 2 pkg/publish/default.go (わかりやすさのため 一 部コードを削ってます) ざっくり説明 イメージと平 行 してSBOMをpush
56. Publish編まとめ 主に下記のようなことを 行 いイメージをpublishしている ▶ イメージと各タグをpublish(DefaultPublisherの場合はpush) ▶ SBOM情報もpublish(DefaultPublisherの場合はpush)
57. ko buildがコンテナイメージ作成時に 使 用 してるライブラリ
58. google/go-containerregistry https://github.com/google/go-containerregistry
59. イメージのビルド & pushに利 用 https://github.com/google/go-containerregistry/blob/main/images/ociimage.jpeg の 一 部
60. sigstore/cosign https://github.com/sigstore/cosign
61. pkg/oci を使いOCI ArtifactとしてSBOM 用 データを管理 https://github.com/opencontainers/image-spec/blob/main/manifest.md#guidelines-for-artifact-usage
62. 今回調べてみての感想 ▶ Buildpackとかもそうだけど、Docker fi le無しでどうやってコンテナイメージを作ってるの か気になっていたけど中 身 をみたら意外と愚直にgo buildしたりしてて「ですよね」とい う気持ちになった(それも含めて勉強になった) ▶ google/go-containerregistryを使 用 してコンテナランタイム無しでコンテナイメージを 作っていくのが 面白 かった koのコードを 見 て頭に 入 る部分が増えたので、これをきっかけに改めて opencontainers/image-spec を眺めてみたい ▶ 簡単に使えて便利な 一方 で、設定できる項 目 は結構限られているなという印象だった (Goアプリケーションのビルド設定以外はあまり 自 由度が無い)
63. 参考リンク ・ 画像など引 用 元 一 覧 ▶ https://ko.build/ ▶ https://github.com/ko-build/ko ▶ https://github.com/google/go-containerregistry ▶ https://github.com/sigstore/cosign ▶ https://github.com/opencontainers/image-spec ▶ https://github.com/cncf/sandbox/issues/ 1 7 ▶ https://github.com/ko-build/ko/issues/ 7 9 1 ▶ https://github.com/cncf/sandbox/issues/ 1 6 3 ▶ https://github.com/cncf/artwork/blob/main/projects/ko/stacked/color/ko-stacked- color.png ▶ https://github.com/cncf/artwork/blob/main/projects/ko/icon/color/ko-icon-color.png
64. Thanks / Question? ▶ @bells 1 7 ▶ Slide: https://speakerdeck.com/bells 1 7 ▶ @bells 1 7 _