大家好，我是藍胖子，前面一節我簡單的講了講Ansible的架構和編排任務的語法，可以發現，透過playbook方式編排任務時，能夠將任務檔案化，但是在面對比較複雜且不同業務的任務編排時，維護playbook就變得複雜，所以Ansible產生了role模式針對複雜的任務進行編排工作。今天我們就透過一個實際的案例來看看如何使用role模式。
語法以及實際案例
平時我們在進行日誌收集的時候，往往會在每臺機器上安裝filebeat，並且由於每臺機器執行服務的不同，那麼收集日誌的配置檔案也是不一樣的，如何快速高效的部署filebeat以及擁有不同的配置檔案就是我們要思考的問題，當然不可能一臺機器一臺機器的修改配置檔案。
接下來我將會以一個我自己寫的filebeat相關的role舉例，來分析role模式涉及的一些規範以及如何寫一個好的任務編排, 案例中的filebeat的role模式擁有對filebeat的安裝，更新配置的功能。
role其實是對之前使用playbook的檔案目錄進行了一些規範(比如必須有roles目錄且和playbook入口檔案在同一位置，roles目錄下的各個特定role的目錄也是固定命名的)。
程式碼已經上傳github
https://github.com/HobbyBear/ansible-role-filebeat.git
整個專案的目錄結構如下所示，filebeatop.yml到時候是我們執行ansible playbook命令的入口檔案，我們可以使用這樣的命令使用這個role , ansible-playbook -i hosts filebeatop.yml ，其中hosts目錄就是存放inventory主機清單。
.
├── ReadMe.md
├── filebeatop.yml
├── group_vars
│ └── test.yml
├── hosts
│ ├── prod
│ └── test
└── roles
└── filebeat
├── handlers
│ └── main.yml
├── tasks
│ ├── install.yml
│ ├── main.yml
│ ├── rpm.yml
│ └── updatecfg.yml
└── templates
├── debug.conf
├── filebeatbox.yml
└── log.yml
filebeatop.yml 的內容如下,其中roles配置項可以配置多個role，不過案例中就只配置了一個filebeat的role，這個role的名稱就是上述roles目錄下的filebeat這個資料夾的名稱。同時filebeatop.yml同時設定了變數version和logstashendpoint，不同的是version變數是role級別的。
- hosts: test
roles:
- role: filebeat
version : '7.14.2'
vars:
logstashendpoint: 192.168.0.2:5054
接著瞭解下roles目錄的結構,filebeat 就代表一個role，其下有handlers，tasks，templates目錄，它們存放的內容如下，
roles
└── filebeat
├── handlers
│ └── main.yml
├── tasks
│ ├── install.yml
│ ├── main.yml
│ ├── rpm.yml
│ └── updatecfg.yml
└── templates
├── debug.conf
├── filebeatbox.yml
└── log.yml
- tasks 裡面存放具體的Ansible 的各種模組定義的任務，其入口檔案是main.yml 它裡面可以透過include 引入其他task。就比如這個案例中,我在main.yml 引入了其他配置檔案定義的任務。main.yml 程式碼如下, 可以看到在引入其他配置檔案定義的任務時，我還用tags為任務打上了標籤，這個標籤可以讓我們後續根據特定的標籤執行任務。
- include: install.yml
tags:
- install
- include: rpm.yml
tags:
- rpm
- include: updatecfg.yml
tags:
- updatecfg
- handlers 目錄下存放任務的後續處理邏輯，它其實也是ansible的模組定義的各種任務，與tasks不同的是，它是專門放到tasks執行後執行的。例如在handlers的main.yml檔案中，我定義了一個名為restart Filebeat service 的handler，handlers/main.yml程式碼如下
become 設定為yes，become_method 設定為sudo 代表在執行這個service的命令時是要以sudo許可權執行的。
- name: restart Filebeat service
become: yes
become_method: sudo
service:
name: filebeat
enabled: yes
state: restarted
這個handler在tasks/updatecfg.yml中有被用到，如下，在更新完filebeat服務配置後，透過notify配置，定義所需的handler的名稱，便可以在特定task執行完成後執行對應的handler。
- name: 更新服務配置
shell: "sudo systemctl daemon-reload"
notify:
- restart Filebeat service
- templates 目錄存放的是某些需要用到的配置檔案模板，在模板檔案中可以使用{{ 變數名 }} 引用，變數的定義可以在前面filebeatop.yml檔案中vars，或者roles配置中定義，也可以放到與hosts目錄同級的group_vars 目錄中定義，Ansible 關於變數的定義方式有很多種，這裡就不展開了。 拿案例中的group_vars舉例，其目錄下的檔名是inventory主機清單中的機器組的名稱，比如我這裡有個test的機器組，所以我在group_vars有個test.yml檔案，內容如下,定義了兩個變數 log_path和log_type。
log_path: "- /home/webserver/logs/box-api/box-api.log\r\n - /home/webserver/logs/box-bsk/box-bsk.log\r\n - /home/webserver/logs/box-flow/box-flow.log"
log_type:
box
這兩個變數被 templates目錄下的log.yml檔案所引用。log.yml檔案內容如下(是一個典型的filebeat設定日誌採集路徑的配置)
- type: log
tail_files: true
paths:
{{ log_path}}
fields:
log_type: {{ log_type }}
如何使用這些模板檔案呢，其實就是透過ansible的template模組，拿filebeat role中的updatecfg.yml定義的任務片段舉例，將filebeat 相關的配置檔案上傳到主機上對應的目錄。
- name: 傳送配置檔案
become: yes
become_method: sudo
template: src=log.yml dest=/home/webserver/local/filebeat-{{ version }}-linux-x86_64/log.yml owner=root group=root
- name: 傳送配置檔案
become: yes
become_method: sudo
template: src=filebeatbox.yml dest=/home/webserver/local/filebeat-{{ version }}-linux-x86_64/filebeatbox.yml owner=root group=root
?思考如何利用role模式寫好Ansible的任務編排
簡單介紹完整個案例的目錄和相關的檔案後，我們從使用角度來分析如何寫一個好的部署任務。
像上述案例中，我們可以執行下面的命令執行相應的部署，更新配置任務。
在filebeatop.yml 中指定要操作的機器組，以及filebeat的版本，日誌輸出的logstahsh端點。 在group_vars 中定義每個機器組上需要採集的日誌路徑
安裝filebeat軟體包
ansible-playbook -i hosts filebeatop.yml --tags "install"
安裝filebeat service
ansible-playbook -i hosts filebeatop.yml --tags "rpm"
更新filebeat配置檔案
ansible-playbook -i hosts filebeatop.yml --tags "updatecfg"
透過filebeat/tasks 引入其他任務配置檔案時的 tags去區分要執行的任務，而整個role中則定義對應的元件相關的操作，這樣能更好的維護對應元件的部署配置任務。
並且讓roles相關的檔案 只負責部署，而針對哪些機器部署的配置則從roles目錄中分離出來，形成變數。這樣的好處在於，後續對於其他機器組的配置，相同元件的不同版本的配置都可以不用去動roles目錄下的檔案了，只需要新增不同的機器組的變數或者修改filebeatop.yml中的版本號即可。