Ansible常用模塊的介紹和使用

這篇文章為大家分享Ansible常用模塊的介紹和使用。文章涵蓋inventory主機清單、YAML語言介紹、實現playbook劇本等內容，希望大家通過這篇文章能有所收獲。

inventory主機清單

ansible默認的主機清單是/etc/ansible/hosts文件，主機清單可以手動設置，也可以通過Dynamic Inventory動態生成，一般主機名使用FQDN

vim /etc/ansible/hosts
[webserver]                          #方括號設置組名
www1.example.org              #定義被監控主機，這邊可以是主機名也可以是IP地址，主機名需要修改/etc/hosts文件
www2.example.org:2222     #冒號后定義遠程連接端口，默認是ssh的22端口

如果是名稱類似的主機，可以使用列表的方式標識各個主機

[webserver]
www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=123456

[dbbservers]
db-[a:f].example.org

inventory變量

• 主機變量

[webserver]
www1.magedu.com http_port=80 maxRequestsChild=808
www2.magedu.com http_port=8080 maxRequestsChild=909

• 組變量

[servers:vars]
ntp_server=ntp.example.org
nfs_server=nfs.example.org

• 組嵌套

[apache]
http1.example.org
http2.example.org

[nginx]
ngx1.example.org
ngx2.example.org

[webservers:children]
apache
nginx

• inventory變量參數

YAML標記語言

YAML：另一種標記語言。是用來寫配置文件的語言，非常簡潔和強大。
YAML語法和其他語言類似，也可以表達散列表、標量等數據結構。
結構通過空格來展示；序列里配置項通過-來代表；Map里鍵值用:來分隔;YAML的擴展名為yaml

• 基本語法規則

  1.大小寫敏感
  2.使用縮進表示層級關系
  3.縮進時不允許使用Tab鍵，只允許使用空格。
  4.縮進的空格數目不重要，只要相同層級的元素左側對齊即可

• YAML支持的數據結構

  1.對象：鍵值對的集合，又稱為映射（mapping）/ 哈希（hashes） / 字典（dictionary）
  例如：name:Example Developer
      鍵     值
  2.數組：一組按次序排列的值，又稱為序列（sequence） / 列表（list）
  例如：-Apple
     -Orange
  3.純量：單個的、不可再分的值
  例如：number：12.30
     sure：true

yaml實例：

name:zhangsan
age:20
name:lisi
age:22
people：

-name:zhangsan
      age:20
      -name:lisi
      age:22

Ansible劇本-playbook

Playbook是一種完全不同的運用ansible的方式，類似與saltstack的state狀態文件。ad-hoc無法持久使用，playbook可以持久使用。
playbook是由一個或多個play組成的列表，play的主要功能在于將事先歸并為一組的主機裝扮成事先通過ansible中的task定義好的角色。從根本上來講，所謂的task無非是調用ansible的一個module。將多個play組織在一個playbook中，即可以讓它們聯合起來按事先編排的機制完成某一任務。通過task調用ansible的模板將多個play組織在一個playbook中運行。

Playbook核心元素

Playbook語法

1、playbook使用yaml語法格式，后綴可以是yaml,也可以是yml。
在單一的一個playbook文件中，可以連續三個連子號(---)區分多個play。還有選擇性的連續三個點好(...)用來表示play的結尾，也可省略。
2、當行開始正常寫playbook的內容，一般都會寫上描述該playbook的功能。
3、使用#號注釋代碼。
4、縮進必須統一，不能空格和tab混用。縮進的級別也必須是一致的，同樣的縮進代表同樣的級別，程序判別配置的級別是通過縮進結合換行實現的。
5、YAML文件內容和Linux系統大小寫判斷方式保持一致，是區分大小寫的，k/v的值均需大小寫敏感
6、k/v的值可同行寫也可以換行寫。同行使用:分隔。v可以是個字符串，也可以是一個列表
7、一個完整的代碼塊功能需要最少元素包括 name: task

實例演示:

vim a.yaml

