鴨川🦆べりで今日から始めるCircleCI

この記事は川見てる Advent Calendar 2021およびMoney Forward Engineering Advent Calendar 2021 17日の記事です。

はじめに

マネーフォワードでことし10月から京都や鴨川🦆の良さを社内にひたすら宣伝しながらGoやYAMLなどを書いているwalkureです。
入社時の部署自己紹介で「趣味は鴨川🦆です」と言ったりSlackの分報へ鴨川🦆の写真をひたすら貼り続けていたところ、カモグルイ*1とか呼ばれるようになりました。
殆どの仲間は東京にいるので、あづまの地に鴨川🦆の良さを広めるべくこれからも尽力してまいります。

朝の鴨川🦆

最近は天気がいいので朝起きたら鴨川🦆まで行ってラジオ体操してから就業するというドカタ時代のような生活。
現在*2は週一回出社しましょうということになっていて、勤務地が三条大橋西詰にあるので出社したときも気分転換に鴨川🦆しています。

昼下がりの三条大橋

人間的な生活はここにあった。

今日から始めるCircleCI

入社以来ひたすら鴨川🦆の宣伝GoやYAMLを書いています。東京ではひたすらC#を書いていたので、Goはまだまだ修行中。YAMLですがおもにCircleCIの設定やk8sのmanifestを書いています。

今日は、CircleCIを使ったことない*3わたしが「CircleCIの設定を書いて」って言われた際にいろいろ調べて戦ったメモを(ちょっとだけまともに書き直して)供養することにしました。CIの設定ってプロジェクト立ち上がるときには頑張るけど、走り出すと結構忘れてしまうので覚えているうちに書いておきましょう。

CircleCIってなに

• JenkinsのようなCIをやってくれるクラウドサービス
• github actionが出てきてちょっとどうなるかな？
  • 処理実行するVMコストなどのお話もあるので一概には

設定リファレンス

• CircleCI を設定する - CircleCI

command → job → workflow

• Orb、ジョブ、ステップ、ワークフロー - CircleCI
  • 処理の流れについて

command

• make buildなどの実行コマンドをまとめられる
  • 実行はsteps内にrunを書き連ねる
• 実行単位でない

job

• 実行単位
  • steps内でcommandをたたいたり、runをたたいたり
  • 実行するコンテナイメージ設定もできるぽい
    • 実行環境はexecutor(後述)で指定する

workflow

• jobを並列実行する
  • 依存関係も設定できるので実質直列実行もある
• 実行条件(特定のブランチは無視するとか)も指定
• ワークフローを使用したジョブのスケジュール - CircleCI

orb

CircleCI Orb とは、ジョブ、コマンド、Executor などの、パラメーター化および再利用が可能な構成要素をまとめた共有可能なオープン ソース パッケージです。
Orb の概要 - CircleCI

• 要はcommand(やjobなど)を外ファイルに切出して引っ張ってこれるようにしたもの
• 例えばgoだと環境インストールやgo modをキャッシュするなどの定番作業がorb化されている
• 再利用可能な設定ファイル リファレンス ガイド - CircleCI
  • command に引数設定できるよとかexecutorを名前付けできるよとか
  • jobも引数取れる
  • これらが外部に吐出されたものがorb
• orbのレポジトリはCircleCIがホストしてる
  • https://circleci.com/docs/ja/2.0/orb-intro/

キャッシュ

• CIで立ち上がってくるVMの一部ディレクトリをキャッシュすることができる。
  • パッケージマネージャで拾ってくる依存はちゃんとリビジョン指定していれば、毎回同じものを取ってくることになる。
• Caching Dependencies - CircleCI
• CircleCI 2.0 で Go 1.10 の build cache をいい感じに効かせる | Hori Blog
• 前出のorbでもgoとかだとgo modのキャッシュをシュッと効かせることができる
  • https://circleci.com/developer/ja/orbs/orb/circleci/go#commands-load-cache
• クラウドでしか使えない(後述)ことに留意。

設定はYAML

• YAML の記述 - CircleCI
• YAMLで一行に収まらないものを複数行でやりたい
  • CircleCIのcommandで改行を入れてみやすくする方法 - #人生戦略実行マニュアル
  • syntax - How do I break a string in YAML over multiple lines? - Stack Overflow
  • > で始めると\nを消して連結してくれる。|だと\nはそのまま残して連結
    • > は長いワンライナーを複数行で書くとき、 |はcommandにshell scriptを貼るときに便利そう。
    • >はインデントがそろってないと\nを消してくれない。
      • これは>に特有みたいなので要注意。
    • >や|に-をつけると、行末の\nを消してくれる
      • |-は最後の\nだけなくなるのであんまり意味を感じない。>-は意味があるかも。
  • YAMLで複数行テキストを書きたい時のあれこれ - Qiita
    • 連結時に空白を勝手に挿入する。それを外すにはquoteして行末に\を入れるしかない。
