自動化運維工具-Ansible的Playbook的使用

這是我參與8月更文挑戰的第8天 @TOCjavascript

前言


往期Ansible目錄 一、自動化運維工具-Ansible實戰指南 二、自動化運維工具-Ansible的Playbook的使用 三、自動化運維工具-Ansible的Roles的使用 四、B站學習連接php

上一篇說的是Ansible的簡單使用,用一些模塊來控制遠程主機。可是一個一個調用模塊也太麻煩了吧,有沒有什麼辦法能夠一下調用不少模塊讓它完成不少任務呢? 這裏就用到了Playbook了html

1、Playbook是什麼?

劇本,就像一些綜藝節目的劇本一個意思。按照劇本發展故事情節 在ansible中劇本也是相似的做用,第一步幹啥,第二部幹啥,第三步幹啥....java

2、playbook使用場景

能夠類比linux中執行shell腳本同樣,批量執行命令 ansible中的劇本也是同樣,批量處理任務 playbook用的是yaml格式python

3、Playbook格式說明

Hosts:               主機,部署目標
         Tasks:               任務,ansible,執行目的
         Varlables:         變量
         Templates:       包含了模板語法的文本文件;
         Handlers:                   有特定條件觸發的任務
         Roles :              角色  (特別介紹)
複製代碼

如下爲playbook經常使用到的YMAL格式:   一、文件的第一行應該以 "---" (三個連字符)開始,代表YMAL文件的開始。   二、在同一行中,#以後的內容表示註釋,相似於shell,python和ruby。   三、YMAL中的列表元素以」-」開頭而後緊跟着一個空格,後面爲元素內容。   四、同一個列表中的元素應該保持相同的縮進。不然會被當作錯誤處理。   五、play中hosts,variables,roles,tasks等對象的表示方法都是鍵值中間以":"分隔表示,":"後面還要增長一個空格   六、yml文件名以yml結尾或者yaml結尾linux

示例1:**nginx

---
- hosts: all
  remote_user: root
  
  tasks:
   - name: install a group
     group: name=mygrp system=true 
   - name: install a user
     user: name=user1 group=mygrp system=true
示例2

- hosts: websrvs
  remote_user: root
  
  tasks:
    - name: install httpd package
      yum: name=httpd
    - name: start httpd service 
      service: name=httpd state=started
複製代碼

主要由三個部分組成。web

hosts部分:使用hosts指示使用哪一個主機或主機組來運行下面的tasks,每一個playbook都必須指定hosts,hosts也可使用通配符格式。主機或主機組在inventory清單中指定,可使用系統默認的/etc/ansible/hosts,也能夠本身編輯,在運行的時候加上-i選項,指定清單的位置便可。在運行清單文件的時候,--list-hosts選項會顯示那些主機將會參與執行task的過程當中。 remote_user:指定遠端主機中的哪一個用戶來登陸遠端系統,在遠端系統執行task的用戶,能夠任意指定,也可使用sudo,可是用戶必需要有執行相應task的權限。 tasks:指定遠端主機將要執行的一系列動做。tasks的核心爲ansible的模塊,前面已經提到模塊的用法。tasks包含name和要執行的模塊,name是可選的,只是爲了便於用戶閱讀,不過仍是建議加上去,模塊是必須的,同時也要給予模塊相應的參數。shell

4、Play book變量的使用

(1)facts: 可直接調用
(2)ansible-playbook 命令的命令行中的自定義變量
    -e EXTRA_VARS, --extra-vars=EXTRA_VARS  #命令行中定義變量傳遞至yaml文件。
(3)經過roles傳遞變量
(4)Host Inventory
(a)向不一樣的主機傳遞不一樣的變量;
    IP/HOSTANME varable=value var2=value2
    在hosts 組ip後添加變量
(b)向組中的主機傳遞相同的變量
    [group:var]         
    arable=value
注意:Inventory參數:
 用於定義ansible遠程鏈接目標主機時使用的參數,而非傳遞給playbook的變量。
    ansible_ssh_host   
    ansible_ssh_user
    ansible_ssh_port
    ansible_ssh_pass
    ansible_sudo_pass
		….
查看遠程主機的所有系統信息
ansible all -m setup  #收集到的遠程主機的變量
複製代碼

1 在主機列表定義變量

