てくなべ (tekunabe)

ansible / network / automation / StackStorm

【Ansible】公式ドキュメントの対応バージョンの確認と切り替え方法

■ はじめに

Ansible の調べ物をしていて、モジュールの説明ページなどを見るときは、そのドキュメントの対応バージョンを気にするようにしています。 使っている Ansible バージョンでそのモジュールが使えるかどうか、など。 この記事では、対応バージョンの確認方法と、バージョンの切り替え方法を説明します。


■ 対応バージョンの確認方法

f:id:akira6592:20180809102127p:plain

ドキュメントの左上に 2.6 などと、対応バージョンが書いてあります。

devel と書いある場合は、今でいうと開発中の 2.7 のことです。(10月リリース予定

もし、諸事情で開発中のバージョンを使いたいときは、

pip install git+https://github.com/ansible/ansible.git@devel

でインストールできます。


■ 対応バージョンの切り替え方法

その1: トップページから切り替える方法

ドキュメントトップのメニューの Previous Version からバージョンを切り替えることができます。

その2: URLを書き換えて切り替える方法

例えば、

https://docs.ansible.com/ansible/latest/modules/ios_command_module.html

というURLの場合、 latest のところを書き換えると、バージョンを切り替える事ができます。

  • 指定例(2018/8/9現在)
    • devel: 2.7
    • latest: 2.6
    • 2.6: 2.6
    • 2.5: 2.5

モジュール説明ページのURLを書き換えた結果、 Not Found になるのであれば、そのバージョンにはそのモジュールが無いということになります。 (ページ内に書いてある New in version 2.7. といった記載で判断するのが手っ取り早いです)

例えば、

https://docs.ansible.com/ansible/devel/modules/vmware_deploy_ovf_module.html

devel (2.7) を latest (2.6) に書き換えて、

https://docs.ansible.com/ansible/latest/modules/vmware_deploy_ovf_module.html

を表示したときに、Not Found になるのは、 2.6 にそのモジュールがないためです。

注意点

Ansible 2.4 から 2.5 になったタイミングで、ドキュメントの階層が変わりました。 そのため、これらのバージョンをまたいで切り替えるときは注意が必要です。