Ansbile - Playbook 使用_prepend with-优快云博客

本文链接：https://blog.youkuaiyun.com/sssssuuuuu666/article/details/112217785

本文详细介绍Ansible Playbook的使用方法，包括task定义、YAML语法、变量使用、模板文件生成及条件控制等内容。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

参考

介绍

在Playbook中，使用task来定义一个子任务，并在任务中指定需要使用的模块，以及触发条件等信息。最终一个Playbook的Yml文件中可由多个task组成，按照任务顺序对指定主机进行自动化运维

YAML语言

教程

https://www.runoob.com/w3cnote/yaml-intro.html

核心元素

Hosts 执行的远程主机列表
remote_user：指定执行任务时在远程主机上所用的用户
Tasks 任务集
Variables 内置变量或自定义变量在playbook中调用
Templates 模板，可替换模板文件中的变量并实现一些简单逻辑的文件
Handlers 和 notify 结合使用，由特定条件触发的操作，满足条件方才执行，否则不执行
tags 标签指定某条任务执行，用于选择运行playbook中的部分代码。ansible具有幂等性，因此会自动跳过没有变化的部分，即便如此，有些代码为测试其确实没有发生变化的时间依然会非常地长。此时，如果确信其没有变化，就可以通过tags跳过此些代码片断

注：hosts用于指定要执行指定任务的主机，须事先定义在主机清单中

playbook命令

格式

ansible-playbook <filename.yml> ... [options]

常见选项

-C --check          #只检测可能会发生的改变，但不真正执行操作
--list-hosts        #列出运行任务的主机
--list-tags         #列出tag
--list-tasks        #列出task
--limit 主机列表      #只针对主机列表中的主机执行
-v -vv  -vvv        #显示过程

playbook初步

开启远程主机mysql的远程访问权限

[root@localhost playbook]# cat config-mysql.yml 
---
  - hosts: csmp
    gather_facts: no
    tasks:
    - name: Open mysql remote access permissions
      replace: path=/etc/my.cnf.d/server.cnf regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
    - name: restart mysql
      service: name=mysql state=restarted

执行

[root@localhost playbook]# ansible-playbook config-mysql.yml -vv

handlers和notify

作用

只有当关注的资源发生变化时，才会采取一定的操作。在notify中列出的操作成为handler

示例

改写上面的例子，只有当配置文件修改的时候才重启mysql服务

---
  - hosts: csmp
    gather_facts: no
    tasks:
    - name: Open mysql remote access permissions
      replace: path=/etc/my.cnf.d/server.cnf regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
      notify: restart mysql

    handlers:
    - name: restart mysql
      service: name=mysql state=restarted

tags组件

作用

在playbook中，可以利用tags组件，为特定task指定标签，当在执行playbook时，可以只执行特定tags的tasks，而非整个playbook文件

示例

---
  - hosts: csmp
    gather_facts: no
    tasks:
    - name: Open mysql remote access permissions
      replace: path=/etc/my.cnf.d/server.cnf regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
      tags: replace
    - name: restart mysql
      service: name=mysql state=restarted
      tags: effective

此时就可只通过tags执行其中某一个task

[root@localhost playbook]# ansible-playbook config-mysql.yml --list-tags

playbook: config-mysql.yml

  play #1 (csmp): csmp	TAGS: []
      TASK TAGS: [effective, replace]
      
#  -t TAGS, --tags TAGS  only run plays and tasks tagged with these values
[root@localhost playbook]# ansible-playbook -t effective config-mysql.yml

ansible中使用变量

定义

仅能由字母、数字和下划线组成，且只能以字母开头

variable=value

调用

通过{{ variable_name }} 调用变量，且变量名前后建议加空格，有时用“{{ variable_name }}”才生效

使用`setup`模块中变量

要求在playbook中使用，不要用ansible命令调用

---
#var.yml
- hosts: all
  remote_user: root
  gather_facts: yes

  tasks:
    - name: create log file
      file: name=/data/{{ ansible_nodename }}.log state=touch owner=wang mode=600

ansible-playbook  var.yml

在playbook命令行中定义变量

通过-e参数使用

  -e EXTRA_VARS, --extra-vars EXTRA_VARS
                        set additional variables as key=value or YAML/JSON, if
                        filename prepend with @

示例：