(1)變量的定義示例:         
	變量定義位置 /etc/ansible/hosts
	普通變量
		[web]
		172.16.250.240  http_port=80
		172.16.252.18   http_port=8080  
	組變量
		[web:var1]
		http_port=80
		[web]
		172.16.250.240  
		172.16.252.18    
	在playbook中定義變量的方法
		Vars:
	    - var1:value1
	    - var2:value2
	命令行指定變量
		nsible-playbook -e  調用
複製代碼

實例: 在這裏插入圖片描述 在這裏插入圖片描述apache

2 在playbook定義變量

在這裏插入圖片描述

在這裏插入圖片描述

3 命令行參數傳遞

[root@ansible ansible]# cat yum.yml 
---
- hosts: wsr
  remote_user: root

  tasks:
  - name: install package
    yum: name={{ pkname }} state=present   
複製代碼

在這裏插入圖片描述

5、notifyh和handlers的使用

Ansible提供了notify指令和handlers功能。若是在某個task中定義了notify指令,當Ansible在監控到該任務 changed=1時,會觸發該notify指令所定義的handler,而後去執行handler。所謂handler,其實就是task,不管在寫法上仍是做用上它和task都沒有區別,惟一的區別在於hander是被觸發而被動執行的,不像普通task同樣會按流程正常執行。

示例:觸發

[root@ansible ansible]# cat apache.yml 
---
- hosts: wsr
  remote_user: root
  tasks:
  - name: install pk
    yum: name=httpd
  - name: copy file
    copy: src=file/httpd.conf dest=/etc/httpd/conf/ #只要src文件內容發生改變,就會觸發handlers也就是重啓服務
    notify: 
      - restart httpd
  - name: start httpd service
    service: name=httpd state=started enabled=yes
  handlers:
   - name: restart httpd
     service: name=httpd state=restarted
複製代碼

處理器是根據對應Task的返回狀態來進行判斷的。當Task(任務)狀態爲changed時,處理器就會執行你寫好的handlers(處理器)操做。

利用notify、handlers觸發式重啓服務。

[root@ansible ansible]# ansible-playbook apache.yml 

PLAY [wsr] *****************************************************************************

TASK [Gathering Facts] *****************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [install pk] **********************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [copy file] ***********************************************************************
changed: [192.168.100.20]
changed: [192.168.100.10]

TASK [start httpd service] *************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

RUNNING HANDLER [restart httpd] ********************************************************
changed: [192.168.100.20]
changed: [192.168.100.10]

PLAY RECAP *****************************************************************************
192.168.100.10 : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
192.168.100.20 : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
複製代碼

6、Playbook中tags的使用

tags即標籤,tags能夠和一個play(就是不少個task)或者一個task進行捆綁。而後再執行play book時只需指定相應的tags便可僅執行與tags綁定的task。

[root@centos7_1yaml]# vim web-3.yml
---
- hosts: web
 remote_user: root
 tasks:
 - name: install httpd package
   yum: name=httpd state=present
 - name: install configure file
   copy: src=/apps/work/files/httpd.conf dest=/etc/httpd/conf/
   tags: instconf              #tags
 - name: start httpd service
   service: name=httpd state=started
[root@centos7_1 yaml]# ansible-playbook -tinstconf web-3.yml 

#指定tags instconf 執行。
ansible-playbookweb-3.yml --tags=" instconf " 執行此命令一樣僅執行instconf 標籤內容。 複製代碼

7、tepmplates 模板的使用

jinjia2

Jinja2是基於python的模板引擎,功能比較相似於PHP的smarty,J2ee的Freemarker和velocity。它能徹底支持
複製代碼

unicode,並具備集成的沙箱執行環境,應用普遍。

Jinja2 語言: 字面量: 字符串:使用單引號或雙引號; 數字:整數,浮點數 列表:[item1,item2 …..] 元組:(item1item2…,) 字典:{key1:value,key2:value….} 布爾型: true/filase 算數運算: +,- , * , / , // , % ** 比較操做: ==, != , >= ,<= 邏輯運算: and,or, not, 流表達式 For、IF、when

模板安裝nginx

在本機安裝nginx服務,拷貝模板到本地,進行修改並命名爲nginx.conf.j2

[root@ansible ansible]# cp /etc/nginx/nginx.conf ./


