【Ansible】Ansible Playbook 的任务控制

最新推荐文章于 2023-08-16 09:00:00 发布
最新推荐文章于 2023-08-16 09:00:00 发布
阅读量613 收藏
点赞数
分类专栏： ansible 文章标签： ansible nginx 运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/guanguan12319/article/details/128644405
版权

Ansible Playbook 的任务控制

文章目录

在这里插入图片描述

一、Ansible 任务控制基本介绍

任务控制类似于编程语言中的 if …、for …等逻辑控制语句。下面让我们通过一个实际应用场景案列去说明在 playbook 中，任务控制如何应用。

在下面的 playbook 中，我们创建了 tomcat 、www 和 mysql 三个用户。安装了 nginx 软件包、并同时更新了 nginx 主配置文件和虚拟主机配置文件，最后让nginx服务处于启动状态。

整个 playbook 从语法上没有任何问题，但从逻辑和写法上仍然有一些地方需要我们去注意和优化：

1、nginx 启动逻辑欠缺考虑，若nginx的配置文件语法错误则会导致启动 nginx 失败，以至于 playbook 执行失败。
2、批量创建用户，通过指令的罗列过于死板。如果在创建若干个用户，将难以收场。

---
- name: task control playbook example
  hosts: web_servers
  tasks:
    - name: create tomcat user
      user: name=tomcat state=present

    - name: create www user
      user: name=www state=present

    - name: create mysql user
      user: name=mysql state=present

    - name: yum nginx web_servers
      yum: name=nginx state=present
    
    - name: update nginx main config
      copy: src=nginx.conf dest=/etc/nginx
    
    - name: add virtualhost config
      copy: src=www.guan.com.cnf  dest=/etc/nginx/conf.d/
    
    - name: start nginx server
      service: name=nginx state=started

...

二、条件判断

1.解决第一个问题

nginx 启动逻辑欠考虑，若nginx的配置文件语法错误则会导致启动nginx失败，以至于playbook执行失败。

如果我们能够在启动之前去对nginx的配置文件语法做正确性的校验，只有当校验通过的时候我们才去启动或者重启nginx，否则跳过启动 nginx的过程。这样就会避免nginx 配置文件语法问题而导致的无法启动 nginx 的风险。

2.nginx 语法校验

- name: check ngixn syntax
  shell: /usr/sbin/nginx -t

那么如何将 nginx 语法检查的 task 与 nginx 启动的 task 关联起来呢？

如果我们能够获得语法检查的 task 的结果，根据这个结果去判断"启动 nginx 的 task 是否执行，这将是一个很好的方案。"

如何和获取到语法检查 task 的结果呢？此时，就可以使用之前学过的 ansible 中的注册变量。

[root@master1 ~]# vim www.guan.com.conf
[root@master1 ~]# cat www.guan.com.conf
server {
    listen 80;
    server_name www.guan.com.conf;
    root /usr/share/nginx/html;
    access_log /var/log/nginx/www.guan.com-access_log main;
    error_log /var/log/nginx/www.guan.com-error_log;

    add_header Access-Control-Allow-Origin *;
    
    location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$ {
            expires     1d;
    }

    location ~ .\.(js|css)$? {
            expires     1d;
    }
}
[root@master1 ~]# cat site.yml
---
- name: task control playbook example
  gather_facts : no
  hosts: web_servers
  tasks:
    - name: yum nginx web_servers
      yum: name=nginx state=present
    
    - name: update nginx main config
      copy: src=nginx.conf dest=/etc/nginx
    
    - name: add virtualhost config
      copy: src=www.guan.com.cnf  dest=/etc/nginx/conf.d/
    
    - name: check nginx syntax
      shell: /usr/sbin/nginx -t
      register: nginx_syntax

    - name: print nginx syntax
      debug: var=nginx_syntax

    - name: start nginx server
      service: name=nginx state=started
      when: nginx_syntax.rc == 0
   


...

[root@master1 ~]# ansible-playbook  -i hosts site.yml

以上的逻辑，只要语法检查通过都会去执行 " start nginx service " 这个 task。在这个问题里，我们学习了 when 条件判断和注册变量的结合使用。在学了 when 条件判断中是可以支持复杂逻辑的，比如现在用到的逻辑运算符 and。

另外 when 支持如下运算符：

==
!=
> 、>=
< 、<=
is defined
is not defined
true
false
支持逻辑运算符：and or

