0Pricing
Ansible Academy · レッスン

規模に対応できる命名・コメント・スタイル

プロジェクトの可読性を保つ規約を学びます。

「規模に対応できる命名・コメント・スタイル」はCoddyKit上の無料Ansible Academyレッスンです。 これはレッスン4/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはAnsible Academy学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Ansible Academyコースには全4レッスンが含まれています。

スタイルは必須です

Playbookは、書くよりもはるかに多く読まれます。一貫した命名とスタイルによって、個人用スクリプトをチームで使える自動化に変えられます。✨

タスクには必ず名前を付ける

すべてのタスクに明確なnameを付けてください。名前付きのタスクは実行結果を読みやすくし、意図を一目でチームメンバーに伝えます。

- name: Install the nginx web server
  package:
    name: nginx
    state: present

名前はアクションとして書く

nginxをインストールやデプロイ用ユーザーを作成のように、名前は明確なアクションとして表現してください。playの実行時にチェックリストのように読めます。

ネイティブモジュールを優先する

shellモジュールやcommandモジュールよりも、実際のmoduleを優先して使ってください。モジュールは冪等性があり、処理内容も自己説明的ですが、生のコマンドにはその性質がありません。

key=valueではなくYAMLを使う

モジュールの引数は、すべてを1行のインライン文字列に詰め込むのではなく、1行に1つのキーを置く明確なYAMLブロック形式で記述してください。

- name: Ensure dir exists
  file:
    path: /opt/app
    state: directory

コメントでは理由を説明する

# commentは何をするかではなく、なぜそうするのかを説明するために使ってください。何をするかはタスク名がすでに示しているため、コメントには理由や注意点を記録します。

# Pin version: 1.20 broke our TLS config
- name: Install nginx 1.18
  package:
    name: nginx=1.18*

一貫した変数名

変数名にはlower snake_caseを使い、名前の衝突を避けるため、roleの変数にはrole名を接頭辞として付けてください。たとえばnginx_portのようにします。

迷ったら引用符で囲む

{{で始まる値や、数値またはブール値として解釈される可能性がある値は、すべて引用符で囲んでください。YAMLが型を誤って推測するのを防げます。

msg: "{{ greeting }}"
version: "1.10"

2スペースのインデント

階層ごとに2スペースを使い、タブは決して使わないでください。YAMLは空白に依存するため、インデントが混在すると解析に失敗します。

ansible-lintに適用させる

ansible-lintを実行して、スタイルやベストプラクティスに関する問題を自動的に検出してください。規約の確認はツールに任せ、レビューではロジックに集中します。

ansible-lint site.yml

小さく、目的を絞ったファイル

各ファイルの役割は1つに絞ってください。短く適切な名前のタスクファイルは、巨大なファイルよりもテスト、再利用、理解が容易です。🎯

クイックチェック

すべてのタスクにnameを追加する主な理由は何でしょうか。

まとめ

すべてのタスクに名前を付け、shellよりもモジュールを優先し、明確なYAMLを記述し、「なぜ」をコメントに残し、ansible-lintにスタイルを適用させる方法を学びました。✅

よくある質問

「規模に対応できる命名・コメント・スタイル」レッスンは無料ですか？

はい。「規模に対応できる命名・コメント・スタイル」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Ansible Academyコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Ansible Academyコースには全4レッスンが含まれています。

「規模に対応できる命名・コメント・スタイル」で何を学びますか？

プロジェクトの可読性を保つ規約を学びます。 ブラウザで直接実行するハンズオンコードでAnsible Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Ansible Academyを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのAnsible Academyは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン4/4です。

「規模に対応できる命名・コメント・スタイル」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このAnsible Academyレッスンでコードを書いて実行できますか？

はい。すべてのAnsible Academyレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

  1. 推奨ディレクトリ構成
  2. group_vars & host_vars ディレクトリ
  3. import & include による Playbook の分割
  4. 規模に対応できる命名・コメント・スタイル
← Ansible Academyに戻る