iT邦幫忙

2017 iT 邦幫忙鐵人賽
DAY 17
0

現代 IT 人一定要知道的 Ansible 自動化組態技巧

17. Ansible 如何發送 notification 到 HipChat?

HipChat 是相當老牌線上通訊服務,官方也提供了不少整合方案。凍仁曾透過它整合 Ansible, Git, Jenkins, Redmine, SkypeZabbix [^1] 等服務,當資訊集中在一處後,維運起來也會輕鬆許多。這裡凍仁將介紹 Ansible 整合 HipChat 的部份。[^2]

automate_with_ansible_practice-22.jpg
▲ 上圖為 Ansible 發送 notification 到 HipChat 的範例。

hipchat module 是什麼?

hipchat module 是用來發送訊息到 HipChat 上的通知模組 (notification modules),我們只需取得 Room notification Token 即可使用。

Ansible 怎麼整合 HipChat?

  1. 撰寫發送 notification 到 HipChat 的 Playbook:請依步驟 2 取得的參數設定 hipchat_tokenhipchat_room 等變數。[^3]

    $ vi send_notification_to_hipchat.yml
    ---
    - name: Send notification to HipChat
      hosts: localhost
    
      vars:
        hipchat_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
        hipchat_room: "automate-with-ansible"
    
      post_tasks:
        - name: send notification to hipchat
          hipchat:
            api: "https://api.hipchat.com/v2/"
            token: "{{ hipchat_token }}"
            room: "{{ hipchat_room }}"
            color: gray
            msg: "Send a notification with Ansible !"
    
    # vim: ft=ansible :
    

    由於 HipChat 在設計是綁定房間 (Room) 使用的,不像 Slack 可用一組設定發送訊息到不同的頻道,若有這類需求則可透過多個 Tasks 和 Tokens 進行實作。

  2. 取得 HipChat 的 Room Notification Token。

    1. 登入 HipChat 後,開啟 web app。

      2016-12-17-ansible-hipchat-1.png

    2. 建立一間新的 Room。

      2016-12-17-ansible-hipchat-2.png

    3. 幫這個 Room 取個名字並簡單介紹一下用途。

      2016-12-17-ansible-hipchat-3.png

    4. 回到 HipChat 的管理介面,並找到 Group Admin (群組管理)

      2016-12-17-ansible-hipchat-4.png

    5. 在 Rooms 底下找到要整合 Ansible 的 Room。

      2016-12-17-ansible-hipchat-5.png

    6. 點選左側的 Tokens

      2016-12-17-ansible-hipchat-6.png

    7. Create New Token 輸入 Ansible 和選擇 Send Notification 的 Scopes,之後接下 Create

      2016-12-17-ansible-hipchat-7.png

    8. Token 建立完畢後,即可在紅框裡取得剛建立的 Token

      2016-12-17-ansible-hipchat-8.png

  3. 執行 Playbook。

    $ ansible-playbook send_notification_to_hipchat.yml
    
    PLAY [Send notification to HipChat] ********************************
    
    TASK [setup] *******************************************************
    ok: [localhost]
    
    TASK [send notification to hipchat] ********************************
    changed: [localhost]
    
    PLAY RECAP *********************************************************
    localhost      : ok=2    changed=1    unreachable=0    failed=0
    
  4. 在 HipChat 接收從 Ansible 送出的 notification。

    2016-12-17-ansible-hipchat-9.png

  5. 現在我們可以在 HipChat 裡接收來自 Ansible 的 notification 了!

後語

Ansible 與 HipChat 的組合在使用上會比 Slack 簡單許多,雖然 HipChat 不比 Slack 的高度客製化,但凍仁認為它的門壏比較低,適合需求較單純的團隊。

至於要選哪一家作為 ChatOps 的平台?這就是另一門學問了。(笑)

相關連結

[^1]: Zabbix 是企業級的 open source 監控系統,搭配 HipChat 使用後可以讓我們在極短的時間內掌握伺服器 (Server) 和網路設備等狀況。
[^2]: 凍仁先前於高雄任職的公司有使用 HipChat,但後期只剩 IT 維運部門在用就是。
[^3]: 由於 HipChat 在設計是綁定房間 (Room) 使用的,不像 Slack 可用一組設定發送訊息到不同的頻道,若有這類需求則可透過多個 Tasks 和 Tokens 進行實作。


上一篇
16. Ansible 如何發送 notification 到 Slack?
下一篇
18. 如何在 Playbooks 使用 loops?
系列文
現代 IT 人一定要知道的 Ansible 自動化組態技巧31

1 則留言

0
凍仁翔
iT邦新手 4 級 ‧ 2016-12-18 01:05:56

個人喜歡 HipChat 的介面,和 Slack 的高度客製化,不過還是得看團隊的選擇使用就是。

我要留言

立即登入留言