三、循环控制

  • 批量创建用户，通过指令的罗列过于死板，如果在创建若干个用户，将难以收场。

  • 如果在创建用户时，抛开 playbook 的实现不说，单纯的使用shell去批量的创建一些用户，该怎么写才方便呢？

#!/bin/bash
create_user="tomcat mysql www"
for i in `create_user`
do
	useradd $i
done

那么如果 playbook 中也存在这样的循环控制，我们也可以像写 shell 一样简单的去完成多用户创建工作。

在 playbook 中使用 with_items 去实现循环控制，且循环时的时间变量（上面shell 循环中 $i 变量）只能是 关键字 item，而不能是随意自定义的。

基于上面的基础，进一步优化了 playbook

在这里使用定义了剧本变量 create_user（一个列表），然后通过 with_items 循环遍历这个变量来达到创建用户的目的。

---
- name: task control playbook example
  hosts: web_servers
  gather_facts: no
  vars:
    create_user:
      - tomcat
      - www
      - mysql
  tasks:
    - name: create  user
      user: name={{ item }} state=present
      with_items: {{ create_user}}
      
    
    
...

执行

[root@master1 ~]# ansible-playbook  -i hosts site01.yml

PLAY [task control playbook example] ******************************************************************

TASK [create  user] ***********************************************************************************
changed: [192.168.200.183] => (item=tomcat)
changed: [192.168.200.183] => (item=www)
ok: [192.168.200.183] => (item=mysql)

PLAY RECAP ********************************************************************************************
192.168.200.183            : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[root@master1 ~]#

进一步优化后

[root@master1 ~]# vim loop.yml
[root@master1 ~]# ansible-playbook  -i hosts loop.yml

PLAY [loop item] **************************************************************************************

TASK [show item] **************************************************************************************
ok: [192.168.200.182] => (item=a) => {
    "a": "VARIABLE IS NOT DEFINED!", 
    "ansible_loop_var": "item", 
    "item": "a"
}
ok: [192.168.200.182] => (item=b) => {
    "ansible_loop_var": "item", 
    "b": "VARIABLE IS NOT DEFINED!", 
    "item": "b"
}
ok: [192.168.200.182] => (item=c) => {
    "ansible_loop_var": "item", 
    "c": "VARIABLE IS NOT DEFINED!", 
    "item": "c"
}
ok: [192.168.200.183] => (item=a) => {
    "a": "VARIABLE IS NOT DEFINED!", 
    "ansible_loop_var": "item", 
    "item": "a"
}
ok: [192.168.200.183] => (item=b) => {
    "ansible_loop_var": "item", 
    "b": "VARIABLE IS NOT DEFINED!", 
    "item": "b"
}
ok: [192.168.200.183] => (item=c) => {
    "ansible_loop_var": "item", 
    "c": "VARIABLE IS NOT DEFINED!", 
    "item": "c"
}

TASK [show item when item > 3] ************************************************************************
skipping: [192.168.200.183] => (item=1) 
skipping: [192.168.200.183] => (item=2) 
skipping: [192.168.200.182] => (item=1) 
skipping: [192.168.200.182] => (item=2) 
skipping: [192.168.200.182] => (item=3) 
ok: [192.168.200.182] => (item=5) => {
    "5": "VARIABLE IS NOT DEFINED!", 
    "ansible_loop_var": "item", 
    "item": 5
}
ok: [192.168.200.182] => (item=6) => {
    "6": "VARIABLE IS NOT DEFINED!", 
    "ansible_loop_var": "item", 
    "item": 6
}
skipping: [192.168.200.183] => (item=3) 
ok: [192.168.200.183] => (item=5) => {
    "5": "VARIABLE IS NOT DEFINED!", 
    "ansible_loop_var": "item", 
    "item": 5
}
ok: [192.168.200.183] => (item=6) => {
    "6": "VARIABLE IS NOT DEFINED!", 
    "ansible_loop_var": "item", 
    "item": 6
}

PLAY RECAP ********************************************************************************************
192.168.200.182            : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
192.168.200.183            : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[root@master1 ~]# cat loop.yml
- name: loop item
  hosts: all
  gather_facts: no
  vars:
    some_list:
      - "a"
      - "b"
      - "c"
    num_list:
      - 1
      - 2
      - 3
      - 5
      - 6

  tasks:
    - name: show item
      debug:
        var: "{{ item }}"
      loop: "{{ some_list }}"
    - name: show item when item > 3
      debug:
        var: "{{ item }}"
      loop: "{{ num_list }}"
      when: item > 3