- hosts: webserver                  #定義的主機組，即應用的主機
  vars:                             #定義變量
    http_port: 80
    max_clients: 200
  user: root
  tasks:                               #執行的任務
  - name: ensure apache is at the latest version
    yum: pkg=httpd state=latest
  - name: write the apache config file
    template: src=/srv/httpd.j2 dest=/etc/httpd.conf
    notify:
    - restart apache
  - name: ensure apache is running
    service: name=httpd state=started
  handlers:                         #處理器
    - name: restart apache
      service: name=httpd state=restarted

• 執行一個playbook的格式

ansible-playbook [yaml文件名]

實例演示：

#執行劇本
ansible-playbook ping.yaml

參數:

-k(–ask-pass)           用來交互輸入ssh密碼
-K(-ask-become-pass)    用來交互輸入sudo密碼
-u                      指定用戶

補充命令:

#檢查yaml文件的語法是否正確
ansible-playbook nginx.yaml --syntax-check

#檢查tasks任務
ansible-playbook nginx.yaml --list-task

#檢查生效的主機
ansible-playbook nginx.yaml --list-hosts

#指定從某個task開始運行
ansible-playbook nginx.yaml --start-at-task='Copy Nginx.conf'

hosts和users介紹

實例演示:

vim a.yaml

- hosts: webserver               #指定主機組，可以是一個或多個組。
  remote_user: root              #指定遠程主機執行的用戶名

#執行劇本
ansible-playbook a.yaml 

• 在原有基礎上為每個任務定義遠程執行用戶

!vim

- hosts: mysql
  remote_user: root             
  tasks:
    - name: test connection
      ping:
      remote_user: mysql          #指定遠程主機執行tasks的運行用戶為mysql

#執行playbook劇本
ansible-playbook ping.yml -k 

#驗證語法
ansible-playbook a.yml --syntax-check

#執行劇本
ansible-playbook a.yml 

• 指定遠程主機sudo切換用戶

!vim

- hosts: mysql
  remote_user: root            
  become: yes                  #2.6版本以后的參數，之前是sudo，意思為切換用戶運行
  become_user: mysql          #指定sudo用戶為mysql

#執行playbook劇本
ansible-playbook ping.yml -K

#執行劇本
ansible-playbook a.yml 

tasks列表和action

1.Play的主體部分是task列表，task列表中的各任務按次序逐個在hosts中指定的主機上執行，即在所有主機上完成第一個任務后再開始第二個任務。
在運行playbook時（從上到下執行），如果一個host執行task失敗，整個tasks都會回滾，請修正playbook 中的錯誤，然后重新執行即可。
Task的目的是使用指定的參數執行模塊，而在模塊參數中可以使用變量，模塊執行時冪等的，這意味著多次執行是安全的，因為其結果一致。
2.每一個task必須有一個名稱name，這樣在運行playbook時，從其輸出的任務執行信息中可以很好的辨別出是屬于哪一個task的。如果沒有定義name，‘action’的值將會用作輸出信息中標記特定的task。
3.定義一個task，常見的格式:”module: options” 例如：yum: name=httpd
4.ansible的自帶模塊中，command模塊和shell模塊無需使用key=value格式

實例演示:

• 實例1

vim a.yml 

- hosts: webserver
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/sbin/setenforce 0'
   - name: make sure apache is running
     service: name=httpd state=started
#play中只要執行命令的返回值不為0，就會報錯，tasks停止

#檢查語法
ansible-playbook a.yml --syntax-check

#執行劇本
ansible-playbook a.yml 

#檢查結果
rpm -q httpd

修改如下內容:

!vim

- hosts: webserver
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/sbin/setenforce 0'
     ignore_errors: True             #忽略錯誤，強制返回成功
   - name: make sure apache is running
     service: name=httpd state=started

#檢查語法
ansible-playbook a.yml --syntax-check

#執行劇本
ansible-playbook a.yml 

• 實例2

vim b.yml 

- hosts: webserver
  remote_user: root
  tasks:
   - name: create nginx group
     group: name=nginx system=yes gid=208
   - name: create nginx user
     user: name=nginx uid=208 group=nginx system=yes
- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file to mysql
     copy: src=/etc/inittab dest=/opt/inittab.back

#檢查語法
ansible-playbook b.yml --syntax-check

#執行劇本
ansible-playbook b.yml

Handlers介紹

Handlers也是一些task的列表，和一般的task并沒有什么區別。
是由通知者進行的notify，如果沒有被notify，則Handlers不會執行，假如被notify了，則Handlers被執行
不管有多少個通知者進行了notify，等到play中的所有task執行完成之后，handlers也只會被執行一次

實例演示:

vim c.yml

- hosts: webserver
  remote_user: root
  tasks:
   - name: install httpd package
     yum: name=httpd state=latest
   - name: install configuration file for httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
     notify:
      -restart httpd
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:
   - name: restart httpd
     service: name=httpd state=restarted

#檢查語法
ansible-playbook c.yml --syntax-check

#執行劇本
ansible-playbook c.yml

亦可引入一些變量:

!vim

- hosts: webserver
  remote_user: root
  vars:
  - package: httpd
  - service: httpd
  tasks:
   - name: install httpd package
     yum: name={{package}} state=latest
   - name: install configuration file for httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
     notify:
      -restart httpd
   - name: start httpd service
     service: enabled=true name={{service}} state=started
  handlers:
   - name: restart httpd
     service: name={{service}} state=restarted

#檢查語法
ansible-playbook c.yml --syntax-check

#執行劇本
ansible-playbook c.yml

playbook使用變量的方法

1.通過ansible命令傳遞

實例演示:

#編輯如下yml
vim a.yml

- hosts: mysql
  remote_user: root
  vars:
  - user:
  tasks:
  - name: add new user
    user: name={{user}}

#執行劇本
ansible-playbook a.yml -e "user=testvar"

#執行命令查看文件
ansible mysql -m command -a 'tail /etc/passwd'

2.直接在yaml中定義變量---如上handlers示例

3.直接引用一些變量

實例演示:

• 引用ansible的固定變量

vim test.yml

- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}}," dest=/opt/vars.txt

#執行劇本
ansible-playbook test.yml

#在122主機上查看vars.txt文件內容
cat /opt/vars.txt

• 引用主機變量

vim /etc/ansible/hosts

#在mysql組的主機后面添加如下內容
[mysql]
192.168.142.122 testvar="42.122"    #定義testvar變量的值為42.122

vim test.yml      #添加{{testvar}}主機變量

- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}},{{testvar}}" dest=/opt/vars.txt

#執行劇本
ansible-playbook test.yml

#在122主機上查看vars.txt文件內容
cat /opt/vars.txt

條件測試

如果需要根據變量、facts（setup）或此前任務的執行結果來作為某task執行與否的前提時要用到條件測試，在Playbook中條件測試使用when子句。
在task后添加when子句即可使用條件測試：when子句支持正則表達式或語法。

實例演示:

vim when.yml

- hosts: mysql
  remote_user: root
  tasks:
    - name: "shutdown CentOS"
      command: /sbin/shutdown -h now
      when: ansible_distribution == "CentOS"

#執行劇本,執行后會發現192.168.142.122主機已經被關機
ansible-playbook when.yml 

• 多條件判斷

vim when.yml

- hosts: mysql
  remote_user: root
  tasks:
    - name: "shut down CentOS 6 systems"
      command: /sbin/shutdown -r now
      when:
        - ansible_distribution == "CentOS"
        - ansible_distribution_major_version == "6"

#執行劇本
ansible-playbook when.yml 

• 組條件判斷

vim when.yml

- hosts: mysql
  remote_user: root
  tasks:
    - name: "shut down CentOS 6 and Debian 7 systems"
      command: /sbin/shutdown -t now
      when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "6") or
            (ansible_distribution == "Debian" and ansible_distribution_major_version == "7")

#執行劇本
ansible-playbook when.yml 

• 自定義變量進行條件測試

vim when.yml

