てくなべ (tekunabe)

ansible / network automation / 学習メモ

[Ansible] docs や expamles がリポジトリ移行。WinRM セットアップスクリプトがリンク切れに

はじめに

Ansible の コミュニティドキュメントを、リポジトリansible/ansible から分けて ansible-documentation に移す動きが進んでいます。

この記事では、これまでの経緯や今のところ分かっている影響をまとめます。

経緯

分かっている範囲では、発端はこのあたりです。

github.com

stable-2.15 ブランチへのバックポートも出されています。

事前通知

7/9 発行のニュースレター The Bullhorn でも事前にお知らせが出ていました。

us19.campaign-archive.com

As you may recall from last week’s Bullhorn, we’re making Ansible community documentation a separate project to ansible/ansible.

On Monday, July 10, 2023, all RST source for Ansible community documentation will move from ansible/docs/docsite to the ansible/ansible-documentation repository. If you want to find out more or have any concerns, come let us know in the docs channel on Matrix.

ansible/ansible から docsexamples ディレクトリの削除

そしていよいよ本日 7/12 、devel ブランチの docsexamples ディレクトリが削除されました。

github.com

影響は?

docs.ansible.com は普通に見えているっぽい

ドキュメントのビルドプロセスと整合性とりながら進めているおかげか、docs.ansible.com のページを閲覧する分には、現状特に影響は見当たりませんでした。ドキュメントの修正や追加などはるときは ansible/ansible-documentationへ、というくらいかと思います。

WinRM セットアップスクリプトがリンク切れ(devel ブランチ)

一方影響があるのがこちら。

Ansible から Windows を操作する準備として、Windows 側で WinRM の有効化などをするスクリプトとして

https://raw.githubusercontent.com/ansible/ansible/devel/examples/scripts/ConfigureRemotingForAnsible.ps1

を利用している場合、これがリンク切れになりました。前述の通り ansible/ansibledevel ブランチの examples ディレクトリが削除されたためです。

上記の .ps1 ファイルの URL は、ansible-core 2.12 までのドキュメントの Setting up a Windows Host というページ内にありました。そのためこの URL を使用しているケースはそこそこあるかもしれません。

もともとトレーニングや開発環境向けでしたが、PR #77931.ps1 ファイルのURLの記述は削除されました。

以前のブランチ、タグ(例 stable-2.12)にはあります。また、移行先のリポジトリにもあります。

https://raw.githubusercontent.com/ansible/ansible-documentation/devel/examples/scripts/ConfigureRemotingForAnsible.ps1

対処方法については、以下のコメントでも紹介されています。

github.com

おわりに

すでに PR に影響についてコメントが複数あり、今後何かしらの状況が変わるかもしれません。