はじめに
チーム内で、Ansible の公式ドキュメントの見方についての話になったときに、よく参照するドキュメントはどこかという話に発展しました。
5つ紹介します。対象プラットフォームに限定しないものを取り上げています。
1. 各モジュールの説明ページ
おそらく多くの方も同じだと思います。
例えば ansible.builtin.debug
モジュールであれば以下のページです。
何をするモジュールか、どんなオプションがあってどんな値を指定できるか、使用例などが掲載されています。
私は初見のモジュールの場合は、まず例(Examples
)を見て雰囲気を掴んでから、各オプションの説明を読む、という流れが多いです。
2. Using filters to manipulate data
フィルターの説明ページです。
使い慣れているフィルターならいいのですが、たまに使うフィルターだと使い方を覚えていないのでここを起点に調べています。
あとは適当に眺めてると「こんなのがあったのか!」という発見もあります。
必要に応じてJinja2のドキュメントも参照します。
3. Ansible Configuration Settings
ansible.cfg
や環境変数などで設定できる設定項目の一覧です。
例えば INTERPRETER_PYTHON
であれば以下の箇所です。
ini
というのが ansible.cfg
だと高設定するよという意味です。INTERPRETER_PYTHON
であれば、section
が [defaults]
なので、以下のように指定します。
[defaults] interpreter_python=ここに設定値を指定
ansible.cfg
で指定する場合、環境変数で指定する場合、変数で指定する場合、それぞれ名前が異なるので注意です。
これもやっぱり、眺めてると新しい発見があります。
4. Playbook Keywords
PlayやTask などの単位で、どういうキーワードを指定できるかの一覧です。
たとえば、Taskに、become
があるのであれば、以下のような指定ができるということが分かります。
# ...(略)... tasks: - name: yum ansible.builtin.yum: name: git become: true # タスク単位でも指定可
5. Special Variables
予約変数の一覧です。
ansible_
で始まるもの以外にもいろいろあることが分かります。
groups
なんて、つい独自定義で使ってしまいそうですが・・