- hosts: all
  vars:
    exist: "True"
  tasks:
  - name: creaet file
    command:  touch /tmp/test.txt
    when: exist | match("True")

  - name: delete file
    command:  rm -rf /tmp/test.txt
    when: exist | match("False")

#執行劇本
ansible-playbook when.yml 

迭代

當有需要重復性執行的任務時，可以使用迭代機制。其使用格式為將需要迭代的內容定義為item變量引用，并通過with_items語句指明迭代的元素列表即可。

實例演示:

vim  d.yml

- hosts: webserver
  remote_user: root
  tasks:
    - name: "Install Packages"
      yum: name={{ item }} state=latest
      with_items:
        - httpd
        - mysql-server
        - php

#檢查語法
ansible-playbook d.yml --syntax-check

#執行劇本
ansible-playbook d.yml

#在所有主機上查看是否有指定添加的用戶
tail -5 /etc/passwd

亦可自行定義:

vim e.yml

- hosts: webserver
  remote_user: root
  tasks:
    - name: "Add users"
      user: name={{ item.name }} state=present groups={{ item.groups }}
      with_items:
        - { name:'test1', groups:'wheel'}
        - { name:'test2', groups:'root'}

#檢查語法
ansible-playbook e.yml --syntax-check

#執行劇本
ansible-playbook e.yml

#在所有主機上查看是否有指定添加的用戶
tail -5 /etc/passwd

Templates模塊

#創建工作目錄
mkdir templates

#復制配置文件
cp /etc/httpd/conf/httpd.conf templates/httpd.conf.02

#修改httpd.conf.02文件
vim templates/httpd.conf.02
Listen {{http_port}}
ServerName {{ansible_fqdn}}
MaxClients {{maxClients}}

#修改ansible/hosts文件
vim /etc/ansible/hosts
[webserver]
192.168.142.121 http_port=80 maxClients=100
192.168.142.122 http_port=8080 maxClients=200

#編寫劇本
vim apache.yml

- hosts: webserver
  remote_user: root
  vars:
   - package: httpd
   - service: httpd
  tasks:
   - name: install httpd package
     yum: name={{package}} state=latest
   - name: install configuration file for httpd
     template: src=/root/templates/httpd.conf.2 dest=/etc/httpd/conf/httpd.conf
     notify:
      - restart httpd
   - name: start httpd service
     service: enabled=true name={{service}} state=started
  handlers:
   - name: restart httpd
     service: name={{service}} state=restarted

#檢查語法
ansible-playbook e.yml --syntax-check

#執行劇本
ansible-playbook apache.yml

#在兩臺被管理服務器上查看
grep -i listen /etc/httpd/conf/httpd.conf
grep -i maxClient /etc/httpd/conf/httpd.conf
grep -i servername /etc/httpd/conf/httpd.conf

tags模塊

在一個playbook中，我們一般會定義很多個task，如果我們只想執行其中的某一個task或多個task時就可以使用tags標簽功能了。
格式如下：

vim hosts.yml

- hosts: webserver
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/etc/hosts
      tags:
      - only
    - name: touch file
      file: path=/opt/hosts state=touch

#檢查語法
ansible-playbook e.yml --syntax-check

#執行劇本
ansible-playbook hosts.yml --tags="only"
ansible-playbook hosts.ym

事實上，不光可以為單個或多個task指定同一個tags。playbook還提供了一個特殊的tags為always。作用就是當使用always當tags的task時，無論執行哪一個tags時，定義有always的tags都會執行。

實例演示:

vim hosts.yml
- hosts: webserver
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/etc/hosts
      tags:
      - only
    - name: touch file
      file: path=/opt/hosts state=touch
      tags:
      - always

#檢查語法
ansible-playbook e.yml --syntax-check

#為了不影響此次操作刪除遠程主機中/opt/hosts文件
rm -rf /opt/hosts 

#執行劇本
ansible-playbook hosts.yml --tags="only"

#分別在兩臺被管理服務器上去查看文件創建情況
ls /opt/

看完上述內容，你們對Ansible常用模塊有進一步的了解嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！