🦆

GitHub Actionsでkustomizeの結果差分をPRに出す

2022/12/11に公開

ArgoCDでk8sクラスタにdeployするmanifestsをGitHubで管理を管理していて、Pull Request作ったときにkustomizeした結果の差分が出ると便利だなぁと思ったのでやってみた。

最終的なYAMLは一番最後にgist埋込しました。

表示例

Actionsがこんな感じの差分をPRに書いてくれます。

applicationごとにkustomize表示する

ArgoCDで管理してるとApplicationごとにkustomizeすることになるので、差分もApplicationごとに表示してもらいたいので頑張る。

Applicationが参照するmanifestsのpathはApplicationの.spec.source.pathに入ってるので、これをyqでよしなに^[1]。

find applications -name '*.yml' -or -name '*.yaml' | xargs  yq ea -o=json  -N '[.spec.source.path]'

yqはGitHub Actionsで叩けるようになってるので、書くのは単純。findやxargsも動いてくれた。また、next stepでJSON Arrayを要求されているのでそのようにする。

これでkustomize適用するroot pathの一覧が手に入ったので、差分表示するActionsを叩く。

前段でJSON Arrayとして取得したApplicationsをfromJSONでmatrixに渡すと、Applicationごとにjobが立ち上がる。

Applicationごとに最新を表示してほしいので、tagでcommentを管理できるやつをつかう。

kustomize結果の差分を出すActionをぐぐると出てきたのがこれ。

さっそく動かしてみると動かない。なので、forkして動くように改造。ついでにkustomizeのrevisionもupdateしました。

これやらないと動いてくれない。issue読むとディレクトリのownershipを変えてもいい(それはそう)けど、いちいち気にしたくないのでsafe.directoryにしてしまう。

現時点では動いてるけどwarningが出るので消してやる。が、差分は複数行出力するので単純置換だと動かない^[2]。\nをescapeする前のraw stringをdelimiterを指定する形で吐き出す。

脚注