[root@master1 ~]#

考虑到这样一个情况：

若更新了 nginx 的配置文件后，我们需要通过 playbook 将新的配置发布到生产服务器上，然后重新加载我们的nginx服务器，但以现在的playbook来说，每次更改nginx配置文件后虽然可以通过它发布到生产，但整个 playbook 都要执行一次，这样无形中扩大了变更范围和变更风险。

下面的 Tags 属性就可以解决这个问题。

四、Tags 属性

我们可以通过 play中的tags属性，去解决目前 playbook 变更而导致的扩大变更范围和变更风险的问题。

在改进的 playbook 中，针对文件发布 task 任务 “update nginx main config” 和 “add virtualhost config” 新增了属性 tags ，属性值为 updateconfig。另外我们新增了"reload nginx server" task 任务，当配置文件更新后，去reload nginx 服务。那重新加载需要依赖于 nginx 服务是已经启动状态。所以，还需要进一步通过判断 nginx 的pid 文件存在，才证明 nginx 服务本身是启动中，才可以reload nginx 服务。

判断一个文件是否存在使用 start 模块

- name： check nginx running
  stat: path=/var/run/nginx.pid
  register: nginx_running

观察结果，会发现 nginx_running.stat.exists 的值是true 就表示启动状态，是false就是关闭状态。

接下来就可以根据这个结果，来决定是否重新加载nginx 服务。

优化之后的 playbook

- name: task control playbook example
  hosts: web_servers
  gather_facts: no
  vars:
    create_user:
      - tomcat
      - www
      - mysql
  tasks:
    - name: create  user
      user: name={{ item }} state=present
      with_items: "{{ create_user }}"
  
    - name: yum nginx web_servers
      yum: name=nginx state=present
    
    - name: update nginx main config
      copy: src=nginx.conf dest=/etc/nginx/
      tags: update_config
    
    - name: add virtualhost config
      copy: src=www.guan.com.cnf  dest=/etc/nginx/conf.d/
      tags: update_config
    
    - name: check nginx syntax
      shell: /usr/sbin/nginx -t
      register: nginx_syntax
      tags: update_config
    
    - name: check nginx running
      stat: path=/var/run/nginx.pid
      register: nginx_running
      tags: update_config

    - name: print nginx syntax
      debug: var=nginx_syntax
      
    - name: print nginx syntax
      debug: var=nginx_running

    - name: reload nginx server
      service: name=nginx state=started
      when: nginx_syntax.rc == 0 and nginx_running.stat.exists == true
      tags: update_config
      
    - name: start nginx server
      service: name=nginx state=started
      when: 
        - nginx_syntax.rc == 0 
        - nginx_running.stat.exists == false
      tags: update_config

指定 tags 去执行 playbook
执行时一定要指定 tags，这样在执行过程中只会执行 task 任务上打上 tag 标记为 update_config 的任务

[root@master1 ~]# ansible-playbook -i  hosts site02.yml -t update_config

五、Handlers 属性

观察当前的 playbook ，不难发现，当我们的配置文件没有发生变化是，每次依然都会去触发 task “reload nginx server”,这样的处理才是最完美的实现。此时，可以使用 handlers 属性。

优化后的 playbook

- name: task control playbook example
  hosts: web_servers
  gather_facts: no
  vars:
    create_user:
      - tomcat
      - www
      - mysql
  tasks:
    - name: create  user
      user: name={{ item }} state=present
      with_items: "{{ create_user }}"
  
    - name: yum nginx web_servers
      yum: name=nginx state=present
    
    - name: update nginx main config
      copy: src=nginx.conf dest=/etc/nginx/
      tags: update_config
      notify: reload nginx server
    
    - name: add virtualhost config
      copy: src=www.guan.com.cnf  dest=/etc/nginx/conf.d/
      tags: update_config
      notify: reload nginx server
    
    - name: check nginx syntax
      shell: /usr/sbin/nginx -t
      register: nginx_syntax
      tags: update_config
    
    - name: check nginx running
      stat: path=/var/run/nginx.pid
      register: nginx_running
      tags: update_config
      
    - name: start nginx server
      service: name=nginx state=started
      when: 
        - nginx_syntax.rc == 0 
        - nginx_running.stat.exists == false
      tags: update_config
  handlers:
    - name: reload nginx server
      service: name=nginx state=reload
      when:
        - nginx_syntax.rc == 0
        - nginx_running.stat.exists == true

