【讲清楚,说明白!】Ansible-playbook使用详解

(1)playbook和YAML语法
(1.1)
Playbook是由一个或多个“play”组成的列表;play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲,所谓task无非是调用ansible的一个moudle;将多个play组织在一个playbook中,即可以让它们联同起来事先编排的机制同唱一台大戏;Playbook采用YAML语言编写。
(1.2)YAML介绍:YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他多种语言,包括:XML、C语言、Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年首次发表了这种语言,另外Ingy与Oren Ben-Kiki也是这语言的共同设计者;YAML Ain’t Markup Language,即YAML不是XML。不过,在开发的这种语言时,YAML的意思其实是:Yet Another Markup Language(仍是一种标记语言)
特性:
YAML的可读性好
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强,扩展性好
(1.3)YAML语法简介:
1.在单一档案中,可用连续三个连子号(---)区分多个档案。另外,还有选择性的连续三个点号(...)用来表示档案结尾
2.次行开始正常写playbook内容,一般建议写明该Playbook的功能
3.使用#号注释代码
4.缩进必须是统一的,不能空格和tab混用
5.缩进的级别也必须是一致的,同样的缩进代表同样的级别,程序判别配置的级别是通过缩进结合换行来实现的
6.YAML文件内容和Linux系统大小写判断方式保持一致,是区别大小写的,k/v的值均需大小写敏感
7.k/v的值可同行写也可换行写。同行使用(:)分隔
8.v可以是个字符串,也可是另一个列表
9.一个完整的代码块功能所需最少元素包括name:task
10.一个name只能包括一个task
11.YAML文件扩展名通常为yml或yaml
(1.4)Dictionary:字典,通常由多个key与value构成
YAML的语法和其他高阶语言类似,并且可以简单表达清单、散列表、标量等数据结构。其结构(Structure)通过空格来展示,序列(Sequence)里的项用“-”来代表,Map里的键值对用“:”分隔
(1.5)Playbook核心元素
Hosts:执行的远程主机列表
Tasks:任务集
Varniables:内置变量或自定义变量在playbook中调用
Templates模板,可替换模板文件中的变量并实现一些简单逻辑的文件
Handlers和notity结合使用,由特定条件触发的操作,满足条件方才执行,否则不执行
Tag标签,指定某条任务执行,用于选择运行playbook中的部分代码。Ansible具有幂等性,因此会自动跳过没有变化的部分,即便如此,有些代码为测试其确实没有发生变化的时间依然会非常的长。此时,如果确信其没有变化,就可以通过tags跳过此些代码片段。
# yum install httpd -y
在130主机本地安装一个httpd服务
# echo 'welcome to wangxiangyu_home' > /var/www/html/index.html
在130主机上创建一个网页文件
【讲清楚,说明白!】Ansible-playbook使用详解
【讲清楚,说明白!】Ansible-playbook使用详解
在/root/ansible/file.yaml文件中写上如下的配置信息,我们会touch创建一个newfile文件,然后创建一个test2用户,再安装httpd服务,将130本地的html文件拷贝到对应的主机中,最后启动httpd服务
【讲清楚,说明白!】Ansible-playbook使用详解
# ansible-playbook -C file.yaml
使用大C检查一遍创建的yaml文件
# ansible-playbook file.yaml
如果检查没有问题就真正的执行一遍playbook文件
# ansible all -a 'ls -l /data'
检查/data目录下是否有newfile文件
# ansible all -a 'getent passwd test2'
检查test2用户是否有创建
# ansible all -m shell -a 'ss -tln| grep :80'
检查httpd服务是否有安装成功(如果没有装成功可以把防火墙关闭一下)
【讲清楚,说明白!】Ansible-playbook使用详解
(1.6)playbook基础组件
(1.6.1)remote_user:可用于Host和task中。也可以通过指定其通过sudo的方式在远程主机上执行任务,其可用于play全局或某任务;此外,甚至可以在sudo时使用sudo_user指定sudo时切换的用户
(1.6.2)task列表和action:play的主体部分是task_list。task_list中的各个任务按次序逐个在hosts中指定的所有主机上执行,即在所有主机上完成第一个任务后再开始第二个。在运行自上而下某playbook时,如果中途发生错误,所有已执行任务都将回滚,因此,在更正playbook后重新执行一次即可;task的目的是使用指定的参数执行模块,而在模块参数中可以使用变量。模块执行是幂等的,这意味着多次执行时安全的,因为其结果均一致;每个task都应该有其name,用于playbook的执行结果输出,建议其内容尽可能清晰地描述任务执行步骤。如果未提供name,则action的结果将用于输出。
如果命令或脚本的退出码不为零,可以使用如下方式替代:
tasks:

  • name: run this command and igonre the result
    shell: /usr/bin/somecommand || /bin/true
    或者使用ignore_errors来忽略错误信息:
    tasks:
  • name: run this command and igonre the result
    shell: /usr/bin/somecommand
    ignore_errors: True
    我们可以使用如下的常见选项:
    # ansible all -a 'getent passwd test2' --list-hosts
    查看所有的主机列表的清单
    # ansible all -a 'getent passwd test2' --limit 192.168.26.131
    限定只在131主机上执行查询的命令
    # ansible-playbook file.yaml --limit websrvs
    限定只在websrvs组中的主机可以执行playbook
    # ansible-playbook file.yaml --list-tasks
    查看file.yaml文件中的具体任务个数
    (1.6.3)Handlers:即触发器,是task列表,这些task与前述的task并没有本质上的不同,用于当关注的资源发生变化时,才会采取一定的操作;notify此action可用于在每个play的最后被触发,这样可避免多次有改变发生时每次都执行指定的操作,仅在所有的变化发生完成后一次性地执行指定操作,在notify中列出的操作称为handler,也即notify中调用handler中定义的操作。
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (1.6.4)Tags标签:可以在playbook中使用的标签信息,注意:也可以多个动作公用一个标签
    # ansible all -m service -a 'name=httpd state=stopped'
    首先将各主机中的httpd服务停止
    # ansible all -m shell -a 'ss -tnl| grep :9527'
    检查各主机中的http服务对应的9527端口是否有停止
    【讲清楚,说明白!】Ansible-playbook使用详解
    然后我们在httpd.yaml配置文件中写上如下的tags信息
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook -t rshttpd httpd.yaml
    将httpd.yaml文件重新执行一遍,并且只选择标签为rshttpd的进行执行
    # ansible all -m shell -a 'ss -tnl| grep :9527'
    检查各主机中的http服务对应的9527端口是否有停止
    # ansible all -m yum -a 'name=httpd state=absent'
    首先把httpd服务卸载一下
    # ansible-playbook -t inshttpd,rshttpd httpd.yaml
    使用playbook在httpd.yaml文件中使用inshttpd和rshttpd标签,使用-t参数选项
    # ansible-playbook httpd.yaml --list-tags
    查看httpd.yaml文件的所有tags标签信息
    (1.7)playbook中变量使用
    变量名:仅能由字母、数字和下划线组成,且只能以字母开头
    变量来源:ansible setup facts远程主机的所有变量都可直接调用。
    (1.7.1)# ansible all -m setup -a 'filter=address'
    查找所有主机中配置带IP地址的,使用-a选项,使用filter关键字过滤,其中setup包含的都是系统自带的变量
    # ansible all -m setup -a 'filter=ansible_all_ipv4_addresses'
    查询所有主机中变量为ansible_all_ipv4_addresses的信息,使用-a选项,使用filter关键字过滤
    # ansible all -m setup -a 'filter=ansible_ens32'
    查询所有主机中变量为ansible_ens32的信息
    需求操作:我们定义一个app.yaml文件,将name值定义为pkname变量
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook -e 'pkname=vsftpd' app.yaml
    我们使用playbook设置pkname的参数值为安装vsftpd服务,其中使用-e选项
    # ansible appsrvs -m shell -a 'ss -tnl| grep :21'
    查看appsrvs中的主机的ftp服务对应的21端口是否有开启
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook -e 'pkname1=httpd pkname2=memcached' app.yaml
    如果想同时安装多个软件包,可以使用多个参数的方式指定,使用e参数指定
    # ansible appsrvs -m shell -a 'rpm -q httpd memcached'
    查看指定的软件是否有安装成功
    【讲清楚,说明白!】Ansible-playbook使用详解
    (1.7.2)如果我们想在yaml文件中直接定义好安装的软件包,可以使用vars模块
    # ansible-playbook app.yaml
    直接安装app.yaml中的配置信息
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (1.7.3)
    变量名:仅能由字母、数字和下划线组成,且只能以字母开头
    变量来源:在/etc/ansible/host中定义
    1.普通变量:主机组中主机单独定义
    2.公共组变量:针对主机组中所有主机定义统一变量
    3.通过命令行指定变量,优先级最高
    # vim /etc/ansible/hosts
    在/etc/ansible/hosts进行配置
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim hostname.yaml
    创建一个hostname.yaml文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook hostname.yaml
    执行 hostname.yaml文件修改主机名
    # ansible websrvs -a 'hostname'
    查看主机名修改后的结果
    【讲清楚,说明白!】Ansible-playbook使用详解
    (1.7.4)变量名:仅能由字母、数字和下划线组成,且只能以字母开头
    变量来源:在/etc/ansible/host中定义
    4.普通变量的优先级[websrvs]中的http_port要比分组的[websrvs:vars]中的同样http_port参数优先级高
    # vim /etc/ansible/hosts
    在/etc/ansible/hosts进行配置
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook hostname.yaml
    执行 hostname.yaml文件修改主机名
    # ansible websrvs -a 'hostname'
    查看主机名修改后的结果
    【讲清楚,说明白!】Ansible-playbook使用详解
    (1.7.5)
    # ansible all -m setup -a 'filter=ansible_fqdn'
    使用setup模块查询ansible_fqdn这个系统自带系统变量的信息,同时在var.yaml文件中进行如下配置,权限为600,属主为wang
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook -C var.yaml
    使用playbook将var.yaml干跑一遍
    # ansible-playbook var.yaml
    使用playbook将var.yaml文件执行一遍
    # ansible all -a 'ls /data/'
    查看各主机上是否由在data目录下创建.log文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    (1.7.6)变量名:仅能由字母、数字和下划线组成,且只能以字母开头
    变量来源:在/etc/ansible/host中定义
    5.在独立的变量YAML文件中定义
    # vim vars.yaml
    创建一个vars.yaml文件,里面专门放变量的配置信息
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim testvar.yaml
    在testvar.yaml文件中编辑如下的配置
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook testvar.yaml
    使用playbook安装testvar.yaml配置文件
    # ansible all -m shell -a 'rpm -q httpd'
    查看httpd服务是否有安装成功
    # ansible all -m shell -a 'ls -l /data'
    查看data目录下是否有生成.log的文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2)模板templates
    文本文件,嵌套有脚本(使用模板编程语言编写)
    Jinjia2语言,使用字面量,有下面形式
    templates功能:根据模块文件动态生成对应的配置文件;templates文件必须存放于templates目录下,且命名为.j2结尾;yaml文件需和templates目录平级。
    字符串:使用单引号或双引号
    数字:整数,浮点数
    列表:[item1,item2,...]
    元组:[item1,item2,...]
    字典:{key1:value1,key:value2,...}
    布尔型:true/false
    算术运算:+,-,*,/,//(整除),%(取余),**(求指数)
    比较操作:==,!=,>,>=,<,<=
    逻辑运算:and,or,not
    流表达式:for,if,when(当..条件满足的时候)
    # ansible websrvs -m setup -a 'filter=ansible_processor_vcpus'
    查询各主机上的cpu个数的参数信息
    # ansible all -m shell -a 'ps aux | grep nginx'
    查询所有CPU上的nginx的进程数量
    # ansible all -m shell -a 'ss -tnlp'
    查询ngixn是否有在80端口运行
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.1)经验总结得出结论:通过试验我们得到变量的优先级为:第一优先级的是在命令行加上-e然后再加上具体设置参数如http_port=99的情况(图2-4);第二优先级是在playbook文件中定义,例如在testtempl.yaml文件中设置的vars参数值为http_port: 88的情况(图2-5);第三优先级的是在主机清单/etc/ansible/hosts中定义的http_port=83的情况(图2-6)。
    命令行>playbook>主机清单
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.2)条件测试:如果需要根据变量、facts或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试,通过when语句实现,在task中使用,jinja2的语法格式
    When语句:在task后添加when子句即可使用条件测试,when语句支持jinja2表达式语法
    # ansible all -m setup -a 'filter=ansible_os_family'
    查看各主机使用的操作系统信息
    # ansible all -m setup -a 'filter=ansible_distribution_major_version'
    查看各主机的具体操作系统版本信息
    # vim testtempl.yaml
    编辑testtempl.yaml配置文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.3)迭代:with_items
    迭代:当有需要重复性执行的任务时,可以使用迭代机制
    1.对迭代项的引用,固定变量名为“item”
    2.要在task中使用with_items给定要迭代的元素列表
    列表格式:字符串、字典
    # vim testitem.yaml
    编辑testitem.yaml文件,在配置文件中定义循环创建文件和安装软件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim testitem.yaml
    编辑testitem.yaml文件,在配置文件中定义循环创建组
    # ansible all -m shell -a 'getent group'
    检查组是否由创建成功
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.4)迭代嵌套自变量
    # vim testitem2.yaml
    创建一个testitem2.yaml文件,然后配置好对应的用户到对应的组中
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible all -m shell -a 'getent passwd'
    查询创建的用户的属主属组信息
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible all -m shell -a 'getent group'
    查询各主机上创建的属组信息
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.5)playbook中template for if
    需求:我们需要在各主机的/data目录下生成一个for.conf的配置文件,并在每个文件中生成监听81,82,83端口的信息
    # vim testfor.yaml
    创建一个testfor.yaml配置文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim for.conf.j2
    在/root/ansible/templates目录下编辑模板文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook testfor.yaml
    使用playbook执行testfor.yaml配置文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible all -m shell -a 'cat /data/for.conf'
    查看各服务器下的/data/for.conf文件中是否有生成对应的配置内容
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.6.1)需求:我们需要在各主机的/data目录下生成一个for.conf的配置文件,并在每个文件中生成监听81,82,83端口的信息,注意需要将列表使用字典的方式组织。
    # vim testfor2.yaml
    创建一个testfor2.yaml配置文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim templates/for.conf.j2
    在/root/ansible/templates目录下编辑模板文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook testfor2.yaml
    使用playbook执行testfor2.yaml配置文件
    (2.6.2)字典的高级用法
    # vim testfor3.yaml
    编辑/root/ansible目录下的testfor3.yaml文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim for3.conf.j2
    编辑/root/ansible/templates目录下的for3.conf.j2文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook testfor3.yaml
    使用playbook执行testfor3.yaml配置文件
    # ansible all -m shell -a 'cat /data/for3.conf'
    查询在各主机下生成的for3.conf文件中的内容是否正确
    【讲清楚,说明白!】Ansible-playbook使用详解
    【讲清楚,说明白!】Ansible-playbook使用详解
    (2.6.3)字典的高级用法
    # vim testfor4.yaml
    编辑/root/ansible目录下的testfor4.yaml配置文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # vim for4.conf.j2
    在/root/ansible/templates目录下编辑for4.conf.j2文件
    【讲清楚,说明白!】Ansible-playbook使用详解
    # ansible-playbook testfor4.yaml
    使用playbook执行testfor4.yaml配置文件
    # ansible all -m shell -a 'cat /data/for4.conf'
    查询在各主机下生成的for4.conf文件中的内容是否正确
    【讲清楚,说明白!】Ansible-playbook使用详解

—————— 本文至此结束,感谢阅读 ——————

上一篇:实战--Playbook批量修改密码


下一篇:Ansible 之 外部变量文件调用