Ansible モジュール作成・配布・貢献

1. Ansible モジュール作成・配布・貢献八重樫剛史 GitHub: @yaegashi Twitter: @hogegashi

2. 自己紹介八重樫剛史 (YAEGASHI Takeshi) - Twitter @hogegashi - GitHub @yaegashi Ansible を個人的に使用しています Python の腕前は素人に毛がはえた程度です

3. 今日の話題 Ansible モジュールの紹介: blockinfile Ansible モジュールの作成と配布のノウハウ・ベストプラクティス Ansible アップストリーム (本家) への貢献の道 yaegashi 自身の経験をもとにお話しますスライドを作りすぎましたが全部発表しますスライドは後ほど公開します

4. blockinfile モジュールの紹介

5. blockinfile モジュールの紹介テキストファイルに複数行のブロックを挿入・更新・削除するモジュール名前は標準モジュール lineinfile からの連想 Ansible にはなぜか複数行のテキストを扱うモジュールがないので作った - lineinfile は 1 行しか挿入・更新・削除できない - ansible-project などで相談すると、だいたい template や assemble を使うことを勧められるが、そういうのを使わず既存ファイルを修正したいときもある

6. blockinfile 利用例 apache2 の設定ファイルに <Location> ブロックを挿入するタスク - name: insert <Location> block in apache2 config blockinfile: dest: /etc/apache2/sites-available/default.conf insertbefore: </VirtualHost> block: | <Location /app> ProxyPass http://127.0.0.1:8000 ProxyPassReverse http://127.0.0.1:8000 </Location>

7. /etc/apache2/sites-available/default.conf (before) blockinfile 利用例 <VirtualHost *:80> <Directory ...> </Directory> </VirtualHost> - name: insert <Location> block in apache2 … blockinfile: dest: /etc/apache2/sites-available/… insertbefore: </VirtualHost> block: | <Location /app> ProxyPass http://localhost:8080 ProxyPassReverse http://localhost:8080 </Location>

8. /etc/apache2/sites-available/default.conf (after) <VirtualHost *:80> <Directory ...> </Directory> # BEGIN ANSIBLE MANAGED BLOCK <Location /app> ProxyPass http://localhost:8080 ProxyPassReverse http://localhost:8080 </Location> # END ANSIBLE MANAGED BLOCK </VirtualHost> blockinfile 利用例 blockinfile に追加されたマーカー (変更可)

9. blockinfile モジュールまとめ簡単にセットアップできて便利なのでみなさんぜひ使ってください GitHub: ansible-role-blockinfile Ansible Galaxy: blockinfile 関連ブログポスト: - http://blog.keshi.org/hogememo/2014/08/24/ansible-blockinfile-module - http://blog.keshi.org/hogememo/2015/04/26/ansible-blockinfile-v0-3

10. Ansible モジュール開発のノウハウ

11. Ansible モジュール開発のノウハウ時間が足りないので省略ユニットテストやドキュメントの自動生成などネタはあるが、またの機会に… 最初は似た機能の標準モジュールを真似するところから始めるのが良いと思う blockinfile モジュールも lineinfile や replace からのコピペで作りました

12. Ansible モジュール配布のノウハウ (今日の本題 1)

13. Ansible モジュール配布のノウハウモジュールはロールの形にして GitHub で公開しましょう

14. モジュールをロールに格納する http://github.com/yaegashi/ansible-role-blockinfile の構造 - ├─/ansible-role-blockinfile ├─/library │ └─blockinfile.py ├─/meta │ └─default.yml ├─/tasks (なし) ├─/tests └─README.md /library がロール実行時にモジュール検索パスに追加されるひとつのロールに複数のモジュールを収録できる /meta/default.yml の中でロール依存関係の記述も可能モジュールのユニットテストも入れておくとよいロールおよびモジュールのドキュメントロールはタスクを含んでいる必要はない

15. Ansible Galaxy にロールを登録ユーザによるレビュー・評価を受けられる GitHub がバックエンド - Issue Tracker でバグ報告をしてもらえる - パッチをプルリクエストしてもらえる yaegashi.blockinfile ロール https://galaxy.ansible.com/list#/roles/1475

16. Ansible Galaxy にロールを登録 Ansible Galaxy で公開したロールはインストールやアップデートが簡単！！ $ ansible-galaxy install yaegashi.blockinfile

17. Ansible Galaxy 登録ロールからのモジュール利用 blockinfile モジュールを利用するプレイブック一式のディレクトリ構成 ├─/roles │ ├─/yaegashi.blockinfile │ ├─/library │ │ └─blockinfile.py │ └─/meta │ └─default.yml ├─/library │ └─othermodule.py ├─playbook1.yml ├─playbook2.yml ansible-galaxy でインストールした yaegashi.blockinfile ロール