在改进的 playbook 中，我们针对文件发布task任务 “update config” 和 “add virtualhost config” 增加了新属性 notify，值为"reload nginx server"。

意思是说，针对这两个文件发布的task，设置一个通知机制，当 ansible 认为文件的内容发生了变化（文件MD5发生了变化了），它就会发送一个通知信号，通知 handlers 中的某一个任务。具体发送到 handlers 中的那个任务，由notify的值 “reload nginx server” 决定。通知发出后 handlers 会根据发送的通知，在handlers中相关的任务重寻找名称为 “reload nginx server” 的任务。

当发现存在这样名字的 task，就会执行它。若没有找到，则什么也不做。若我们要实现这样的机制千万要注意notify属性设置的值，一定要确保能和 handlers 中的 task 名称对应上。

执行
首次执行，若配置文件没有发生变化，可以发现根本就没有触发 handlers 中 task 任务

[root@master1 ~]# ansible-playbook -i  hosts site02.yml -t update_config

人为对 nginx 配置文件稍作修改，只要 MD5 校验值发生变化即可。此时，在执行发现出发了 handlers 中的 task 任务。

guan12319
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
python中Ansible模块的Playbook的具体使用
09-16
除了基本的结构和语法之外，Ansible还为Playbook提供了一系列高级功能，使用户能够在复杂的部署场景中更加灵活地控制自动化流程。 - **变量**: 在Playbook中可以定义和使用变量，这对于参数化任务非常有用。 - **...
ansible crontab任务管理 —— 筑梦之路
最新发布
筑梦之路
12-15 788
是你要管理 crontab 的目标主机的列表。name字段是 crontab 条目的名称，minute和hour字段是定时任务的执行时间，job字段是要执行的脚本或命令。
ansible-playbook剧本案例6远程批量添加定时任务
qq_34953582的博客
08-16 412
ansible-playbook剧本案例6
多台主机修改或写入文件并添加定时任务操作
weixin_49443980的博客
05-25 267
多台主机修改或写入文件并添加定时任务操作
ansible常用模块使用及详细demo
Pert的博客
01-24 551
PS：利用ansible程序user模块设置用户密码信息，需要将密码明文信息转换为密文信息进行设置。PS：ansible可以删除的定时任务，只能是ansible设置好的定时任务。remote_src:：把客户端下src的文件复制到客户端的dest路径下。复制目录信息的时候有斜线是将目录内容复制过去、没有斜线将目录本身也复制过去。backup：对原文件进行备份，防止传输的文件覆盖原文件。=file：检测创建的数据是否存在，绿色存在，红色不存在。扩展用法：设置的时候加上注释，如果存在就不再新建任务。
05ansible之playbook （第三部分）
weixin_45598345的博客
07-17 245
playbook1.playbook介绍与应用01.playbook（剧本）的组成02.简单编写一个playbook剧本三级目录 1.playbook介绍与应用 上次课补充与回顾： 01.playbook（剧本）的组成 play：定义的是主机的角色 task：定义的是具体执行的任务 playbook：由一个或多个play组成，一个play可以包含多个task 任务，简单理解为，使用不同的模块完成一件事情 02.简单编写一个playbook剧本 在backup和nfs01机器中添加
openssh升级ansible-playbook
12-25
总结来说，"openssh升级ansible-playbook"涉及到的是使用Ansible Playbook自动化OpenSSH的升级过程，通过定义目标主机、编写升级任务并可能封装成角色，实现高效且一致的系统管理。这样的做法不仅提高了效率，还能...
Ansible之Playbook使用
04-28
tags 是任务可以通过“tags“打标签，而后可在 ansible-playbook 命令上使用-t 指定进行调用。注意：如果多个任务标签相同，标签被调用时，任务都会被执行。 Ansible的Playbook使用可以帮助开发者快速搭建和部署...
集群运维自动化工具ansible之使用playbook安装zabbix客户端
09-30
Playbook是Ansible的核心概念，它是一组定义了在目标主机上执行任务的YAML文件。在本文的示例中，有两个主要的目录：`zabbix_client_install` 和 `zabbix_client_delete`。前者用于安装Zabbix客户端，后者用于删除已...
ansible学习之playbook剧本编写
01-20
Ansible 是一款强大的自动化运维工具，它允许管理员通过编写 YAML 格式的剧本（playbook）来执行配置管理、应用部署、任务自动化等操作。在 Ansible 中，playbook 是主要的配置和部署文件，用于定义一系列的任务...
ansible 实用技巧 批量查看各个节点的其他用户的定时任务,以及批量拷贝文件
mtj66的博客，交流WX:SpringBreeze1104
06-08 1754
如何以root用户批量查看各个节点的其他用户的定时任务,在集群运维中很常用:ansible all  -m shell -a " su hdfs -c 'crontab -l ' " 此外从当前结点批量拷贝到各个节点文件 :ansible hbase -m copy -a "src=/data/download/add_sit_hosts.sh backup=yes dest=/data/tmp"...
使用ansible中的playbook
z17609273238的博客
07-26 1082
1.Playbook的功能playbook是由一个或多个play组成的列表；Playboot文件使用YAML来写的。2.YAML简介YAML是一种表达资料序列的格式，类似XML；2001年首次发表；特点可读性好、和脚本语言交互性好、易于实现、适用程序执行流梳理方式、可扩展性强语法简介在文件中用[---]开始；在文件中用[...]结尾；次行一般书写文件内容，缩进严格，大小写敏感；key/value可以多行书写也可一行书写，一行书写用，隔开；或者Linux。...
ansible中的常用模块(下）
m0_61086860的博客
07-30 285
ansible中的一些模块
Ansible Playbook中Block块
果冻想
10-28 1562
前言在Ansible中，可以将多个action组装成一个块，然后根据不同条件执行这个块，这就好比我们日常编程中的多个语句组成一个函数一样，方便我们对代码的管理。由于这部分内容很少，这里直...
Ansible playbook详解
Promise_410的博客
07-05 7078
Ansible playbook 1. 简介 理解 Playbooks 是 Ansible的配置、部署、编排语言，他们可以被描述为一个需要希望远程主机执行命令的方案，或者一组IT程序运行的命令集合 Playbooks 与 ad-hoc相比,是一种完全不同的运用ansible的方式,是非常之强大的。 简单来说，playbooks是一种简单的配置管理系统与多机器部署系统的基础，与现有的其他系统有不同之处，且非常适合于复杂应用的部署。 playbook是ansible用于配置，部署，和管理被控节点的剧本。
利用ansible cron进行服务器定时日志清理
04-19 2935
方案：创建定时清理日志脚本，通过find命令删除7天以外的日志文件，然后通过ansible分发到各个服务器进行定时执行 vim /data/script/clean_log.sh function cleanLog(){ path=$1 name=$2 if [ -d $path ];then echo "清理$path路径下的$name日志" find $path -mtime +7 -name
ansible定时任务
weixin_30611509的博客
11-25 1213
不得不说，ansible很强大，ansible定制任务模块显示 ansible all -m cron -a 'name="ban IP of login" minute=* hour=*/2 day=* month=* weekday=* job="sh /data/x5online/ban_try_login_ip.sh"' 意思就是每隔两个小时执行ban_tr...
ansible定时任务模块和用户组模块使用
anshejd70787的博客
01-18 490
接上篇，还是一些基础模块的使用，这里主要介绍的是系统模块的使用。 下面例子都进行过相关的实践，从而可以直接进行使用相关的命令。 3、用户模块的使用 用户模块主要用来管理用户账号和用户的属性（对远程主机用户进行批量管理）。 用户模块依赖的指令为useradd，userdel，usermod 参数 必填 默认值 选项 ...
ansible 添加 cron 任务
dengji8846的博客
04-11 473
找到相应的role, 假设以storm_nimbus为例，将要完成的任务脚本放在files目录下。 例如： vim roles/storm_nimbus/files/storm-recovery #!/bin/bash service=storm-mesos if (( $(ps -ef | grep -v grep | grep $service | ...
ansible-playbook定时任务
10-18
可以使用Linux系统自带的crontab来实现ansible-playbook的定时任务。具体步骤如下： 1. 编写ansible-playbook脚本，例如：/home/user/playbook.yml 2. 使用crontab -e命令编辑定时任务，例如：每天凌晨3点执行...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

guan12319

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值