Ansibleのコードレビューしようとした時に調べても、あまり記事が見つからず悩んでいる人がいると思います。
こちらの記事ではAnsibleのコードレビューをするときに必要な確認項目について書いています。
実際に自分が仕事でAnsibleを書く時や、コードレビューをするときにこちらを参考にしています。
コードレビューの確認項目
確認した項目をざっくり分けますと以下4つになります
- モジュールを使用をしているか？
- roleを正しく分割しているか？
- ディレクトリ構成を正しくしているか
- 各環境の設定はyamlファイルだけで行われているか？
各項目についてそれぞれ説明していきます
モジュールを使用をしているか？
モジュールを使用する理由として、Ansibleは手続き的に処理を書いていくのではなく、最終的な状態を宣言的に書いていくことを目的にしているため。
そうすることで冪等性が担保される。
Roleを正しく分割しているか？
Roleは基本的に機能単位で作成し、それによって別のプロジェクトで再利用したり、共有することができるためRoleを分割正しく分割しておく必要がある。
ディレクトリ構成が正しいか？
Ansibleのディレクトリ構成については以下のURLを参考にする
特にtemplatesとfilesは間違えやすいので注意する
ベストプラクティス — Ansible Documentation
docs.ansible.com
各環境の設定はyamlファイルだけで行われているか？
各環境の設定はyamlファイルでのみ管理する。
nginx、mysqlなどの設定ファイルは環境ごとには作成せずに、Jinja2テンプレートファイルをtemplatesディレクトリ配下に作成して、yamlで宣言した変数を埋め込むようにする。
まとめ
Ansibleのコードレビュー項目について説明をしてきました。
項目数は少ないですが、確認項目を守ってAnsibleをコーディングするのが大変です。
それでも確認項目を守ってコーディングことで保守しやすくなるので頑張っていいただけたらと思います。
Ansible以外にも、Linuxで使用頻度の高いコマンドや、Go言語の記事について書いていますので、興味がありましたら、そちらも見てもらえたらと思います。
【おすすめ記事のリンク】
コメント