[root@ansible ansible]# head nginx.conf 
# For more information on configuration, see:
#   * Official English Documentation: http://nginx.org/en/docs/
#   * Official Russian Documentation: http://nginx.org/ru/docs/

user nginx;
worker_processes {{ ansible_processor_vcpus }};
error_log /var/log/nginx/error.log;
pid /run/nginx.pid;

# Load dynamic modules. See /usr/share/doc/nginx/README.dynamic.
.........................
..................
......

[root@ansible templates]# ll
total 4
-rw-r--r--. 1 root root 2361 Jul 11 03:42 nginx.conf.j2

複製代碼
[root@ansible ansible]# cat nginx.yml 
---
- hosts: wsr
  remote_user: root

  tasks:
  - name: install nginx
    yum: name=nginx
  - name: create nginx user
    user: name=nginx shell=/sbin/nologin
  - name: copy cfg
    template: src=templates/nginx.conf.j2 dest=/etc/nginx/nginx.conf
    notify: restart nginx
  - name: start service nginx
    service: name=nginx state=started
  handlers:
  - name: restart nginx
    service: name=nginx state=restarted

複製代碼
[root@ansible ansible]# ansible-playbook nginx.yml 

PLAY [wsr] ******************************************************************************************

TASK [Gathering Facts] ******************************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [install nginx] ********************************************************************************
ok: [192.168.100.10]
ok: [192.168.100.20]

TASK [create nginx user] ****************************************************************************
changed: [192.168.100.20]
changed: [192.168.100.10]

TASK [copy cfg] *************************************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [start service nginx] **************************************************************************
changed: [192.168.100.10]
changed: [192.168.100.20]

PLAY RECAP ******************************************************************************************
192.168.100.10             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
192.168.100.20             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
複製代碼

由於我兩臺遠程主機都是2個vcpu,因此顯示的都是2。 在這裏插入圖片描述

若是啓動nginx 的時候報錯,能夠建立nginx用戶便可解決

8、條件判斷when

when 語句:在task中使用。Jinja2的語法格式

tasks:
- name: install conf file to Centos7
  template:src=files/nginxconf.c7.j2 dest=/etc/nginx/nginx.conf
when: ansible_distribution_major_version==」7」
- name: install conf file to Centos6
  template:src=files/nginxconf.c6.j2 dest=/etc/nginx/nginx.conf
  when:ansible_distribution_major_version ==」6」
複製代碼

以上語法表示若查詢遠程主機系統爲centos6則執行,install conf file to Centos6。 若爲cenos7則執行install conf file to Centos7。

9、迭代with_items

循環迭代,須要重複執行的任務;對迭代項引用,固定變量名爲item,然後在task中使用with_items給定迭代的元素列表;

示例1:

字符串方式

- name: install some package
  yum:name={{ item }}  state=present
  with_items:
    - nginx
    - memecached
    - php-fpm
複製代碼

字典方式

- name: add  some groups
      group: name={{ item }} 
      with_items:
        - group1
        - group2
        - group3
     - name: add some user
       user: name={{ item.name }} group={{item.group}}
       with_items:
         - {name: 'user1',group: 'group1'}
         - {name: 'user2',group: 'group2'}
         - {name: 'user3',group: 'group3'}
複製代碼

在這裏插入圖片描述 在這裏插入圖片描述

10、檢測playbook

運行playbook,使用ansible-playbook命令

(1) 檢測語法

ansible-playbook --syntax-check /path/to/playbook.yaml (2) 測試運行 ansible-playbook -C /path/to/playbook.yaml --list-hosts # 列出主機 --list-tasks # 列出任務 --list-tags # 列出標籤

(3) 運行

ansible-playbook /path/to/playbook.yaml -t TAGS, --tags=TAGS --skip-tags=SKIP_TAGS --start-at-task=START_AT 在執行playbook前,能夠作些檢查

檢查palybook語法

ansible-playbook -i hosts httpd.yml --syntax-check 列出要執行的主機

ansible-playbook -i hosts httpd.yml --list-hosts 列出要執行的任務

ansible-playbook -i hosts httpd.yml --list-tasks

參考:

my.oschina.net/u/3413282/blog/876231](my.oschina.net/u/3413282/b…)

www.cnblogs.com/keerya/p/80…

www.bilibili.com/video/BV1HZ…

相關文章
相關標籤/搜索