• Transform YAML into JSON - Online YAML Toolsで実際に試して感覚を掴む。

YAMLをJSONに変換してみた例。

• プロジェクトが大きくなったりしてCIへの期待が高まるとYAML長くなるが、YAML複数ファイル分割はできない。
• orbはちょっと違うんだよな〜。
• コメント入れまくるしかない？
• ローカルで分割したYAMLを結合することはできる。
  • CircleCI のローカル CLI の使用>設定ファイルのパッケージ化 - CircleCI
  • circleci config pack で分割したymlから設定ファイル(config.yml)を作成してみた | Grasswake‘s Blog
  • コレジャナイ感がある。

シェル芸がときどき必要

• ex. How to check if a file exists in a shell script - Stack Overflow
  • Shell script check if file exists? - Unix & Linux Stack Exchange
• シェルスクリプトを書くとき覚えておくこと一選 - weblog of key_amb
• (Linux)コマンドを連結して行う｢;｣｢&｣｢&&｣｢||｣の違い : old_3流プログラマのメモ書き
• bash スクリプトの先頭によく書く記述のおさらい | Money Forward Engineers' Blog
  • set -euo pipefailみたいなやつ
• CircleCIは#!/bin/bash -eo pipefailでコマンドを実行する

CircleCI は Bash を使用します
環境変数の使用>環境変数の使用オプション - CircleCI

• runでshell起動する際の設定が色々ある

すべてのコマンドライン プログラムの呼び出しに使用します。
CircleCI を設定する > jobs.steps.run - CircleCI

• job stepの失敗は何も設定しなければ$? != 0
  • whenで失敗条件を変えたり、circleci-agent step haltでジョブを終了したり
• whenはrunの中と外に存在できて、意味が変わる
  • 中にあるときは前出
  • 外にあるとステップの実行条件になる
    • 再利用可能な設定ファイル リファレンス ガイド > 条件付きステップの定義- CircleCI
  • 使ってるとconfig.ymlの複雑度が爆発しそう・・・
  • パイプライン変数 > 条件付きワークフロー- CircleCI

パラメタとしての環境変数

• あちこちで設定できる
• 環境変数の使用 - CircleCI
  • プロジェクト単位での設定→context(後述)→システム定義済み→job定義→runでの定義→run command内 の順番に設定されてゆく

context

• コンテキストの使用 - CircleCI
• 外(CircleCI組織全体の管理)から注入できる環境変数の集合
  • 読み書き権限が設定できるので、APIキーとか設定するのに便利
• workflow単位で引用設定
  • workflow内で呼ばれるjob/commandから見える
• CircleCI上のマシンで環境変数を扱う場合はContextsを使うと便利 - コード日進月歩
• 同一keyの環境変数もった複数のcontextを引用する(env keyを衝突させる)と何が起きるのか
  • エラー吐いてくれるのかな？(まだ試せていない)

デバッグ

• ローカル実行と実際にクラウドを叩くのふたつ

YAMLのデバッグとjobs実行はローカル実行できる

• YAMLのチェックはcircleci config validateでいける
• ジョブの実行はcircleci build --job hoge
• CircleCI のローカル CLI の使用 - CircleCI
• CircleCI ローカルでCircleCIを使いたい
• まさかPushデバッグしてないよね？ よく使うCircleCIのデバッグ方法 - VTRyo Blog
• CircleCIのジョブをローカルPC上で実行する | Hodalog

workflowやキャッシュについてはクラウドを叩く必要がある。

• git commit --allow-empty -m "commit message"
  • クソコミット増やしたくないんだが。。。。
• クラウドで試さないとわからないこともある。
• キャッシュで劇的にステップの速度が上がることによって顕在化するrace condition
  • たとえば後述する複数コンテナ立ち上げる場合
• backgroundを使う場合も何かが起きるかもしれない。
  • CircleCI を設定する>バックグラウンド コマンド - CircleCI

CIを動かす環境(executor)

• Executor タイプの選び方 - CircleCI
• Executor とイメージ - CircleCI
• docker→ machine/macos/windows の順に抽象度が下がり自由度が上がる
  • machineはlinux VM
  • 起動速度はdockerが早く、それ以外はVMの準備から入るようで遅い
• Executor Migration from Docker to Machine - CircleCI
  • Docker executorとMachine executorの違いについて書いてある

CIは基本的にコンテナ上で動く

• CircleCI のビルド済み Docker イメージ - CircleCI
• circleci/のイメージからcimg/のイメージに移行するべきらしい
  • 2021年のChangelogから振り返るCircleCI - その3(最終回) - Qiita

Docker executor

