Ansible-playbook 快速入門到放棄

Ansible-playbook 快速入門到放棄

　　　　隔岸紅塵忙似火，當軒青嶂冷如冰，

1-簡介

playbook 相當于可以把模塊命令都寫入到組態檔里面，這樣就可以直接執行組態檔了，類似腳本，

2-playbook 初體驗

撰寫test.yml 檔案，在serviceA 主機機器上的/opt/tjt 路徑下創建test.txt 檔案，

1 ---
2 - hosts: serviceA
3   remote_user: root
4   tasks:
5     - name: "使用touch 命令創建test.txt檔案"
6       shell: touch /opt/tjt/test.txt

檔案格式說明

• 第一行需要有三個杠，hosts 引數指定了對哪些主機進行參作，如果是多臺機器可以用逗號作為分隔，也可以使用主機組，在/etc/ansible/hosts里定義；
• user 引數指定了使用什么用戶登錄遠程主機操作；
• tasks 指定了一個任務，其下面的name 引數同樣是對任務的描述，在執行程序中會列印出來，shell 是ansible 模塊名字，

編輯完成之后，使用ansible-playbook 命令執行test.yml 檔案，

[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/test.yml

 然后到客戶端上看看是否有創建test.txt 檔案，

[root@localhost ~]# ls -l /opt/tjt/test.txt

3-playbook 變數

通過創建用戶體驗playbook 的變數使用方式，

---
- name: "創建test用戶"
  hosts: 192.168.8.136
  user: root
  gather_facts: false
  vars:
     - user: "test"
  tasks:
    - name: "---playbook變數----創建test用戶---"
      user: name="{{ user }}"

說明：

• name：對該playbook 實作的功能做一個概述，后面執行程序中，會列印 name 變數的值 ，可以省略；
• gather_facts：指定了在以下任務部分執行前，是否先執行setup 模塊獲取主機相關資訊，如果需要在后面的tasks里獲取setup收集到的資訊，就需要把這個引數設定為True；
• vars：指定了變數，這里宣告了一個user 變數，其值為test ，需要注意的是，變數值一定要用引號引住；
• user：提定了呼叫user 模塊，name是user 模塊里的一個引數，而增加的用戶名字呼叫了上面user 變數的值，

執行該檔案：

[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/create_user.yml

 到客戶端上看看用戶是否已創建：

[root@localhost ~]# id test

4-playbook 回圈

---
- hosts: 192.168.8.136
  user: root
  tasks:
    - name: "playbook---回圈"
      file: path=/opt/tjt/{{ item }} state=touch mode=600
      with_items:
        - 1.txt
        - 2.txt
        - 3.txt

引數說明

• file 模塊可以對檔案進行相關的操作，例如創建檔案或者更改檔案權限等，具體可以查看該模塊的檔案，
• with_items 為回圈的物件，相當于是一個陣列或集合，寫在下面的1.txt、2.txt 以及3.txt 是該集合的元素，而item 則表示的是遍歷出來的元素，也就是說item 指代的是1.txt、2.txt 以及3.txt，
• state 的值設定為touch 表示如果該檔案不存在就進行創建，
• path 表示檔案的路徑，
• mode 設定權限，

執行該檔案：

[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/while.yml

到客戶端上看看檔案是否已創建：

[root@localhost ~]# ll /opt/tjt/*.txt

5-playbook 條件判斷

[root@localhost tjt]# ansible serviceA -m setup

 通過一個簡單的創建檔案的例子體驗playbook 條件判斷陳述句的使用方式，撰寫 when.yml 檔案內容如下：

---
- hosts: serviceA
  user: root
  gather_facts: True
  tasks:
    - name: "playbook---條件判斷"
      shell: touch /opt/tjt/when.txt
      when: ansible_virbr0.ipv4.address == "192.168.122.1"

引數說明

• ansible_virbr0 是一個陣列存盤著網卡相關資訊，ipv4 屬于該陣列的子元素，但是ipv4也是一個陣列，而address 則是ipv4 陣列的子元素，我們需要使用address 來作為判斷條件，所以要訪問address 就需要使用這樣的格式：ansible_virbr0.ipv4.address，address 表示的是鍵，而"192.168.122.1"則是值，when 為判斷陳述句相當于if，所以其判斷條件為：該鍵的值為"192.168.122.1"時就執行shell 模塊里定義的陳述句，
• gather_facts: True ，在遠程主機運行setup 模塊，并將收集的資訊記錄起來（等于命令ansible  all -m setup #查看系統資訊），可以通過系統資訊來判斷是否執行， 
• gather_facts: no ，在不需要獲取機器資訊時，根據資訊做判斷時，將其關閉，避免影響執行速度，

執行該檔案：

[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/when.yml

 到客戶端上看看檔案是否已創建：

[root@localhost ~]# ll /opt/tjt/when.txt
-rw-r--r--. 1 root root 0 2月  21 21:51 /opt/tjt/when.txt
[root@localhost ~]#

6-playbook 的handlers

• 有一種情況就是執行了tasks里面的內容之后，服務器發生了變化，這時我們可能需要執行一些相關的操作，
• 例如我們修改了某個服務的組態檔后，則需要重啟一下服務，而handlers 就是完成這樣的事情的，它相當于編程中的回呼函式，當tasks 里的內容執行成功后，就會執行handlers 里定義的內容，
• 類似于shell 腳本中的 && 符號，例如 cat 1.txt && rm -f 1.txt ，當 cat 1.txt 命令執行成功之后就會執行 rm -f 1.txt 命令，否則不執行，

---
- name: "playbook中的handlers"
  hosts: serviceA
  user: root
  tasks:
    - name: copy file
      copy: src=/opt/tjt/handlers dest=/opt/tjt/handlers.txt
      notify: test handlers
  handlers:
    - name: test handlers
      shell: echo "This is a test string" >> /opt/tjt/ansible/handlers.txt

引數說明

• 只有copy 模塊執行成功后，才會去呼叫下面的handlers 里定義的內容，去執行handlers 里面的shell 相關命令，這種比較適合組態檔發生更改后，重啟服務的操作，
• notify 用于指定handlers 的name 引數的值，因為handlers 可以定義多個，所以需要使用notify 來進行指定呼叫哪一個，

執行該檔案：

[root@localhost tjt]# ansible-playbook /opt/tjt/ansible/handlers.yml

 到客戶端上查看檔案末尾一行是否為ansible 執行的echo 寫進的那一行內容，

[root@localhost ~]# tail -n1 /opt/tjt/ansible/handlers.txt

7-Ansible 的roles

role是task檔案、變數檔案、handlers檔案的集合體，這個集合體的顯著特點是：可移植性和可重復執行性，

在實際專案中，通常我們以部署某個服務為單元作為一個role ，然后將這些服務單元（role）放在一個roles 目錄下，主playbook 檔案通過呼叫roles目錄下的role，來實作各種靈活多變的部署需求，

roles創建

創建一個role 的方法有兩種：

1. 命令mkdir 和touch 行手動創建，即需要哪個目錄和檔案就用「mkdir」和「touch」命令創建出來，

2. 使用ansible-galaxy 自動初始化一個role，創建完后再洗掉不需要的目錄，

使用「ansible-galaxy init」命令創建一個名字為role_D 的role，

[root@localhost roles]#  ansible-galaxy init role_D
- Role role_D was created successfully

role 目錄結構

• tasks : 用于存放role_D 的主要任務，也可以添加其他task 檔案，供main.yml 呼叫，從而實作更加復雜的部署功能，
• handlers : 用于存放觸發執行（ hanlders ）的任務，
• defaults : 用于存放默認變數，優先級最低，
• vars : 用于存放變數檔案，role_D 中任務和模版里用到的變數可以在這里定義，
• files ：用于存放需要拷貝到目的主機的檔案，例如，作為「copy」模塊src 引數的默認根目錄，
• template : 用于存放模版檔案，格式為.j2，檔案內容要符合Jinja2 語法規則，通常使用「template」模塊部署服務的組態檔，
• meta : 用于存放role 依賴串列，這個知識點后面會詳細闡述，
• tests : 用于存放測驗role 本身功能的playbook 和主機定義檔案，在開發測驗階段比較常用，

 role 中各個目錄下的main.yml 檔案很重要，這是ansible 默認加載的YAML 檔案，

roles 的參考&執行

可以使用「roles:」陳述句參考role ，根據需要在主playbook 中參考不同的role，ansible 會把role 所包含的任務、變數、handlers、依賴等加載到playbook中，按照順序執行，

撰寫主playbook 檔案test_role.yml：

---
- name: "主playbook檔案通過呼叫roles目錄下的role"
  hosts: serviceA
  user: root
  gather_facts: false
  roles:
    - roleB
    - roleA

roleA 和roleB 目錄結構如下：

/opt/tjt/ansible/roles/roleA/tasks/main.yml

---
- name: "呼叫-roles目錄下的roleA"
  debug:
    msg: "msg: roleA被執行"

/opt/tjt/ansible/roles/roleB/tasks/main.yml

---
- name: "呼叫-roles目錄下的roleB"
  debug:
    msg: "age:: roleB被執行"  

執行主playbook 檔案test_role.yml：

[root@localhost roles]# ansible-playbook /opt/tjt/ansible/test_role.ym

如上，可以看到roleB 和roleA 分別有序執行，

檢索路徑

ansible 如何查找要執行的role，在不使用絕對路徑的情況下(可以這么配role - role: /opt/tjt/ansible/roles/roleB)，ansible 檢索role 的默認路徑有：

• 執行ansible-playbook 命令時所在的當前目錄
• playbook 檔案所在的目錄及playbook 檔案所在目錄的roles 目錄
• 當前系統用戶下的～/.ansible/roles 目錄
• /usr/share/ansible/roles 目錄
• ansible.cfg 中「roles_path」指定的目錄，默認值為/etc/ansible/roles 目錄

8-playbook 的chdir

chdir：進入指定目錄，如下chdir，執行ls 命令前，先進入指定目錄/opt/tjt，

[root@localhost roles]# ansible serviceA -m command -a 'chdir=/opt/tjt ls'

9-playbook 的with_items

ansible 中的回圈模塊有很多，with_items 最為簡單常用， 

---
- name: "with_items回圈遍歷"
  shell: "echo {{ item }}"
  register: "with_items_output"
  with_items: [a,b,c,d]

 如上，with_items 可以用于迭代一個串列或字典，通過 {{ item }} 獲取每次迭代的值，

標籤：其他

上一篇：Spring 保存帶Array欄位的記錄到PostgreSQL

下一篇：python正則運算式替換所有內容并同時保留找到的內容