---
  - hosts: "{{ server }}"
    gather_facts: no
    tasks:
     - name: Open mysql remote access permissions
       replace: path=/etc/my.cnf.d/server.cnf regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
       notify: restart mysql

    handlers:
     - name: restart mysql
       service: name=mysql state=restarted

在执行时通过-e指定server变量。

[root@localhost playbook]# ansible-playbook config-mysql.yml -e server=10.47.119.156

在playbook文件中定义变量

vars中定义变量，在后续直接使用

---
  - hosts: "{{ server }}"
    gather_facts: no
    vars:
     - path: /etc/my.cnf.d/server.cnf
    tasks:
     - name: Open mysql remote access permissions
       replace: path={{ path }} regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
       notify: restart mysql

    handlers:
     - name: restart mysql
       service: name=mysql state=restarted

使用变量文件

可以在一个独立的playbook文件中定义变量，在另一个playbook文件中引用变量文件中的变量，比playbook中定义的变量优先级高

# 定义变量文件
[root@localhost playbook]# cat config-mysql-var.yml 
---
server_conf_path: /etc/my.cnf.d/server.cnf

# playbook文件中引入使用
[root@localhost playbook]# cat config-mysql.yml 
---
  - hosts: "{{ server }}"
    gather_facts: no
    vars_files:
     - config-mysql-var.yml
    tasks:
     - name: Open mysql remote access permissions
       replace: path={{ server_conf_path }} regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
       notify: restart mysql

    handlers:
     - name: restart mysql
       service: name=mysql state=restarted

主机清单文件中定义变量

主机（普通）变量

在inventory主机清单文件中为指定得主机定义变量，以便在playbook中使用

[root@localhost playbook]# cat /etc/ansible/hosts 
[server]
10.47.119.156 server_conf_path=/etc/my.cnf.d/server.cnf
10.47.119.157 server_conf_path=/etc/my.cnf.d/server1.cnf

组（公共）变量

在inventory 主机清单文件中赋予给指定组内所有主机上的在playbook中可用的变量，如果和主机变是同名，优先级低于主机变量

[root@localhost playbook]# cat /etc/ansible/hosts 
[server]
10.47.119.156 
10.47.119.157 

[server:vars]
server_conf_path=/etc/my.cnf.d/server.cnf

使用时直接使用变量即可

---
  - hosts: "{{ server }}"
    gather_facts: no
    tasks:
     - name: Open mysql remote access permissions
       replace: path={{ server_conf_path }} regexp='^(bind-address=127.0.0.1)' replace='#\1' backup=true
       notify: restart mysql

    handlers:
     - name: restart mysql
       service: name=mysql state=restarted

template模板

jinja2语言

官网

https://jinja.palletsprojects.com/en/2.11.x/

template

功能

可以根据和参考模块文件，动态生成相类似的配置文件

要求

template文件必须存放于templates目录下，且命名为 .j2 结尾
yaml/yml文件需和templates目录平级，目录结构如下示例：

.
├── config.yml
└── templates
	└── nginx.conf.j2

示例

# tree
.
├── config-nginx.yml
└── templates
    └── nginx.conf.j2

设置nginx进程数与ansible_processor_vcpus+1相等

# cat templates/nginx.conf.j2 

...
worker_processes {{ ansible_processor_vcpus+1 }};
...

playbook内容

# cat config-nginx.yml 
---
 - hosts: vm
   tasks: 
   - name: template config to remote hosts
     template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
     notify: restart nginx

   handlers:
   - name: restart nginx
     service: name=nginx state=restarted

使用setup模块发现ansible_processor_vcpus值为4，所以模板文件中对应nginx子进程数应为5

# ansible vm -m setup -a 'filter=ansible_processor_vcpus'          
10.91.156.205 | SUCCESS => {
    "ansible_facts": {
        "ansible_processor_vcpus": 4, 
        "discovered_interpreter_python": "/usr/bin/python"
    }, 
    "changed": false
}

统计nginx子进程数目

# ansible vm -m 'shell' -a "ps aux | grep 'nginx: worker process' "
10.91.156.205 | CHANGED | rc=0 >>
nginx    24585  0.0  0.0 105956  3444 ?        S    15:05   0:00 nginx: worker process
nginx    24586  0.0  0.0 105956  3444 ?        S    15:05   0:00 nginx: worker process
nginx    24587  0.0  0.0 105956  3444 ?        S    15:05   0:00 nginx: worker process
nginx    24588  0.0  0.0 105956  3444 ?        S    15:05   0:00 nginx: worker process
nginx    24589  0.0  0.0 105956  3448 ?        S    15:05   0:00 nginx: worker process
...

