Ansible之Playbook詳解、案例

什么是playbook

playbooks是一個不同於使用Ansible命令行執行方式的模式，其功能更強大靈活。
簡單來說，playbook是一個非常簡單的配置管理和多主機部署系統，不同於任何已經存在的模式，可作為一個適合部署復雜應用程序的基礎。
Playbook可以定制配置，可以按照指定的操作步驟有序執行，支持同步和異步方式。
值得注意的是playbook是通過YAML格式來進行描述定義的。
playbook是由一個或多個模塊組成的，使用多個不同的模塊，完成一件事情。
playbook通過yaml語法識別描述的狀態文件。擴展名是yaml

YAML語法

縮進
    YAML使用一個固定的縮進風格表示層級結構,每個縮進由兩個空格組成, 不能使用tab

冒號
    以冒號結尾的除外，其他所有冒號后面所有必須有空格。

短橫線
    表示列表項，使用一個短橫杠加一個空格。
    多個項使用同樣的縮進級別作為同一列表。

核心元素

Tasks：任務，由模板定義的操作列表
Variables：變量
Templates：模板，即使用模板語法的文件
Handlers：處理器 ，當某條件滿足時，觸發執行的操作
Roles：角色

hosts和users介紹

---
- hosts: abc                   #可以是一個主機組、主機、多個主機，中間以冒號分隔，也可以用all參數表示所有主機
    remote_user: root          #表示執行的用戶賬號 
    become: yes                #2.6版本以后的參數，之前是sudo，意思為切換用戶運行
    become_user: mysql         #指定sudo用戶為mysql
become 和become_user 作為指定遠程主機sudo切換用

Tasks list 和action介紹

1、Play的主體部分是task列表，task列表中的各任務按次序逐個在hosts中指定的主機上執行，即在所有主機上完成第一個任務后再開始第二個任務。

2、在運行playbook時（從上到下執行），如果一個host執行task失敗，整個tasks都會回滾，請修正playbook 中的錯誤，然后重新執行即可。

3、每一個task必須有一個名稱name，這樣在運行playbook時，從其輸出的任務執行信息中可以很好的辨別出是屬於哪一個task的。
   如果沒有定義name，‘action’的值將會用作輸出信息中標記特定的task。
   
4、定義一個task，常見的格式:”module: options” 例如：yum: name=httpd

5、ansible的自帶模塊中，command模塊和shell模塊無需使用key=value格式

 常用命令

# ansible-playbook first.yml --syntax-check    #檢查yaml文件的語法是否正確
# ansible-playbook first.yml --list-task       #檢查tasks任務
# ansible-playbook first.yml --list-hosts      #檢查生效的主機
# ansible-playbook first.yml --start-at-task='Copy Nginx.conf'     #指定從某個task開始運行
# ansible-playbook first.yml -k      #用來交互輸入ssh密碼
# ansible-playbook first.yml -K      #用來交互輸入sudo密碼
# ansible-playbook first.yml -u      #指定用戶

playbook變量

變量使用

變量定義有三種方式

1) playbook的yaml文件中定義變量賦值
2) --extra-vars執行參數賦給變量
3) 在文件中定義變量

1、playbook的yaml文件中定義變量賦值

- hosts: all
  vars:  #定義變量
    file_name: bgx_yaml_vars

  tasks:
  - name: # {{ file_name }}引用上面定義的變量
    file: path=/tmp/{{ file_name }} state=touch
    
    
#playbook執行，在/tmp目錄創建bgx_yaml_vars文件

2、--extra-vars執行參數賦給變量

[root@manager ~]# cat f3.yml
- hosts: all

  tasks:
  - name: Create New File
    file: path=/tmp/{{ file_name }} state=touch

#playbook執行時傳入file_name變量的參數，在/tmp目錄創建bgx_extra-vars文件
[root@manager ~]# ansible-playbook f2.yml --extra-vars "file_name=bgx_extra-vars"

3) 在文件中定義變量: 可以在/etc/ansible/hosts主機組中定義，然后使用palybook進行調度該變量

cat /etc/ansible/hosts
[ceshi]
10.17.12.98
10.17.12.99
10.17.12.60
[ceshi:vars]
file_name=bgx_filename

[root@manager ~]# cat f4.yml
---
- hosts: all

  tasks:
  - name: Create New File
    file: path=/tmp/{{ file_name }} state=touch

#playbook執行，在/tmp目錄創建bgx_filename文件

如果定義的變量出現重復，且造成沖突，優先級如下：

1.extra-vars外置傳參的優先級最高 [所有執行的主機都生效]
2.定義在yml文件中的優先級其次 [所有執行的主機都生效]
3.hosts文件中定義的變量優先級最低 [當前主機組定義會生效]

變量注冊

1) 注冊變量: register關鍵字可以存儲指定命令的輸出結果到一個自定義的變量中

