ansible------剧本playbook编写规则详述
ansible剧本playbook编写
- 一、ansible -inwentory主机清单
-
- 1.1 手动配置方式
- 1.2 Inventory中的变量
-
- 1.2.1 主机变量
- 1.2.2 组变量
- 1.2.3 组嵌套
- 1.2.4 inventory变量参数
- 二、YAML
-
- 2.1 基本语法规则
- 2.2 yaml支持的数据结构
-
- 2.2.1 对象
- 2.2.2 数组
- 2.2.3 纯量
- 2.2.4 yaml示例
- 三、ansible的脚本---playbook剧本
-
- 3.1 编写playbook脚本
- 3.2 执行playbook的命令
- 3.3 补充命令
- 3.4 hosts和users介绍
- 3.5 为每个任务定义远程执行用户
- 3.6 指定远程主机sudo切换用户
- 3.7 示例
- 3.8 示例
- 四、Handlers介绍
-
- 4.1 playbook使用变量方法
-
- 4.1.1 通过ansible命令传递 -e
- 4.1.2 直接在yamI中定义变量---如上handlers示例
- 4.1.3 直接引用一些变量(在主机清单里定义)
- 五、条件测试
-
- 5.1 单条件判断
- 5.2 多条件判断
- 5.3 组条件判断
- 5.4 自定义变量进行条件测试(version2.9版本后被移出，无法使用)
- 六、迭代
一、ansible -inwentory主机清单
ansible默认的主机清单
/etc/ansible/hosts文件
主机清单可以手动配置，也可以通过Dynamic Inventory动态生成
一般主机名使用FQDN
1.1 手动配置方式
vi /etc/ansible/hosts
[webserver] #方括号设置组名
www1.example.org #定义被监控主机，这边可以是主机名，也可以是IP地址，主机名需要修改/etc/hosts文件
www2.example.org:2222 #冒号后定义远程连接端口，默认是ssh的22端口
如果是名称类似的主机可以使用列表的方式标识各个主机
[webserver]
www.[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=123123
[dbservers]
db-[a:f].example.org #支持匹配a b c d e f...
1.2 Inventory中的变量
1.2.1 主机变量
[webserver]
www1.magedu.com http_port=80 maxRequestsChild=808
www2.magedu.com http_port=8080 maxRequestsChild=909
1.2.2 组变量
[servers:vars]
ntp_server=ntp.example.org
nfs_server=nfs.example.org
1.2.3 组嵌套
[apache]
http1.example.org
http2.example.org
[nginx]
ngx1.example.org
ngx2.example.org
[webservers:children]
apache
nginx
1.2.4 inventory变量参数
ansible_ssh_host #将要连接的远程主机名，与你想要设定的而主机名，与你想要设定的主机的别名不同的话，可通过此变量设定
ansible_ssh_port #ssh端口号，如果不是默认的端口号，通过此变量设置
ansible_ssh_user #默认的ssh用户名
ansible_ssh_pass #ssh密码（这种方式并不安全，强烈建议使用--ask-pass 或SSH密钥）
ansible_ssh_private_key_file #ssh使用的私钥文件，适用于有多个密钥，而你不想使用SSH代理的情况
ansible_ssh_common_args #此设置附加到sftp，scp和ssh的缺省命令行
ansible_sftp_extra_args #此设置附加到sftp命令行
ansible_scp_extra_args #此设置附加到scp命令行
ansible_ssh_extra_args #此设置附加到ssh命令行
ansible_ssh_pipelining #确定是否适用SSH管道。这可以覆盖ansible.cfg中的设置
ansible_shell_type #目标系统的shell类型。默认情况下命令的执行使用'sh'语法，可以设置为'csh'或'fish'
ansible_python_interpreter #目标主机的python路径。适用于的情况：系统中有多个python，或者命令路径不是"/usr/bin/python"
ansible_*_interpreter #这里的“*”可以是ruby或Perl或其他语言的解释器，作用和ansible_python_interpreter类似
ansible_shell_executable #这将设置ansible控制器将在目标机器上使用的shell，覆盖ansible.cfg中的配置，默认为/bin/sh
二、YAML
yaml：另一种标记语言。是用来写配置文件的语言，非常简洁和强大。
yaml语法和其他语言类似，也可以表达散列表、标量等数据结构。
结构通过空格来展示；
序列里配置项通过-来表示；
Map里键值用：来分隔；
YAML的扩展名时yaml
2.1 基本语法规则
1、大小写敏感
2、使用缩进表示层级关系
3、缩进是不允许使用Tab键，只允许使用空格
4、所进的空格数目不重要，只要相同层级的元素左侧对齐即可
2.2 yaml支持的数据结构
2.2.1 对象
1、对象：键值对的集合，又称映射（mapping）/哈希（hashes）/字典（dictionary）
例如：name: Example Developer
2.2.2 数组
2、数组：一组按次序排列的值，又称为序列（sequence）/列表（list）
例如： - Apple
- Orange
2.2.3 纯量
3、纯量：单个的、不可再分的值
例如： number: 12.30
sure: true
2.2.4 yaml示例
name: zhangsan
age: 20
name: lisi
age: 22
people: #对象
- name: zhangsan #数组
age: 20 #纯量
- name: lisi #数组
age: 22
三、ansible的脚本—playbook剧本
通过task调用ansible的模块将多个play组织在一个playbook中运行
playbooks本身有以下各部分组成：
（1）Tasks：任务，基调用户模块完成的某操作
（2）Variables：变量
（3）Temoplates：模板
（4）Handlers：处理器，当某条件满足时，触发执行操作
（5）Roles：角色
3.1 编写playbook脚本
- hosts: webservers #定义的主机组，即应用的主机
vars: #定义变量
http_port: 80
max_clients: 200
user: root
tasks: #执行的任务
- name: ensure apache is at the latest version
yum: pkg=httpd state=latest
notify:
- restart apache
- name: ensure apache is running
service: name=httpd state=started
handlers: #处理器
- name: restart apache
service: name=httpd state=restarted
3.2 执行playbook的命令
ansible-playbook [yaml文件名]
例：ansible-playbook ping.yml
参数：-k(-ask-pass) #用来交互输入ssh密码
-K(-ask-become-pass) #用来交互输入sudo密码
-u #指定用户
3.3 补充命令
ansible-playbook nginx.yaml --syntax-check #检车yaml文件的语法是否正确
ansible-playbook nginx.yaml --list-task #检车tasks任务
ansible-playbook nginx.yaml --list-hosts #检查生效的主机
ansible-playbook nginx.yaml --start-at-task='Copy Nginx.conf' #指定从某个task开始运行
3.4 hosts和users介绍
- hosts: webservers #指定主机组，可以是以一个或多个组
remote_user: root #指定远程主机执行的用户名
3.5 为每个任务定义远程执行用户
- hosts: mysql
remote_user: root
tasks:
- name: test connection
ping:
remote_user: mysql #指定远程主机执行tasks的运行用户为mysql
执行playbook时：ansible-playbook ping.yml -k
3.6 指定远程主机sudo切换用户
- hosts: mysql
remote_user: root
become: yes #2.6版本以后的参数，之前是sudo，意思为切换用户运行
become_user: mysql #指定sudo用户为mysql
tasks:
- name: copy text
copy: src=/etc/fstab dest=/home/mysql/fstab.bak
执行playbook时：ansible-playbook ping.yml -K
===================================
3.7 示例
- hosts: 192.168.238.30
remote_user: root
tasks:
- name: disable selinux
command: '/sbin/setenforce 0'
- name: make sure apache is running
service: name=httpd stated
play中只要执行命令的返回值不为0，就会报错，tasks停止
修改如下：
- hosts: webservers
remote_user: root
tasks:
- name: disable selinux
command: '/sbin/setenforce 0'
ignore_errors: True #忽略错误，强制返回成功
- name: make sure apache is running
service: name=httpd state=stated
3.8 示例
- hosts: webservers
remote_user: root
tasks:
- name: create nginx group
group: name=nginx system=yes gid=208
- name: create nginx user
user: name=nginx uid=208 group=nginx system=yes
- hosts: mysql
remote_user: root
tasks:
- name: copy file to mysql
copy: src=/etc/inittab dest=/opt/inittab.bak
四、Handlers介绍
handlers也是一些tasks的列表，和一般的task并没有什么区别
是由通知者进行的notify，如果没有被notify，则Handlers不会执行，加假如被notify了，则Handlers被执行
不管有多少个通知者进行了notify，等到play中的所有task执行完成后，handlers也会被执行一次
====================================================
notify：
- restart httpd
- name: start httpd service
service: enabled=true name=httpd state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
也可以引入变量
- hosts: webservers
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install configuration file for httpd
yum: name={{package}} state=latest
- name: install configuration file for httpd
copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
notify:
-restart httpd
- name: start httpd service
service: enabled=true name={{service}} state=started
handlers:
- name: restart httpd
service: name={{service}} state=restarted
4.1 playbook使用变量方法
4.1.1 通过ansible命令传递 -e
例如：编辑如下yaml
vi a.yaml
- hosts: mysql
remote user: root
vars:
- user:
tasks:
- name: add new user
user: name={{user}}
然后执行命令: ansible-playbook a.yml -e "user=testvar"
可以执行命令查看: ansible mysql -m command -a 'tail /etc/passwd'
4.1.2 直接在yamI中定义变量—如上handlers示例
vi a.yaml
- hosts: mysql
remote user: root
vars:
- user: zhangsan #直接在yaml里定义变量
tasks:
- name: add new user
user: name={{user}} #引用上面定义的变量
然后执行命令: ansible-playbook a.yml
4.1.3 直接引用一些变量(在主机清单里定义)
如：引用ansible的固定变量
vi test.yml
- hosts: mysql
remote_user: root
tasks:
- name: copy file
copy: content= "{{ansible_all_ipv4_addresses}}" dest=/opt/vars.txt
执行命令: ansible-playbook test.yml
去183.上查看vars.txt文件内容
五、条件测试
如果需要根据变量、facts（setup）或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试，在playbook中条件测试在task后面添加when子句即可使用条件测试：when子句支持jinjia2表达式或语法，例如：
5.1 单条件判断
vi when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shutdown CentOS"
command: /sbin/shutdown -h now
when: ansible_distribution == "CentOS"
5.2 多条件判断
vi when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shutdown CentOS 7 systems"
command: /sbin/shutdown -r now
when:
- ansible_distribution == "CentOS"
- ansible_distribution_major_version == "7"
5.3 组条件判断
vi when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shutdown CentOS 6 and Debian 7 systems"
command: /sbin/shutdown -t now
when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "6") or
(ansible_distribution == "Debian" and ansible_distribution_major_version == "7")
5.4 自定义变量进行条件测试(version2.9版本后被移出，无法使用)
vi when.yml
- hosts: all
vars:
exist: "true" #会报错
tasks:
- name: create file
command: touch /tmp/test.txt
when: exist | match("True")
- name: delete file
command: rm -rf /tmp/test.txt
when: exist | match("False")
六、迭代
当有需要重复性执行的任务时，可以使用迭代机制。其使用格式为将需要迭代的内容定义为item变量引用，并通过with_items语句指明迭代
- hosts: webservers
remote_user: root
tasks:
- name: "Install Packages"
yum: name={{item}} state=latest
with_items:
- httpd
- mysql-server
- php
也可以自己定义
- hosts: webserver
remote_user: root
tasks:
- name: "Add users"
user: name={{item.name}} state=present groups={{item.groups}}
with_items:
- {name: 'test1',groups: 'wheel'}
- {name: 'test2',groups: 'root'}