流程控制

template中可使用流程控制 for 循环和 if 条件判断，实现动态生成文件功能

for循环

示例

j2文件：

 ...
 {% for port in listen_ports %}
    server {
        listen {{ port }};
        root /usr/share/nginx/html;

        location / {
        }
    }

    {% endfor %}
...

playbook文件中src指定j2文件，拷贝到远程主机后记得要修改名称

---
 - hosts: vm
   gather_facts: no
   vars: 
     listen_ports:
     - 8888
     - 8889
   tasks: 
   - name: template config to remote hosts
     template: src=nginx-server.conf.j2 dest=/etc/nginx/nginx.conf backup=true
     notify: restart nginx

   handlers:
   - name: restart nginx
     service: name=nginx state=restarted

验证发现服务器nginx.cnf中多出了8888，8889两个server

...  
    server {
        listen 8888;
        root /usr/share/nginx/html;

        location / {
        }
    }

    server {
        listen 8889;
        root /usr/share/nginx/html;

        location / {
        }
    }
....

若vars中变量是字典形式，形如

vars:
    nginx_vhosts:
      - listen: 8080
        server_name: "web1.magedu.com"
        root: "/var/www/nginx/web1/"
      - listen: 8081
        server_name: "web2.magedu.com"
        root: "/var/www/nginx/web2/"

jinja2就需要使用如下方式调用

{% for vhost in nginx_vhosts %}
server {
   listen {{ vhost.listen }}
   server_name {{ vhost.server_name }}
   root {{ vhost.root }}  
}
{% endfor %}

if 判断

在模板文件中可通过条件判断，来决定相关配置得生成信息。例如

# cat if-config.yml
---
 - hosts: vm
   gather_facts: no
   vars:
     nginx_vhosts:
      - listen: 80
        server_name: "server1"
        root: "/var/www/nginx/web1"
      - listen: 8080
        root: "var/www/nginx/web2"

   tasks:
    - name: template config if exp
      template: src=if-config.cnf.j2 dest=/root/if-config.cnf

模板文件

# cat templates/if-config.cnf.j2 

{% for vhosts in nginx_vhosts %}
server {
    listen {{ vhosts.listen }}
    {% if vhosts.server_name is defined %}
    server_name {{ vhosts.server_name }}
    {% endif %}
    root {{ vhosts.root }}
}
{% endfor %}

最终生成结果

#结果
server {
    listen 80
    server_name server1
    root /var/www/nginx/web1
}
server {
    listen 8080
    root var/www/nginx/web2
}

playbook使用when

when语句，可实现条件测试。如果需要根据变量，facts或此前任务得执行结果来作为某task执行与否的前提时要用到条件测试。通过在task后添加when子句即可使用条件测试。

示例

如果ansible_os_family值为RedHat则创建/root/redhat目录，否则创建/root/others目录

---
 - hosts: vm
   tasks:
   - name: mkdir redhat dir
     shell: mkdir /root/redhat
     when: ansible_os_family == "RedHat"
   - name: mkdir other dir
     shell: mkdir /root/otherOs
     when: ansible_os_family != "RedHat"

迭代with_items

作用

当有需要重复性执行的任务时，可以使用迭代机制。对迭代项的引用，固定变量名为"item"。要在task中使用with_items给定要迭代的元素列表

列表元素格式

字符串

---
 - hosts: vm
   gather_facts: no

   tasks:
    - name: install tools
      yum: name={{ item }} state=installed
      with_items:
       - lrzsz
       - wget

等同于

---
 - hosts: vm
   gather_facts: no

   tasks:
    - name: install lrzsz
      yum: name=lrzsz state=installed
    - name: install wget
      yum: name=wget state=installed

字典

---
 - hosts: vm
   gather_facts: no

   tasks:
    - name: copy config file
      copy: src={{ item.src }} dest={{ item.dest }}
      with_items:
       - { src: /root/src1.cnf, dest: /root/dest1.txt }
       - { src: /root/src2.cnf, dest: /root/dest2.txt }