[root@manager ~]# cat f5.yml
---
- hosts: all
  tasks:
    - name:
      shell: netstat -lntp
      register: System_Status

    - name: Get System Status
      debug: msg={{System_Status.stdout_lines}}

#playbook執行結果

條件判斷

playbook中的條件判斷語句使用when

- hosts: all
  remote_user: root
  tasks:
#如果系統中存在主機名為nfs或者backup的主機，則創建文件
    - name: Create File
      file: path=/tmp/this_is_{{ ansible_hostname }}_file state=touch
      when: (ansible_hostname == "nfs") or (ansible_hostname == "backup")

#系統為centos的主機才會執行
    - name: Centos Install httpd
      yum: name=httpd state=present
      when: (ansible_distribution == "CentOS")

#系統為ubuntu的主機才會執行
    - name: Ubuntu Install httpd
      yum: name=httpd2 state=present
      when: (ansible_distribution == "Ubuntu")

循環語句

1、標准循環使用場景-批量安裝軟件

[root@manager ~]# cat f7.yml
---
- hosts: all
  remote_user: root
  tasks:
    - name: Installed Pkg
      yum: name={{ item }} state=present
      with_items:
        - wget
        - tree
        - lrzsz

2、標准循環使用場景-批量創建用戶

[root@manager ~]# cat f7.yml
- hosts: all
  remote_user: root
  tasks:
    - name: Add Users
      user: name={{ item.name }} groups={{ item.groups }} state=present
      with_items:
        - { name: 'testuser1', groups: 'bin' }
        - { name: 'testuser2', groups: 'root' }

3、標准循環使用場景-拷貝多個目錄

[root@manager ~]# cat f7.yml
- hosts: all
  remote_user: root
  tasks:
    - name: Configure Rsync Server
      copy: src={{ item.src }} dest=/etc/{{ item.dest }} mode={{ item.mode }}
      with_items:
        - {src: "rsyncd.conf", dest: "rsyncd.conf", mode: "0644"}
        - {src: "rsync.passwd", dest: "rsync.passwd", mode: "0600"}

異常處理

默認Playbook會檢查命令和模塊的返回狀態，如遇到錯誤就中斷playbook的執行
加入參數: ignore_errors: yes 忽略錯誤 

[root@manager ~]# cat f9.yml
---
- hosts: all
  remote_user: root
  tasks:
    - name: Ignore False
      command: /bin/false
      ignore_errors: yes

    - name: touch new file
      file: path=/tmp/bgx_ignore state=touch

tags標簽

1、打標簽
對一個對象打一個標簽
對一個對象打多個標簽
對多個對象打一個標簽

2、標簽使用，通過tags和任務對象進行捆綁，控制部分或者指定的task執行
-t: 執行指定的tag標簽任務
--skip-tags: 執行--skip-tags之外的標簽任務

[root@manager ~]# cat f10.yml
---
- hosts: all
  remote_user: root
  tasks:
    - name: Install Nfs Server
      yum: name=nfs-utils state=present
      tags:
        - install_nfs
        - install_nfs-server

    - name: Service Nfs Server
      service: name=nfs-server state=started enabled=yes
      tags: start_nfs-server

 使用-t指定tags執行, 多個tags使用逗號隔開即可

[root@manager ~]# ansible-playbook -t install_nfs-server f10.yml

 使用--skip-tags排除不執行的tags

[root@manager ~]# ansible-playbook --skip-tags install_nfs-server f10.yml

playbook參數

執行方式：ansible-playbook playbook.yml [options]

 -u REMOTE_USER, --user=REMOTE_USER  
＃ ssh連接的用戶名

 -k, --ask-pass    
＃ssh登錄認證密碼

 -s, --sudo           
＃sudo 到root用戶相當於Linux系統下的sudo命令

 -U SUDO_USER, --sudo-user=SUDO_USER    
＃sudo到對應的用戶

 -K, --ask-sudo-pass     
＃用戶的密碼（—sudo時使用）

 -T TIMEOUT, --timeout=TIMEOUT 
＃ ssh連接超時，默認10秒

 -C, --check      
＃ 指定該參數后，執行playbook文件不會真正去執行,而是模擬執行一遍，然后輸出本次執行會對遠程主機造成的修改

 -e EXTRA_VARS, --extra-vars=EXTRA_VARS    
＃ 設置額外的變量如：key=value形式或者 YAML or JSON，以空格分隔變量，或用多個-e

 -f FORKS, --forks=FORKS    
＃ 進程並發處理，默認5

 -i INVENTORY, --inventory-file=INVENTORY   
＃ 指定 hosts 文件路徑，默認 default=/etc/ansible/hosts

 -l SUBSET, --limit=SUBSET    
＃ 指定一個pattern，對-hosts:匹配到的主機再過濾一次

 --list-hosts  
＃ 只打印有哪些主機會執行這個playbook文件，不是實際執行該playbook

 --list-tasks   
