playbook syntax check

Ansibleにおいて表題の通り。

■ 環境

  • Ansible 2.3.0.0

■ – -syntax-check

前にどこかで書いた記憶があるのだが、Ansibleのカテゴリの記事のタイトルでは見当たらず…。と思ったら「はじめてのAnsible」の中で触れていたようだ。

playbookを書いていて、さて実行してみようと思ったところ実行できず…。しかもそれなりにTaskが実行されてからのエラーだったので気分が凹む。「はじめてのAnsible」で存在を知って使おうと思っていたのに忘れてしまっていたようなので、改めてエントリを。

$ ansible-playbook test.yml --syntax-check

何もエラーがなければ下記のような結果が出力される。

$ ansible-playbook test.yml --syntax-check

playbook: test.yml
$

エラーがあるときは下記のような表示がされる。

$ ansible-playbook test.yml --syntax-check
ERROR! no action detected in task. This often indicates a misspelled module name, or incorrect module path.
  :
$

Ansibleの”^ here“はあまり当てにならず、その周辺をよく確認する。自身がよく間違えてしまうのは”lineinfile“を”inlinefile“と書いてしまうことだ。Vagrantの”inline provisioner“とごちゃ混ぜになっている気がする。

以上。

■ 関連

初めてのAnsible

ディレクトリの存在チェック

Ansibleにおいて表題を行う。ディレクトリが存在する場合はスキップしたい処理がある。

■ 環境

  • Ansible 2.2.2.0

■ stat

stat – retrieve file or file system status
http://docs.ansible.com/ansible/stat_module.html

下記のように書ける。

- name: directory check
  stat:
    path: /path/to/directory
  register: d

- name: skip task
  debug:
    msg: "skip skip skip"
  when:
    - d.stat.exists
    - d.stat.isdir

このように書くことが可能である。条件としては2つ入れてみた。

  • /path/to/directory“が存在する
  • /path/to/directory“がディレクトリである

これら2つの条件が共に真である場合に、”debug“モジュールで指定した”msg“が出力される。

以上。

■ 関連

初めてのAnsible

対象でコマンド実行

Ansibleにおいて、Inventoryfileで指定したホスト全台に対してコマンドを実行したい。普段はplaybookを使用したり”-m ping“とかしか使ったことがなかったのでメモ。

■ 環境

  • Ansible 2.2.1.0

■ ansible

下記のようにやると全台に対してコマンドを実行することができる。例として`apt-get update`してみた。

$ ansible all -m shell -a "sudo apt-get update"

-m apt“でも実行が可能なのかもしれない。が、手っ取り早くはこれで良いであろう。

以上。

■ 関連

初めてのAnsible

Slack Module

初めてのAnsible』を読んで知った表題のModuleを試してみた。

■ 環境

  • Ansible 2.2.1.0

■ Slack Module

Slack – Send Slack notifications – Ansible Documentation
http://docs.ansible.com/ansible/slack_module.html

よくわからなかったのが”token“のところである。

Custom Integrations
https://my.slack.com/apps/manage/custom-integrations

Incoming WebHooks“から作成もしくは既存のものの詳細に記載されている”Webhook URL“から抽出した。自身の環境ではマスクしているが下記のようなURLであった。

https://hooks.slack.com/services/X0X00XX0X/X0XX0XXXX/XXxxxXxXxxxxxxX0x0xxXxxX

https://hooks.slack.com/services/“以降の文字列を”token“に指定したところ、正しく通知された。

icon_emoji“や”username“も指定できるので、playbookが正常に終了した場合にSlackに通知するといったことができるようになった。

    - name: slack notification
      slack:
        token: "X0X00XX0X/X0XX0XXXX/XXxxxXxXxxxxxxX0x0xxXxxX"
        channel: "#test"
        username: "withsin"
        icon_emoji: ":withsin:"
        msg: "テスト。"
      become: no
      delegate_to: localhost

以上。

■ 関連

ansible.cfg

Ansibleの表題のファイルについて。『初めてのAnsible』を読んで知ったことのメモ。

■ 環境

  • Ansible 2.2.1.0
  • Vagrant 1.9.1
  • Mac OSX El Capitan

■ ansible.cfg

Vagrantで稼働させているホストに対して、Ansibleで構築を行っている。以前は`ansible.cfg`の存在を知らなかったので下記のように手打ちでやっていたりした。

$ ansible-playbook -i hosts test.yml

現在は下記のように`ansible.cfg`を設定している。

[defaults]
inventory = hosts
remote_user = vagrant
private_key_file = ~/.vagrant.d/insecure_private_key
host_key_checking = False
retry_files_enabled = False

またVagrantfileには下記を設定している。

Vagrant.configure("2") do |config|
  :
  config.ssh.insert_key = false
  :
end

これで下記のようにアクセスすることができる。

$ ansible-playbook test.yml

`ansible.cfg`では、”inventory“を指定することによりコマンド実行時の`-i`オプションを省略することができる。『初めてのAnsible』では`hostfile`を使用するように記載されていたが、現在は”deprecated“のようなのでこちらの設定を使用するようにした。。また”remote_user“は”vagrant“ユーザをデフォルトで使うようにし、”private_key_file“は指定したファイルを使うようにしている。最近のVagrantはVM毎に異なる鍵が使われるようになっていたが`Vagrantfile`にて`config.ssh.insert_key`を”false“にすることで、このVagrantfileで起動したVMに関しては共通の鍵が使用されるようになっている。また”host_key_checking“を “False“にすることで、VMを何度再作成してもSSH接続時にエラーが起こらないようにしている。最後に”retry_files_enabled“は”False“にしている。失敗した場合はいつも最初から流すようにしているので、retryファイルはほとんど使用していない。邪魔に感じてしまうので作成されないようにしている。

これで随分と楽になった。知らないことは罪である。いや、公式のドキュメントを読まない事が罪である。