ansible-playbook用法

时间:2021-07-30 16:14:33

一、playbook用法

1、playbook的执行文件为YAML语言编写,所以文件名为xxx.yml。YAML语法可以参考https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html#id1

2、下面以安装httpd软件来作讲解

示例playbook:

[root@localhost test]# cat httpd.yml
---                    #文件起始行,也可以省略。但是不建议省略
- hosts: docker           #docker表示远程执行这个yml文件的主机组,这里也可以指定对应的主机ip,或者正则表达 
  remote_user: root         #远程执行命令的用户
  vars:              # vars以下为参数,可根据架构来选择是否有参数
    pkg: httpd           # 定义变量名为pkg,值为httpd,后续可以使用{{ pkg }}来引用

tasks:                 # tasks后续跟执行的任务
    - name: uninstall httpd         # 自定义任务名
      yum: name={{ pkg }} state=absent    # 任务执行命令, 这里表示用yum模块来卸载 httpd软件, {{ pkg }}引用vars中已经定义的变量,state表示对软件的操作,这里表示卸载
      tags: unhttpd               # tags为标签,任务都可以加上标签名,通过tags我们可以执行特定的任务,例如:ansible-playbook -t unhttpd httpd.yml 表示执行http.yml中tags为unhttpd的任务
    - name: install http
      yum: name={{ pkg }} state=installed  #这里表示用yum模块来安装 httpd软件
      tags: httpd
    - name: copy cfg
      copy: src=/opt/test/httpd.conf dest=/etc/httpd/conf/       #这里表示调用copy模块来将src的文件copy到目的地dest指定的位置
      notify: restart service         # notify 可以理解为触发器,与handlers配合起来使用。 当notify标注的任务被成功执行后,就会触发对应的handlers任务执行
      tags: copy
    - name: start service
      service: name=httpd state=started enabled=yes
      tags: httpd

handlers:               #handlers和notify配合使用
    - name: restart service        # 任务名需要和notify名称一致,多个相同的任务可以使用同一个notify名称来触发同一个handlers任务,handlers任务可以为多个
      service: name=httpd state=restarted

3、执行playbook

-C表示执行检查,不会对系统做改变,会完整的运行所有任务,检查playbook任务是否正确:

#ansible-playbook -C httpd.yml

执行playbook,根据任务顺序执行,系统会根据任务有所变化:

# ansible-playbook httpd.yml

执行结果说明:

绿色: 执行成功,不需要做改变(这里好像并不是一定不改变)

红色: 执行失败

黄色: 执行成功,并且系统有变化

执行结果颜色可以通过ansible的配置文件进行私人定制。

4、关于模块的使用

ansible-doc --list  #可以列出所有可使用模块,核心模块:http://ansible.com.cn/docs/modules_core.html  额外模块:http://github.com/ansible/ansible-modules-extras

ansible-doc  -s Module_Name   #查询模块的使用方法 ,如: ansible-doc  -s yum  查询yum模块的使用方法

ansible-doc Module_Name    #更详细的展示模块的使用,和linux中的man手册类似

5、关于参数的定义

参数优先级: 命令行>局部>全局

♦ 通过命令指定,优先级最高

ansible-playbook -e varname=value xxx.yml

♦ ansilbe setup facts远程主机的多有变量都可以直接使用可以在执行ansible命令的时候给与变量值

ansible hostip -m setup      #可以查询到ansible系统的一些信息,其中就包括可以直接使用的变量

♦ 在/etc/ansible/hosts中定义

普通变量;主机组中单独定义,优先级高于公共变量

公共(组)变量:针对主机组中所有主机定义统一变量

[docker]
172.17.0.2 http_port=80   #普通变量
172.17.0.3 http_port=90

[docker:vars]
http_port=100      #公共变量

♦ 在playbook中定义

vars:

- var1: value1

   - var2: value2

♦ 在role中定义

需要一个固定的vars目录来存放编辑变量的文件,后续roles的使用中会讲到