Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Ansibleを通じて「べき等性」を 理解してみよう / Try understanding idempotency by Ansible

attakei
September 17, 2019
Programming
1
850

Ansibleを通じて「べき等性」を 理解してみよう / Try understanding idempotency by Ansible

2019/9/17 に開催された、PyCon JP 2019で発表した内容のPDF版の資料です。
Reveal.js製のスライドのため、オリジナルは以下のURLとなっています。

https://attakei.net/slides/pyconjp-2019/

attakei

September 17, 2019
Tweet

More Decks by attakei

See All by attakei
Sphinxを通して考える、「拡張」の仕方 / First approach for development sphinx extension
attakei
0
3.1k
PyPIデビュー手前の人のための地下活動手法 -PyPICloudを使ったプライベートレジストリの構築- / Using PyPICloud as private registry for pre-debut to PyPI
attakei
1
300
「〇〇のプラグインを作る」ことのすゝめ / Let's develop plugins
attakei
0
820
プレゼン？それもSphinxで出来るよ -ドキュメントツールSphinxのちょっと変わった利用法- / You can presentation too by Sphinx!
attakei
0
580
Cloud RunとFastAPIで、ChatBotをミニマムスタートしよう / Getting start ChatBot with FastAPI and Cloud RUN
attakei
0
2.4k
Web制作において、プレビューにあえてCloudRun(とFirebase)を使う / Using Cloud Run (and Firebase) as preview environment of HTML in web development
attakei
0
840
素材の良さを活かしつつ、reST をReveal.jsに変換してみる話 / Converting pure reST to Revealjs
attakei
0
200
Eelで作ってみる WHOISアプリと スライド
attakei
0
760
Errbotで得られる、ChatOps入門
attakei
0
1.1k

Other Decks in Programming

See All in Programming
Jetpack Compose の Side-effect を使いこなす / DroidKaigi 2023
star_zero
1
680
Rich UI implementation examples using Jetpack Compose (Jetpack Composeを活用した強力なUI表現の実装実例)
iimokoy
0
890
わかる！Hashicorp Waypoint | HashiTalks: Japan2023
kazue
0
280
第6回 AWSとGitHub勉強会 - AWS ECS Fargate環境の構築 -
ogiwarat
0
130
締切とはなにか、どういう効果があるのか #scrummikawa
murabayashi
0
290
PHP8.2にバージョンアップして もっと型表現を豊かにしよう
akitotsukahara
0
160
スキル差があるペア_モブプロで効果的な_ドライバーナビゲータ以外のロールの分け方.pdf
yatasunshine
1
150
Chatwork プロダクト本部 紹介資料（エンジニア向け）
chatwork_hr
1
540
Precondition with schema directives
quramy
0
260
RAILS_ENVを統合する取り組み: 開発用デプロイ環境をよりシンプルに
akarin
2
700
Maintaining E2E Test Automation as We Transition from View to Compose
tkhs0604
0
510
作って学ぶadbプロトコル / Create and learn adb protocols
ntsk
0
850

Featured

See All Featured
Designing for Performance
lara
601
66k
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
33
8.6k
Why Our Code Smells
bkeepers
PRO
329
56k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
24
1.9k
Creatively Recalculating Your Daily Design Routine
revolveconf
208
11k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
10
1.2k
Code Review Best Practice
trishagee
53
13k
A Tale of Four Properties
chriscoyier
150
21k
Principles of Awesome APIs and How to Build Them.
keavy
119
16k
Debugging Ruby Performance
tmm1
68
11k
Support Driven Design
roundedbygravity
91
9.2k
Art Directing for the Web. Five minutes with CSS Template Areas
malarkey
197
11k