＃ 列出該playbook中會被執行的task

 --private-key=PRIVATE_KEY_FILE   
＃ 私鑰路徑

 --step    
＃ 同一時間只執行一個task，每個task 執行前都會提示確認一遍

 --syntax-check  
＃ 只檢測playbook文件語法是否有問題，不會執行該playbook 

 -t TAGS, --tags=TAGS   
＃當play和task的tag為該參數指定的值時才執行，多個tag以逗號分隔

 --skip-tags=SKIP_TAGS   
＃ 當play和task的tag不匹配該參數指定的值時，才執行

 -v, --verbose   
＃輸出更詳細的執行過程信息，-vvv可得到所有執行過程信息。

實例

1、簡單實例

創建一個first.yml文件

---
- hosts: 10.17.12.60  #指定主機
  remote_user: root   #指定在被管理的主機上執行任務的用戶
  tasks:              #任務列表
  - name: disabled firewall #任務名關閉防火牆
    command: 'systemctl stop firewalld.service'  #調用command模塊執行命令

注意-后面有空格

注意對齊關系，注意語法不然很容易會報錯

ansible-playbook first.yml --syntax-check    #檢查yml文件的語法是否正確
ansible-playbook a.yml  #執行

• play中只要執行命令的返回值不為0，就會報錯，tasks停止，可以添加下面
• ignore_errors: True #忽略錯誤，強制返回成功

2、批量安裝nginx

1、編輯playbook代碼

[root@localhost ansible]# more second.yml 
---
- hosts: all
  tasks:
      - name: Extended Nginx
        yum: name=epel-release state=present
      - name: Install Nginx Package
        yum: name=nginx state=present
      - name: Copy Nginx.conf
        template: src=./nginx.conf.j2 dest=/etc/nginx/nginx.conf owner=root group=root mode=0644 validate='nginx -t -c %s'
        notify:
             - Restart Nginx Service
  handlers:
      - name: Restart Nginx Service
        service: name=nginx state=restarted

#使用template模塊去管理/etc/nginx/nginx.conf文件，owner,group定義該文件的屬主與屬組，validate參數是指文件生成后使用nginx -t -c %s命令去做nginx語法檢測          
#notify是觸發handlers，如果同步后，文件的MD5值有變化會觸發ReStart Nginx Service 這個handlers

2、編輯nginx.conf.j2文件

 

# 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_cores}};
error_log /var/log/nginx/error.log;
pid /run/nginx.pid;

# Load dynamic modules. See /usr/share/nginx/README.dynamic.
include /usr/share/nginx/modules/*.conf;

events {
    worker_connections 1024;
}

http {
    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

    access_log  /var/log/nginx/access.log  main;

    sendfile            on;
    tcp_nopush          on;
    tcp_nodelay         on;
    keepalive_timeout   65;
    types_hash_max_size 2048;

    include             /etc/nginx/mime.types;
    default_type        application/octet-stream;

    # Load modular configuration files from the /etc/nginx/conf.d directory.
    # See http://nginx.org/en/docs/ngx_core_module.html#include
    # for more information.
    include /etc/nginx/conf.d/*.conf;

    server {
        listen       80 default_server;
        listen       [::]:80 default_server;
        server_name  _;
        root         /usr/share/nginx/html;

        # Load configuration files for the default server block.
        include /etc/nginx/default.d/*.conf;

        location / {
        }

        error_page 404 /404.html;
            location = /40x.html {
        }

        error_page 500 502 503 504 /50x.html;
            location = /50x.html {
        }
    }

# Settings for a TLS enabled server.
#
#    server {
#        listen       443 ssl http2 default_server;
#        listen       [::]:443 ssl http2 default_server;
#        server_name  _;
#        root         /usr/share/nginx/html;
#
#        ssl_certificate "/etc/pki/nginx/server.crt";
#        ssl_certificate_key "/etc/pki/nginx/private/server.key";
#        ssl_session_cache shared:SSL:1m;
#        ssl_session_timeout  10m;
#        ssl_ciphers HIGH:!aNULL:!MD5;
#        ssl_prefer_server_ciphers on;
#
#        # Load configuration files for the default server block.
#        include /etc/nginx/default.d/*.conf;
#
#        location / {
#        }
#
#        error_page 404 /404.html;
#            location = /40x.html {
#        }
#
#        error_page 500 502 503 504 /50x.html;
#            location = /50x.html {
#        }
#    }

}

此處注意在其中指定了一個變量worker_processes {{ ansible_processor_cores}};

他針對nginx的worker_process參數通過facts信息中的cpu核心數目生成，其他的配置都是默認的。

3、檢測可行性，並確認信息

ansible-playbook second.yml --syntax-check  
ansible-playbook second.yml --list-hosts
ansible-playbook second.yml --list-task

 

4、執行命令

ansible-playbook second.yml

 

查看檢驗，各主機nginx都已經安裝，並且參數也已經按照需求修改，docker啟動狀態。