たそ@ITインフラ初心者

taso@初心者エンジニア

新卒2年目 エンジニアが適当に語るブログてす

Collectionのバージョンに対応したドキュメントを確認する方法

はじめに

お疲れ様です。 こんにちは たそ(taso_int)です。 お久しぶりです。
最近ブログのモチベがあまり上がらず… リハビリがてらブログを書いていきます。

今日はあまり技術的な内容ではないですが、書いていきます。

AnsibleのCollectionsのバージョンに対応したドキュメントの探し方について書きます。
ただし、Collectionsの説明については省略します。

Collectionsのバージョンが上がると各moduleに新しいオプションが追加される場合があります。 どのバージョンからオプションが対応しているか分からないケースがあり、それを確認するために利用しているバージョンのドキュメントを確認する必要があります。

そもそも特段の理由がない限りは最新をインストールすることをお勧めします。

結論

結論としては、最新であればAnsibleのドキュメントにあるCollection index(https://docs.ansible.com/ansible/latest/collections/index.html)から、過去のバージョンであれば、Automation hub(https://console.redhat.com/ansible/automation-hub)から確認すると良いです。

Automation hubの方はRed Hatのアカウントが必要になります。

試してみる

Azureのリソースを動かすときに使うazure.azcollection(https://github.com/ansible-collections/azure)のazure_rm_virtualmachine moduleを例にして確認したいと思います。

現在(2023/05/28)ではazure.azcollectionの最新バージョンは1.15.0です。

最新バージョンのドキュメント

Collection indexからazure.azcollectionをクリックし、対象のモジュールをクリックすることで最新のドキュメントを確認できます。

メモにも"This module is part of the azure.azcollection collection (version 1.15.0)."と記載されており、1.15.0であることが分かります。

恐らくですが、URLの文字列にあるlatestをAnsibleのバージョン(7など)に変えることでAnsibeのリリース時点でのCollectionの最新を見ることが出来ます。

Ansibeのバージョン4時点での最新のCollectionを見たければこのURL(https://docs.ansible.com/ansible/4/collections/azure/azcollection)のような書き方で確認出来ると思います。

過去バージョンのドキュメント

azure.azcollectionのバージョン1.12.0のazure_rm_virtualmachine moduleを確認したいと思います。

Automation Hubにアクセスして、Collectionsからazcollectionを探してクリックします。

トップ画面にバージョンの指定があるので、1.12.0を選択します。 そしてドキュメントからazure_rm_virtualmachineを選択して確認することが出来ます。

最後に

以上の手順でCollectionのバージョンに対応したドキュメントを確認することが出来ます。 ドキュメント以外でオプションが対応してるかを確かめる方法として考えられるのはソースコードを確認するとかですかね。 短いですが、読んでいただきありがとうございました。