Ansible非标记语言YAML与任务剧本Playbook

news2025/1/16 1:34:48

前言

上篇介绍了 Ansible 单模块(AD-Hoc)的相关内容Ansible自动化运维Inventory与Ad-Hoc-CSDN博客,Ad-Hoc 命令是一次性的、即时执行的命令,用于在远程主机上执行特定任务,这些命令通常用于快速执行简单的任务。当需要在执行多个任务、配置复杂场景或需要可重复使用操作时,就需要用到任务剧本(Playbook)来定义复杂的任务流程和处理重复执行的操作。

Playbook 也通常被大家翻译成剧本。可以认为它是 Ansible 自定义的一门语言(可以将 Playbook 比作 Linux 中的 shell,而 Ansible 中的 Module 可以比作为 Linux 中的各种命令。

目录

前言

一、YAML 非标记语言

1. 概述介绍

2. Yaml 特点

3. 基本语法

3.1 字符串

3.2 列表

3.3 字典

3.4 混合结构 

3.5 验证YAML语法

二、Playbook

1. Paly 的定义

2. Play 属性 

3. tasks 属性中任务的多种写法

4. 具有多个 Play 的格式

5. Playbook 校验与执行

5.1 语法检验

5.2 列出任务

5.3 列出主机

5.4 单步跟重调试 

5.5 测试运行

5.6 执行

6. 编写 Playbook

7. Handlers 组件


一、YAML 非标记语言

1. 概述介绍

YAML(YAML Ain't Markup Language) 是一种人类可读的数据序列化格式,常用于配置文件和数据传输。它以缩进、换行和符号结构来表示数据,具有简洁、清晰的特点。YAML 旨在成为一个易于阅读和编写的数据格式,同时也适合机器解析和生成。它使用空格缩进来表示层级关系,不需要显式的标记符号(如 XML 或 JSON 中的尖括号或大括号),这使得它更加直观和易读。

YAML 官方网站:The Official YAML Web Site

Ansible 官网:YAML Syntax — Ansible Documentation

2. Yaml 特点

YAML文件

  • 以 #为注释符
  • 以 .yml 或者 .yaml 结尾
  • 以 --- 开始,以 ... 结束,但开始和结束标志都是可选的

3. 基本语法

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进时是使用Tab键还是使用空格一定要达到统一,建议使用空格,
  • 相同层级的元素必须左侧对齐即可

 YAML 支持的数据结构有三种:

  • 字符串
  • 列表
  • 字典

3.1 字符串

---
# YAML 中的字符串可以不使用引号,即使里面存在空格的时候,当然了使用单引号和双引号也可以
this is a string
'this is a string'
"this is a string"
# YAML 中若一行写不下要表述的内容,可以进行折行。写法如下:
long line: |
Example 1
Example 2
Example 3
# 或者
long line: >
Example 1
Example 2
Example 3
...

3.2 列表

在 YAML 中,列表使用短横线 - 表示,后面跟着一个空格。列表可以包含任意类型的元素,例如字符串、数字、布尔值或者其他嵌套的列表。

---
#可以认为它就是 python 中的 List,可以认为它是 c 语言中的数组。
# 如何定义:以短横线开头 + 空格 + 具体的值
- red
- green
- blue
# 以上的值假如转换成 python 的 List 会是这样:
# ['red', 'green', 'blue']
...

3.3 字典

字典在 YAML 中使用键值对的形式表示,使用冒号 : 将键和值分隔开,键值之间需要有一个空格。字典可以包含嵌套的字典或者列表作为值。

---
# 可以认为它就是 python 中的 Dict
# 如何定义:key + 冒号(:) + 空格 + 值(value),即 key:value
name: Using Ansible
code: D1234
#转换为 python 的 Dict
#{'name': 'Using Ansibel','code': 'D1234'}
...

3.4 混合结构 

但在日常生产中,往往需要的数据结构会特别复杂,有可能会是字符串、列表、字典的组合形式。这里举一个例子:学校里是以班级为单位。我们去使用列表和字典的形式去描述一个班级的组成。

---
class:
  - name: stu1
    num: 001
  - name: stu2
    num: 002
  - name: stu3
    num: 003
#{'class': [{'name': 'stul, 'num': 1},{'name': 'stu2', 'num': 2), ...]}
...

3.5 验证YAML语法

//将 YAML 文件,通过 Python 的 YAM 模块验证,若不正确则报错。若正确则会输出 YAML 里的内容。
//注意使用时,一定确保安装了 yaml 软件包,
python -c 'import yaml,sys; print yaml.load(sys.stdin)' < myyaml.yml
python3 -c 'import yaml,sys; print(yaml.load(sys.stdin)) < myyaml.yml

示例:

# cat myyaml.yml
---
- red
- geen
- blue
...
#python -c 'import yaml,sys; print yaml.save_load(sys.stdin)' < myyaml.yml
['red', 'green', 'blue']

在 Ansible Playbooks 中,列表和字典通常用来定义变量、任务、主机清单等信息。它们提供了一种直观且易读的方式来表示复杂的数据结构,使得编写和维护 Playbooks 更加方便和直观。

二、Playbook

1. Paly 的定义

由于 playbook 是由一个或者多个 play 组成,如何定义一个 play 呢?
1、每一个 play 都是以短横杠开始的
2、每一个 play 都是一个YAML 字典格式

格式结构:

---
- keyl: value1
- key2: value2
- key3: value3
...

 多个Play结构:

---
- keyl: value1
  key2: value2
  key3: value3
- key4: value1
  key5: value2
  key6: value3
- key7: value1
  key8: value2
  key9: value3
...

2. Play 属性 

Play 中的每一个 key,比如 key1,key2 等;这些 key 在 PlayBook 中被定义为 Play 的属性。
这些属性都具有特殊的意义,我们不能随意的自定义 Play 的属性。

常用属性:

  • name 属性:每个play的名字
  • hosts 属性:每个play涉及的被管理服务器,同 ad-hoc 中的资产选择器
  • tasks 属性:每个play 中具体要完成的任务,以列表的形式表达
  • become 属性:如果需要提权,则加上become相关属性
  • becomekuser 属性:若提权的话,提权到哪个用户上
  • remote_user 属性:指定连接到远程节点上的用户,即远程服务器上执行操作的用户。若不指定,则默认使用当前执行 ansible Playbook 的用户

3. tasks 属性中任务的多种写法

# 以启动 apache 服务,并增加开机启动为例
#一行的形式:
service: name=apache enabled=true state=started
#多行的形式:
sefvice: name=apache
         enabled=true
         state=started
#多行写成字典的形式:
service:
  name: apache
  enabled: true
  state: started

4. 具有多个 Play 的格式

---
- name: manage web servers
  hosts: webserver
  remote_user: root
  tasks :
  - name: install apache package
    yum: name=httpd state=present
  - name: copy apache conf
    copy: src=./httpd.conf dest=/etc/httpd/conf/httpd.conf
  - name: ensure apache is running start nginx server
    service: service: name=httpd state=started enabled=yes

- name: manager db servers
  hosts: dbservers
  tasks:
  - name update database confg
    copy :src=my.cnf dest=/etc/my.cnf
...

5. Playbook 校验与执行

5.1 语法检验

ansible-playbook apache.yaml  --syntax-check

5.2 列出任务

ansible-playbook apache.yaml --list-tasks

5.3 列出主机

ansible-playbook apache.yaml --list-hosts

5.4 单步跟重调试 

执行 tasks 中的任务,需要手动确认是否往下执行。

ansible-playbook apache.yaml --step

5.5 测试运行

会执行完整的 Playbook,但是所有 task 中的行为都不会在远程被管理节点服务器上执行,所有的操作都是模拟。

ansible-playbook apache.yaml --C  #大写的C

5.6 执行

ansible-playbook apache.yaml

6. 编写 Playbook

批量安装apache

① 准备工作,卸载目标主机网站服务

管理节点:
[root@ansible ~]# ansible all -m yum -a "name=httpd state=removed"
#在Ansible中,all是一个用于指代所有主机的特殊关键字。当你在使用Ansible命令时,使用all会将命令应用到所有已定义的主机上。卸载httpd相关服务。

被管理节点:
[root@localhost ~]# yum list | grep httpd | grep @
httpd-tools.x86_64                       2.4.6-99.el7.centos.1         @updates 
#检查是否还有安装httpd相关包。

管理节点:
[root@ansible ~]# ansible all -m yum -a "name=httpd-tools state=removed"
#卸载httpd工具包,避免影响安装httpd。

管理节点:
[root@ansible ~]# yum install -y httpd
#Ansible服务器安装网站服务
[root@ansible ~]# mkdir apache
[root@ansible ~]# cd apache/
[root@ansible apache]# cp -rf /etc/httpd/conf/httpd.conf .

② 编写剧本

[root@ansible apache]# vim apache.yaml
- hosts: webserver                     #针对的剧本对象
  tasks:                               #任务
  - name: install apache packages      #任务1:安装apache包(可以自定义)
    yum: name=httpd state=present      #调用yum安装模块:httpd,present,表示确保软件包已经安装
  - name: copy apache conf             #任务2:拷贝apache配置文件
    copy: src=./httpd.conf dest=/etc/httpd/conf/httpd.conf #调用拷贝模块,源——>目标
  - name: ensure apache is running     #确保apache服务已运行
    service: name=httpd state=started enabled=yes   #调用系统服务状态模块

 ③ 检查测试

[root@ansible apache]# ansible-playbook apache.yaml --syntax-check  #检验语法

playbook: apache.yaml
[root@ansible apache]# ansible-playbook apache.yaml --list-tasks    #列出任务

playbook: apache.yaml

  play #1 (webserver): webserver	TAGS: []
    tasks:
      install apache packages	TAGS: []
      copy apache conf	TAGS: []
      ensure apache is running	TAGS: []
[root@ansible apache]# ansible-playbook apache.yaml --list-hosts    #列出主机

playbook: apache.yaml

  play #1 (webserver): webserver	TAGS: []
    pattern: [u'webserver']
    hosts (4):
      host4
      host3
      host2
      host1

 ④ 执行剧本

[root@ansible apache]# ansible-playbook apache.yaml

PLAY [webserver] ************************************************************************************************

TASK [Gathering Facts] ******************************************************************************************
ok: [host2]
ok: [host3]
ok: [host1]
ok: [host4]

TASK [install apache packages] **********************************************************************************
changed: [host2]
changed: [host1]
changed: [host4]
changed: [host3]

TASK [copy apache conf] *****************************************************************************************
ok: [host2]
ok: [host3]
ok: [host1]
ok: [host4]

TASK [ensure apache is running] *********************************************************************************
changed: [host2]
changed: [host1]
changed: [host4]
changed: [host3]

PLAY RECAP ******************************************************************************************************
host1                      : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
host2                      : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
host3                      : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
host4                      : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

7. Handlers 组件

在 Playbook 中,Handlers 通常会在任务中触发,并在整个 Playbook 运行结束时才会执行。

示例:修改管理节点apace配置文件模板,拷贝到被管理节点,查看apache相关信息:

① 修改管理几点服务器apache监听端口号,执行剧本查看被代理节点服务器配置是否拷贝

[root@ansible ~]# yum install -y httpd
#Ansible服务器安装网站服务
[root@ansible ~]# mkdir apache
[root@ansible ~]# cd apache/
[root@ansible apache]# cp -rf /etc/httpd/conf/httpd.conf .
[root@ansible apache]# sed -i 's/Listen 80/Listen 8080/' httpd.conf

② 查看被代理节点apache配置文件已及更新,但是并没有生效

③ 由于剧本服务模块指令是启动,需要定义、引用处理程序

注意:如果将 state=started 改为 restart ,将会导致每次执行剧本都会重启 apache 服务。

[root@ansible apache]# vim apache.yaml
- hosts: webserver                       #定义了将要执行任务的目标主机或主机组
  tasks:
  - name: install apache packages        #对Playbook的描述,用于标识该Playbook的作用。
    yum: name=httpd state=present
  - name: copy apache conf
    copy: src=./httpd.conf dest=/etc/httpd/conf/httpd.conf
    notify: restart apache service       #通知,当copy模块产生改变,通知程序重启,需要与handlers的name一样 #应用处理程序
  - name: ensure apache is running
    service: name=httpd state=started enabled=yes
  handlers:                              #当任务触发会执行 #定义处理程序
  - name: restart apache service         #任务,重启apache(名字自定义)
    service: name=httpd state=restarted

 ④ 再次修改管理节点 apachep 配置文件端口号,执行剧本,查看被代理节点 apache 端口信息

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1519324.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

二分查找注意事项

目录 1解题思路:首先二分查找分为左闭右闭和左闭右开两种情况&#xff0c;二种情况在细节处理上有所不同 2左闭右闭情况 3左闭右开 4总结&#xff1a; 1解题思路:首先二分查找分为左闭右闭和左闭右开两种情况&#xff0c;二种情况在细…

Go-知识sync map

Go-知识sync map 1. 用法1.1 声明1.2 增删改查1.3 增强操作 2. sync map 使用注意2.1 多读少写2.2 类型安全风险2.3 不能拷贝和传递 3. 实现原理3.1 数据结构3.2 read表数据结构3.3 entry 的数据结构3.4 sync map 的结构图3.5 插入数据3.6 查找数据3.7 再次插入3.8 删除数据 4.…

Unity基础学习

目录 基础知识点3D数学——基础Mathf三角函数坐标系 3D数学——向量向量模长和单位向量向量的加减乘除向量点乘向量叉乘向量插值运算 3D数学——四元数为何使用四元数四元数是什么四元数常用方法四元数计算 MonoBehavior中的重要内容延迟函数协同程序协同程序原理 Resources资源…

谁用过腾讯云轻量应用服务器2核2G3M配置,支持多少人在线?

腾讯云轻量应用服务器2核4G5M配置一年优惠价165元、252元15个月、三年756元&#xff0c;100%CPU性能&#xff0c;5M带宽下载速度640KB/秒&#xff0c;60GB SSD系统盘&#xff0c;月流量500GB&#xff0c;折合每天16.6GB流量&#xff0c;超出月流量包的流量按照0.8元每GB的价格支…

uniapp实现点击标签文本域中显示标签内容

先上一个效果图 实现的效果有&#xff1a; ①.点击标签时&#xff0c;标签改变颜色并处于可删除状态 ②.切换标签&#xff0c;文本域中出现标签的内容 ③.点击标签右上角的删除可删掉标签&#xff0c;同时清除文本域中标签的内容 ④.可输入内容&#xff0c;切换时不影响输入…

系统设计学习(三)限流与零拷贝

七、有哪些常用限流算法&#xff1f; Leaky Bucket 漏桶 漏桶可理解为是一个限定容量的请求队列。想象有一个桶&#xff0c;有水&#xff08;指请求或数据&#xff09;从上面流进来&#xff0c;水从桶下面的一个孔流出来。水流进桶的速度可以是随机的&#xff0c;但是水流出桶…

蓝桥杯小白赛第 7 场 3.奇偶排序(sort排序 + 双数组)

思路&#xff1a;在第一次看到这道题的时候我第一想法是用冒泡&#xff0c;但好像我的水平还不允许我写出来。我又读了遍题目发现它的数据很小&#xff0c;我就寻思着把它分成奇偶两部分。应该怎么分呢&#xff1f; 当然在读入的时候把这个问题解决就最好了。正好它的数据范围…

前端项目(vue3)自动化部署(Gitlab CI/CD)

天行健&#xff0c;君子以自强不息&#xff1b;地势坤&#xff0c;君子以厚德载物。 每个人都有惰性&#xff0c;但不断学习是好好生活的根本&#xff0c;共勉&#xff01; 文章均为学习整理笔记&#xff0c;分享记录为主&#xff0c;如有错误请指正&#xff0c;共同学习进步。…

C语言练习题【复试准备】

1、BoBo教KiKi字符常量或字符变量表示的字符在内存中以ASCII码形式存储。BoBo出了一个问题给KiKi&#xff0c;转换以下ASCII码为对应字符并输出他们。 //73,32,99,97,110,32,100,111,32,105,116,33 int main() {int arr[] {73,32,99,97,110,32,100,111,32,105,116,33};int i …

Swift:.ignoresSafeArea():自由布局的全方位掌握

ignoresSafeArea(_ regions : edges:)修饰符的说明 SwiftUI布局系统会调整视图的尺寸和位置&#xff0c;以避免特定的安全区域。这就确保了系统内容&#xff08;比如软件键盘&#xff09;或设备边缘不会遮挡您的视图。要将您的内容扩展到这些区域&#xff0c;您可以通过应用该修…

一文看懂红帽认证含金量有多高!

近期好多人来问红帽认证&#xff0c;有些是还在校的大学生&#xff0c;有些是已经工作的运维小伙伴。!现在的就业和职场环境下&#xff0c;系统学Linux确实是非常必要的。今天就给大家详细介绍下红帽认证&#xff0c;看看它的含金量有多高! 红帽认证是什么?红帽认证等级?红帽…

Sublime查看ANSI编码文档乱码问题

原因为没有安装对应的解码插件。 选择安装插件包 选择插件包&#xff1a;ConvertToUTF8或者GBK&#xff0c;我试了第一个插件包不行&#xff0c;安装GBK插件包后OK。

AI车辆占道识别摄像机

随着城市车辆数量的增加和交通状况的复杂化&#xff0c;道路交通安全问题日益突出&#xff0c;其中车辆占道现象严重影响了交通秩序和道路通畅。为了有效监管和防范车辆占道行为&#xff0c;AI车辆占道识别摄像机应运而生&#xff0c;利用人工智能技术&#xff0c;实现对车辆占…

探索CorelDRAW软件2024最新中文版的强大魅力,让你的电脑数码设计更上一层楼!

在当今日益发展的数字化时代&#xff0c;设计已成为连接创意与现实之间的桥梁&#xff0c;而CorelDRAW软件则是设计师们手中的得力助手。特别是随着CorelDRAW 2024最新中文版的发布&#xff0c;这一设计工具的魅力和功能得到了进一步的提升&#xff0c;为广大设计师们提供了前所…

strcmp的模拟实现

一&#xff1a;strcmp函数的定义&#xff1a; strcmp函数功能的解释&#xff1a; 比较两个字符串的大小&#xff08;按照字符串中字符的ascll码值&#xff09;。 标准规定&#xff1a; 第一个字符串大于第二个字符串&#xff0c;则返回大于 0 的数字 第一个字符串等于第二个…

Redis持久化和集群

redis持久化 RDB方式 Redis Database Backup file (redis数据备份文件), 也被叫做redis数据快照. 简单来说就是把内存中的所有数据记录到磁盘中. 快照文件称为RDB文件, 默认是保存在当前运行目录. [rootcentos-zyw ~]# docker exec -it redis redis-cli 127.0.0.1:6379> sav…

每日一题 第四期 洛谷 查找文献

【深基18.例3】查找文献 链接 题目描述 小 K 喜欢翻看洛谷博客获取知识。每篇文章可能会有若干个&#xff08;也有可能没有&#xff09;参考文献的链接指向别的博客文章。小 K 求知欲旺盛&#xff0c;如果他看了某篇文章&#xff0c;那么他一定会去看这篇文章的参考文献&…

Mybatis sql 控制台格式化

package com.mysql; import org.apache.commons.lang.StringUtils; import org.apache.ibatis.logging.Log;import java.util.*;/*** Description: sql 格式化* Author: DingQiMing* Date: 2023-07-17* Version: V1.0*/ public class StdOutImpl implements Log {private stati…

石子合并多种解法

线性朴素n^3 using ll long long;int dp1[305][305], dp2[305][305]; int main() {int n;std::cin >> n;std::vector<int>a(n 1), sum(n 1);//扩增,计算前缀和for (int i 1; i < n; i) {std::cin >> a[i];sum[i] sum[i - 1] a[i];}//i是区间for (i…

洛谷P1182数列分段

题目描述 对于给定的一个长度为 N 的正整数数列 &#xff0c;现要将其分成 M&#xff08;M≤N&#xff09;段&#xff0c;并要求每段连续&#xff0c;且每段和的最大值最小。 关于最大值最小&#xff1a; 例如一数列 4 2 4 5 14 2 4 5 1 要分成 33 段。 将其如下分段&#…