てくなべ

ansible / network automation / 学習メモ / 思考メモ

[Ansible] コーディングルール類の参考になる Good Practices for Ansible

はじめに

Ansible の Playbook は、同じ処理でもいろんな書き方ができます。タスクの name にしても、書かなくても動くことは動きます。

自分一人で書く分にはそんなに問題になりませんが、チームで開発する場合は、コーディングルールがほしいよね、という話になることが多いと思います。

とはいえ、一からコーディングルールを作成するのもなかなか大変です。

ありがたいことに Red Hat の CoP (Community of Practice) 主導によるコーディングルール類をまとめたものが公開されているのでご紹介します。

redhat-cop.github.io

Good Practices for Ansible の各章の概要

Good Practices for Ansible は、現在(2026/07/23)8つの章に分かれています。

いきなり全部読むのは大変なので、各章の概要だけまとめます。また独断ですが、(コレクション開発者ではなく)Playbook やロールを作成する人にとっての重要度を ★ ~ ★★★ でつけてみます。

章 概要 重要度 補足
1. Introduction このドキュメント自体の説明 ★
2. Automation structures 自動化処理の構成要素 ★
3. Roles Good Practices for Ansible ロール作成時のお作法。タスクレベルのお作法もここ ★★★
4. Collections good practices コレクション作成時のお作法 ★ コレクション開発者向け
5. Playbooks good practices Playbook 作成時のお作法。文法やタスクのレベルは基本含まれない ★★★
6. Inventories and Variables Good Practices for Ansible インベントリと変数のお作法 ★★
7. Plugins good practices プラグイン作成時のお作法(Pythonレベル含む) ★ コレクション開発者向け
8. Coding Style Good Practices for Ansible 文法レベルの細かいお作法 ★★★

ざっくり、4 と7 はコレクション開発者向けなのでPlaybook 類の作成者としてはスキップでよくて、逆に 3、5、8、それから 6 は重要に感じました。

なお、全編英語なので、たとえば「コメントは日本語で書くこと」のようなローカルルールが必要な場合もあります。

随時更新されていく

Good Practices for Ansible は、以下のリポジトリで管理されています。必要に応じてプルリクなどを出すのもよいかもしれません。

github.com

ドキュメントは生き物のようなもので、更新され続けています。例えば最近では、 EE(Execution Environment: 実行環境)の定義ファイルの書き方について追加するプルリクがありました。

github.com

やや余談

「ベストプラクティス」ではない

Good Practices for Ansible は「Best Practices」ではなく「Good Practices」です。1. Introduction には、以下の記述があります。唯一絶対の正解ではない、という趣旨です。

Those are opinionated guidelines based on the experience of many people. They are not meant to be followed blindly if they don’t fit the reader’s specific use case, organization or needs; there is a reason why they are called good and not best practices.

また、もう6年くらい前のことですが、Ansible 2.9 のころは公式ドキュメントに「Best Practices」というページがありました。その後、タイトルは「Tips and tricks」になり、現在は「General tips」になっています。

こうして眺めてみると、ベストプラクティスという言葉はあまり使われなくなっている印象があります。

もっとおおざっぱな「The Zen of Ansible」

大原則を示す「The Zen of Ansible」というものもあります。

www.redhat.com

抽象的ですが、何かに迷ったときの判断軸として利用できるかもしれません。

Community of Practice という言葉

Community of Practice という言葉、日本ではあまりなじみがないですかね・・?日本語でなんて言えばいいか迷います。

「実践コミュニティ」「実践共同体」あたりなのでしょうか。

初めてこの言葉を知ったのは、そのままのタイトル「コミュニティ・オブ・プラクティス」という本を10年前に読んだ時でした。

おわりに

コーディングルール類の参考になる、Good Practices for Ansibleをご紹介しました。

前述のとおり、ベストプラクティスではありませんが、迷ったときのとっかかりとしてはとても有用かなと思います。