18. Ansible Galaxy 登録ロールからのモジュール利用 blockinfile モジュールを利用するプレイブックの構成 --- - hosts: all roles: - yaegashi.blockinfile - role1 - role2 tasks: - shell: ... - blockinfile: ... yaegashi.blockinfile ロールを最初に呼び出す yaegashi.blockinfile ロールのモジュールは別のロールからも呼び出せるプレイブックのタスクでもモジュールが使用できる

19. Ansible モジュール貢献のノウハウ (今日の本題 2)

20. Ansible モジュール貢献のノウハウ自作の Ansible モジュールが好評！ Ansible アップストリーム (本家) にモジュールをコントリビュート (寄贈) しよう！

21. モジュール追加のプルリクエストを GitHub の ansible-modules-extras に出す Ansible 新規モジュールプルリクエスト ansible-modules-extras とは？ - Ansible の新規モジュールが追加される登竜門リポジトリ - これに収録されたモジュールは Ansible のリリースと一緒に配布される - 重要度の高いモジュールは ansible-modules-core に昇格することもある

22. Ansible 新規モジュールチェックリスト Module Checklist をよく読んでモジュールを仕上げましょう Module Checklist の主な内容ライセンス: GPL version 3 最初の Python コメントに明記することドキュメント: - required: は全パラメータに設定必須 - default: は required: false なら必須、そうでなければ不要 - author: に作者名と GitHub アカウント名を明記すること - U() C() I() M() などのテキスト修飾を適切に使うこと - などなどコード: - いかなる例外も出さないこと例外出したらそれはバグ - エラーは sys.exit() で終了しない代わりに fail_json() を使うこと - from ansible.module_utils.basic import * は最後に書くこと - などなど

23. Ansible 新規モジュール承認基準 (2015/05) Travis CI による自動ビルドチェックが成功する - Python 2.4 で動かないモジュールは失敗する (PEP 308 使ってるなど) Module Checklist に適合している既存モジュール作者 (148名) によるレビューと推薦 - 2 人以上からの +1 があり、 -1 がないこと - 既存モジュール作者が提出するモジュールは自薦の +1 を含めてよい (マージ後) モジュールの作者がメンテナとしてバグ報告などに対処できること

24. Ansible 新規モジュールプルリクエスト実例と経過 (今日の本題 3)

25. Ansible 新規モジュールプルリクエスト実例と経過 ansible-modules-extras に 2 つのプルリクエストを出しているのだが… - Aug 14: #832 New module: blockinfile - Sep 11: #958 New modules: openvz, openvz_exec コメント数 0 誰もレビューしてくれない (T_T)

26. Ansible 新規モジュールプルリクエスト実例と経過 Google Groups の ansible-devel で愚痴ったのだが… スレッドに自分以外の投稿なし誰も反応してくれない (T_T)

27. Ansible 新規モジュールプルリクエスト実例と経過そこに Ansible Community Guy を名乗る男からメールが！

28. Ansible 新規モジュール承認プロセスの現状 Greg DeKoenigsberg 曰く - 率直にいって現在の新規モジュール承認プロセスはあまりうまくいってない - 手続きが煩雑すぎる - レビュアーに対する動機付けが弱い - レビュアーを既存モジュール作者に限定したのは間違いだったかもしれない

29. Ansible 新規モジュール承認プロセスの改革 Greg DeKoenigsberg 曰く - 新規モジュール承認プロセスの修正を検討している - 既存モジュール作者にレビュアーを限定しない予定である新規モジュール承認基準の要点 - 誰かが検査・レビューすること - 誰かが実際に自分の環境でテストすること - モジュール作者がマージ後もメンテナンスすること - ユニットテストがあること (core モジュールのみ)

30. Ansible 新規モジュール承認プロセスの感想 yaegashi の感想 - 増え続けるモジュールを core と extras に分離し、 extras モジュールのレビューとメンテナンスをコミュニティに任せようとする方針は正しい - しかしながら、現時点ではコミュニティメンバーが他人の作ったモジュールのレビューを行う動機付けに乏しい - 既存モジュール作者にコネがなければレビューもしてもらえないのではないか - 自分の専門外の分野のモジュールのレビューはできないのではないか - 他の上手くいっているプロジェクトから学ぶことはないだろうか - Linux カーネルとか… 規模が違いすぎる？

31. 新規モジュールコントリビュート完遂の道のりは険しい - 現時点ではコネがない限り、新規モジュールのマージは難しそう - Ansible, Inc. でも現状を問題に感じており、改革をしようとしている - しばらくプルリクエストの放置プレイが続きそうだが、気長に待ちましょう - 新規ユーザ獲得の努力、コネを作る努力は地道にしておきましょう Ansible 新規モジュール承認プロセスまとめ

32. まとめ

33. blockinfile モジュールの紹介 Ansible モジュール配布のノウハウ・ベストプラクティス Ansible モジュール寄贈の概要・実例 Ansible 新規モジュール承認プロセスの今後まとめ

Ansible モジュール 作成・配布・貢献

yaegashi