ansible——playbook剧本
文章目录
- ansible——playbook剧本
- 一、主机清单
- 二、Yaml文件
- 三、playbook剧本
- 四、Handlers介绍
- 五、条件测试
一、主机清单
1、基础配置
ansible 默认的主机清单是 /etc/ansible/hosts 文件
vi /etc/ansible/hosts
[webserver] #方括号中设置组名
www1.example.org #定义被监控主机,这边可以是主机名也可以是IP地址
www2.example.org:2222 #冒号后面定义远程连接端口,默认是ssh的22端口
如果是名称类似的主机可以使用列表的方式标识各个主机
[webserver]
www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=1
[dbservers]
db-[a:f].example.org #支持匹配a、b、c.....f
2、Inventory中的变量
1)、主机变量
[webserver]
www1.magedu.com http_port=80 maxRequestsCgild=808
www2.magedu.com http_port=8080 maxRequestsChild=909
2)、组变量
[servers:vars]
ntp_server=ntp.example.org
nfs_server=nfs.example.org
3)、组嵌套
[apache]
http1.example.org
http2.example.org
[nginx]
ngx1.example.org
ngx2.example.org
[webservers:children]
apache
nginx
4)、inventor变量参数
参数 | 说明 |
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文件
1、基本语法规则
1)、大小写敏感
2)、使用缩进表示层级关系
3)、缩进时不允许使用Tab键,只允许使用空格。
4)、缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
2、yaml支持的数据结构
1)、对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes)/ 字典(dictionary)
例如: name:Example Developer
2)、数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)
例如:- Apple
- Orange
3)、纯量:单个的、不可再分的值
例如:number: 12.30
sure: true
三、playbook剧本
1、playbook组成
(1) Tasks: 任务,即调用模块完成的某操作;
(2) Variables: 变量
(3) Templates: 模板
(4) Handlers: 处理器,当某条件满足时,触发执行的操作;
(5) Roles: 角色。
示例:
- hosts: webserver #定义的主机组,即应用的主机
vars: #定义变量
http_port: 80
max_clients: 200
user: root
tasks: #执行的任务
- name: ensure apache is at the latest version
yum: name=httpd state=latest
- name: write the apache config file
template: src=/srv/httpd.j2 dest=/etc/httpd.conf
notify:
- restart apache
- name: ensure apache is running
service: name=httpd state=started
handlers: #处理器
- name: restart apache
service: name=httpd state=restarted
执行
ansible-playbook [yaml文件名]
例如: ansible-playbook a.yaml
参数: -k (-ask-pass)用来交互输入ssh密码
-K(-ask-become-pass)用来交互输入sudo密码
-u :指定用户
命令
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开始运行
hosts和users介绍
- hosts: webservers #指定主机组,可以是以一个或多个组
remote_user: root #指定远程主机执行的用户名
为每个任务定义远程执行用户
- hosts: mysql
remote_user: root
tasks:
- name: test connection
ping:
remote_user: mysql #指定远程主机执行tasks的运行用户为mysql
执行playbook时: ansible-playbook ping.yml -k
四、Handlers介绍
Handlers也是一些task的列表, 和一般的task并没有什么区别。 是由通知者进行的notify,如
果没有被notify,则Handlers不会执行,假如被notify了 ,则Handlers被执行不管有多少个通
知者进行了notify,等到play中的所有task执行完成之后,handlers也只会被执行一次。
示例:
- hosts: webserver
remote_user: root
tasks:
- name: install httpd package
yum: name=httpd 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=httpd state=started
handlers:
- name: restart httpd
service: name=httpd state=restarted
也可以引入变量
- hosts: webserver
remote_user: root
vars:
- package: httpd
- service: httpd
tasks:
- name: install httpd package
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
playbook使用变量方法
通过ansible命令传递-e
例
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'
直接在yamI中定义变量,如上handlers示例
vi b.yaml
- hosts: mysql
remote_user: root
vars:
- user: zhangsan
tasks:
- name: add new user
user: name={{user}}
然后执行命令: ansible-playbook b.yml
直接引用一些变量
如: 引用ansible 的固定变量
vi test.yaml
- hosts: mysql
remote_user: root
tasks:
- name: copy file
copy: content="{{ansible_all_ipv4_addresses}}" dest=/opt/vars.txt
执行命令: ansible-playbook test.yaml
五、条件测试
如果需要根据变量、facts(setup)或此前任务的执行结果来作为某task执行与否的前提时要用
到条件测试,在playbook中条件测试在task后面添加when子句即可使用条件测试:when子句
支持jinjia2表达式或语法,例如:
1、单条件判断
vi when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shutdown CentOS"
command: /sbin/shutdown -h now
when: ansible_distribution == "CentOS"
2、多条件判断
vi when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shut down CentOS 7 systems"
command: /sbin/shutdown -r now
when:
- ansible_distribution == "CentOS"
- ansible_distribution_major_version == "7"
3、组条件判断
vi when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shut down 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")
4、自定义变量进行条件测试
vi when.yml
- hosts: all
vars:
exist: "True"
tasks:
- name: creaet file
command: touch /tmp/test.txt
when: exist | match("True")
- name: delete file
command: rm -rf /tmp/test.txt
when: exist | match("False")
5、迭代
当有需要重复性执行的任务时,可以使用迭代机制。其使用格式为将需要迭代的内容定义为
item变量引用,并通过with_items语句指明迭代。
- hosts: webserver
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'}
name表示要操作的软件包的名字;
state标识要做什么操作;
present:默认的,表示为安装;
lastest:安装为最新的版本;
absent:表示删除。