imageは複数指定できるが、最初に指定したimageでCIは動くので書く順番は大事

複数のイメージを指定して設定されたジョブでは、最初にリストしたイメージによって作成されるコンテナで、すべてのステップが実行されます。 すべてのコンテナは共通ネットワーク内で動作します。 また、公開されるポートはすべて、プライマリ コンテナから localhost で利用できます。
Executor タイプの選び方 - CircleCI > 複数の Docker イメージを使用する

• 複数コンテナ間はtcpで会話できてdocker-composeっぽいなにか(docker-composeではない)
• circleci で複数イメージを指定したとき、それは docker としてどのような構成で実現される？ - スタック・オーバーフロー
  • netnsを使っているらしい。

２つ目以降のimageで指定したコンテナが起動完了するのを待ってはくれない

• 前述したキャッシュ等でステップの実行速度が変わることによって並行タスクを追い抜いて事故
  • キャッシュのせいで速度が変わる場合、ローカルでは起きずクラウドに上げて問題が顕在化するような辛い事態が起きる。
• プライマリコンテナでの作業がセカンダリコンテナの起動完了に依存する場合、完了を待つstepを入れるとか
  • MySQL コンテナの起動を待つ #mysql #docker - ジムには乗りたい
    • データベースの設定例 - CircleCI
    • ncで待つ例
  • Race Conditions - Wait For Database
• ncやdockerizeで待つことができる
  • シェル芸の出番？
  • https://github.com/jwilder/dockerize
  • Dockerizeを使って他のコンテナの起動を待つ - Qiita
• ちゃんと接続完了まで待ちたいなら、mysqlコマンドなどでなんとかする必要がある
• そもそもrunで実行するコマンドにretry機能があればそれで十分説
  • 無限にretryされたらそれはそれで困るのでよしなに
  • wgetやcurlだと--retry-connrefusedという引数があって、コンテナが立ち上がるまで頑張れる

dockerコマンドをstep中でで使いたい場合はsetup_remote_dockerを呼ぶ

• Docker コマンドの実行手順 - CircleCI
  • docker-composeを使いたい場合は、上記の手順でdockerコマンドが使えるようにした上でdocker-composeコマンドを入れる
  • Installing and Using docker-compose - CircleCI
• port forwardingとvolume mountに制限がある

Using docker combined with setup_remote_docker provides a remote engine similar to the one created with docker-machine, but volume mounting and port forwarding do not work the same way in this setup.
Installing and Using docker-compose >Using docker compose with docker executor - CircleCI

• これをなんとかするにはpureにdockerが走るMachine executorを使うしかない。
  • CircleCI 2.0 で docker-compose を動かすなら、Machine Executor にしないとハマる - Qiita
  • CircleCI上でDockerとファイルをうまくやりとりする - Qiita
• remote dockerでつながる先のスペックは固定
  • CircleCIでLayer Cachingを使わずにdocker buildを高速化する
  • Running Docker Commands - CircleCI > Specifications
    • 2コア 8GB RAM

Machine executorについて

• CircleCI を設定する>machine - CircleCI
• Ubuntuの VMがあがってくる。
• 追加費用発生の示唆がある。

Use of the machine key may require additional fees in a future pricing update.
Installing and Using docker-compose > Using docker compose with machine executor- CircleCI

MySQLコンテナについて

• cimg/mysql https://hub.docker.com/r/cimg/mysql/tags
  • GitHub - CircleCI-Public/cimg-mysql: The CircleCI MySQL Docker Convenience Image.
• circleci/mysql https://hub.docker.com/r/circleci/mysql/tags
  • circleci-dockerfiles/mysql at master · CircleCI-Public/circleci-dockerfiles · GitHub
• DBストレージを/dev/shmに置く-ramがcimgでは現状ない
  • いらんのでは？という話になっている模様
  • cf. https://github.com/CircleCI-Public/cimg-mysql#ram
• 初期設定について
  • DBの作成は環境変数MYSQL_DATABASEで指定
  • encodingやcollationはcommandで引数に指定すれば制御できる
  • MySQLコンテナ標準のやり方で中身を入れようとすると、コンテナ起動時に/docker-entrypoint-initdb.d/をvolume mountする必要がある。
    • これはDocker executorだとどうしようもなく、Machine executorにするしかない。
  • Docker executorでなんとかするなら、SQLを実行してデータを投入するなにかをshell scriptとか何かで作って叩くことになる。

おわりに

corp.moneyforward.com
kyoto.moneyforward.com

それでは、鴨川🦆でお待ちしています。

三条大橋

*1:実際晴れた週末は結構な頻度で鴨川🦆河川敷に行って一日ひなたぼっこしてるので反論の余地が一切ない。

*2:緊急事態宣言がないとき。

*3:今まで触ったことあるCIツールはCloud Buildぐらい。