Transcript

  1. Ansibleを通じて「べき等性」を
    理解してみよう
    date:
    2019-09-17
    author:
    Kazuya Takei
    location:
    PyCon JP 2019

    View Slide

  2. イントロ

    View Slide

  3. Who am I?
    Name: Kazuya Takei
    Social: @attakei
    NIJIBOX Co., Ltd.
    インフラ領域
    Ansible
    GitLab
    アーキテクト
    CIパイプライン啓蒙
    Firebase啓蒙
    そこまでガッツリはPython触
    ってない
    Twitter
    GitHub
    GitLab

    View Slide

  4. Who am I?
    Name: Kazuya Takei
    Social: @attakei
    As pythonista
    小さいライブラリ志向
    Ansibleモジュール/ロー
    ル
    sphinx-revealjs
    Errbotプラグイ
    ン/Errcron
    Errbotコアへのコントリビュ
    ートとか
    Twitter
    GitHub
    GitLab

    View Slide

  5. 話すこと(目標)
    冪等性の概要
    あっさり
    Ansibleについて
    前置き
    Ansibleはどうやって「冪等性」を担保しているか
    メイン予定

    View Slide

  6. 冪等性の概要
    ※超概要です

    View Slide

  7. 「冪等性」とは
    冪等 = べきとう
    ある操作を何度実施しても、同じ結果になる性質を持つこと。
    f(x) = f(f(x)) = f(f(f(x))) ...

    View Slide

  8. 「冪等性」の例
    >>> def add_zero(x):
    >>> return x + 0
    >>>
    >>> x = 2019
    >>> x = add_zero(x)
    >>> x
    2019
    >>> x = add_zero(x)
    >>> x
    2019
    >>> add_zero(add_zero(add_zero(add_zero(x))))
    2019

    View Slide

  9. 「冪等性」の例
    >>> def multi_one(x):
    >>> return x * 1
    >>>
    >>> x = 2019
    >>> x = multi_one(x)
    >>> x
    2019
    >>> x = multi_one(x)
    >>> x
    2019
    >>> multi_one(multi_one(multi_one(multi_one(x))))
    2019

    View Slide

  10. Ansibleについて

    View Slide

  11. Ansibleとは
    Python製の「構成管理ツール」
    「動作」ではなく「状態」を定義して適用する
    主にサーバーのセットアップなどに使われる
    etc
    クライアントPC
    ネットワーク機器
    クラウドサービス

    View Slide

  12. コミュニティあります
    サイト:
    Connpass:
    Slack:
    https://ansiblejp.github.io/
    https://ansible-users.connpass.com/
    https://bit.ly/ansiblejp-slack

    View Slide

  13. Ansibleの動き(概要)

    View Slide

  14. Ansibleの動き(中身)
    インベントリファイル
    処理実行先のサーバー一覧や簡単な情報を定義
    [local]
    localhost ansible_connection=local

    View Slide

  15. Ansibleの動き(中身)
    Playbook
    # ------------------
    # RedHat系OSのマシンで、Apacheを使えるようにするPlaybook
    # ------------------
    - hosts: local
    # sudoが必要なケースではbecomeを指定する
    become: yes
    tasks:
    # 1個ずつ「モジュール」を指定する
    - yum:
    # nameでパッケージ名を指定
    name: httpd

    View Slide

  16. Ansibleの動き(中身)
    Playbook
    実際にAnsibleが操作したい状態を定義したもの
    動作ではなく状態
    「httpdをインストールする」という動作ではない
    「httpdをインストールされていること」という状態

    View Slide

  17. 処理の流れ
    Playbookに定義された状態になるように、各モジュールがよしな
    に処理する
    処理の結果、「状態に変化があったか」の報告を受ける。
    変化があれば changed
    変化がなければ ok
    同じPlaybookを実行すると、2回め以降は状態に変化がないのでOKと
    しかでない
    = ある操作を何度実施しても、同じ結果になる
    = 冪等性がある

    View Slide

  18. Ansibleが担保する冪等性
    定義された 「状態に対する冪等性」 を担保するように設計されている
    ※ログ出力があるので、マシン全体の冪等性は無理

    View Slide

  19. Ansibleはどうやって、冪等性を
    担保するか？(1)

    View Slide

  20. pip モジュール
    pip コマンド経由で、Pythonパッケージの状態を管理するモジュ
    ール
    virtualenv の指定や作成もできる
    extra_args 経由で全部のオプションを指定可能
    - hosts: local
    tasks:
    pip:
    name: django
    executable: pip3
    extra_args: --user

    View Slide

  21. モジュールの全体像

    View Slide

  22. モジュールの全体像
    全771行!
    前半の約半分はドキュメント
    残りのソースには、処理に必要な全内容がコードで書かれがち
    そのため、モジュールのソースは長めにになる傾向が強い
    ※GitHubより

    View Slide

  23. モジュールの全体像
    大まかな流れ
    実行環境の設定
    実行コマンドの組み立て
    コマンドの実行
    実行結果の検査
    モジュールとしての結果を返す

    View Slide

  24. モジュールから抜粋

    View Slide

  25. モジュールから抜粋

    View Slide

  26. モジュールから抜粋

    View Slide

  27. モジュールから抜粋

    View Slide

  28. モジュールから抜粋

    View Slide

  29. モジュールから抜粋

    View Slide

  30. モジュールから抜粋

    View Slide

  31. モジュールから抜粋

    View Slide

  32. モジュールの単体実行の様子
    1回目

    View Slide

  33. モジュールの単体実行の様子
    2回目

    View Slide

  34. ここまで
    パラメーターに従って、 pip コマンドをただただ実行
    実行結果（リターンコード、標準出力、標準エラー）をもとに、
    どうなったかを判定
    pip コマンド自体が冪等性を持っているため、割とそれに信頼性
    を委任

    View Slide

  35. Ansibleはどうやって、冪等性を
    担保するか？(2)

    View Slide

  36. amazon-linux-extras モジュール
    Amazon Linux 2が持つパッケージリポジトリの状態を管理できる
    もの
    コマンド自体が割と冪等性を持っているけど、 command モジュ
    ールで呼ぶのもあれなので自作してみた
    ※前述のpipモジュールなどを見る前に、ドキュメントだけ読んで作っ
    てみたものです
    - hosts: local
    tasks:
    - amazon2extras: name=php7.3
    - yum: name=php7.3

    View Slide

  37. モジュールの全体像

    View Slide

  38. モジュールの全体像
    全771行!
    前半の約半分はドキュメント
    残りのソースには、処理に必要な全内容がコードで書かれがち
    そのため、モジュールのソースは長めにになる傾向が強い

    View Slide

  39. モジュールの全体像
    やってること
    トピックの検索
    状態の確認（有効/無効の判定）
    状態と設定をもとにしたコマンドの実行
    コマンド実行の際には結果を確認

    View Slide

  40. モジュールのコード(抜粋)

    View Slide

  41. モジュールのコード(抜粋)

    View Slide

  42. ここまで
    必ず状態をチェックして、「コマンドの実行可否」を決めている
    present なのに、「まだ有効になってない」なら有効にす
    るコマンドを実行
    absent なのに、「すでに有効になっている」なら無効にす
    るコマンドを実行
    「状態を変える必要がない」なら、なにもしない
    「余計なことはしない」ことで冪等性を担保している

    View Slide

  43. おわりに

    View Slide

  44. まとめ
    冪等性とAnsibleの概要をふまえて、
    モジュルールのコードを追ってみました
    冪等性の担保には、「現在と目標とのズレ」や
    「初期状態x処理のパターン把握」が重要
    冪等性を担保するソフトを利用してても、それは変わらない
    冪等性はどこにでもいる

    View Slide

  45. おまけ：他にもある「冪等性」
    git pull
    リモートが変化しない間の正常なpullは何度やっても結果が
    同じ
    データベースマイグレーション
    スキーマの状態に対して、冪等性を担保する
    Let's Encrypt
    「FQDNへの証明書があること」に対して、冪等性を担保す
    る
    (終)

    View Slide