【Ansible的脚本------playbook剧本】犀渠玉剑良家子,白马金羁侠少年。这篇文章主要讲述Ansible的脚本------playbook剧本相关的知识,希望能为你提供帮助。
@[toc]
一、剧本的前置知识点
1、主机清单
ansible默认的主机清单是/etc/ansible/hosts文件
主机清单可以手动设置,也可以通过Dynamic Inventory动态生成
一般主机名使用FQDN
vi /etc/ansible/hosts
[webserver]#使用方括号设置组名
www1.example.org#定义被监控主机,这边可以是主机名也可以是IP地址
www2.example.org:2222#冒号后定义远程连接端口,默认是ssh的22端口
如果是名称类似的主机,可以使用列表的方式标识各个主机
[webserver]
//[01:50]表示匹配从01到50,后面跟着内置变量,这里定义了ssh的访问的用户名和密码,用于免交互登录
www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=abc123[dbbservers]
//[a:f]表示支持匹配a到f
db-[a:f].example.org
Inventory中的变量
主机变量
[webserver]
//定义变量http_port(开放的端口信息)和maxRequestsChild(最大进程数)
www1.magedu.com http_port=80 maxRequestsChild=808
www2.magedu.com http_port=8080 maxRequestsChild=909
组变量
[servers:vars]
ntp_server=ntp.example.org
nfs_server=nfs.example.org
组嵌套
[apache]
http1.example.org
http2.example.org[nginx]
ngx1.example.org
ngx2.example.org//定义一个组名,将刚才定义的两个组名放入,即webservers组包含apache组和nginx组的主机
[webservers]
apache
nginx
==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",比如 *BSD, 或者 /usr/bin/python
ansible_*_interpreter #这里的" * "可以是 ruby 或 perl 或其他语言的解释器,作用和ansible_python_interpreter 类似。
ansible_shell_executable #这将设置 ansibie 控制器将在目标机器上使用的 shell ,覆盖 ansible.cfg 中的配置,默认为 /bin/sh。
2、YAML
YAML:另一种标记语言。是用来写配置文件的语言,非常简洁和强大。
YAML语法和其他语言类似,也可以表达散列表、标量等数据结构。
结构通过空格来展示;序列里配置项通过-来代表; Map里键值用:来分隔; YAML的扩展名为yaml
(1)基本语法规则
大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tab键,只允许使用空格。
缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
(2)YAML支持的数据结构
对象
键值对的集合,又称为映射(mapping)/哈希(hashes)/字典(dictionary)
例如: name (键): Example(值)类class:(物品)
对象1:(桌子)
属性(名称,长、宽、高等)
方法(动词,放东西)
...
对象2
对象3
数组
一组按次序排列的值,又称为序列(sequence)/列表(list)
例如:-Apple
-Orange
纯量
单个的、不可再分的值
例如:number: 12.30
sure: true
二、Ansible的脚本------playbook通过task调用ansible的模板将多个play组织在一个playbook中运行。
1、playbooks的组成部分
- Tasks:任务,即调用模块完成的某操作;原理和事务一样,要么一起执行,要么一起不执行。
- Variables:变量;声明变量的三个场景:hosts文件中定义、剧本中定义、在命令中加上-e定义。
- Templates:模板;定义模板同一格式,解决每个服务可能因格式不一样而不兼容的问题。
- Handlers:处理器,当某条件满足时,触发执行的操作。
- Roles:角色;将任务分类执行,彼此之间互不干扰。
==我们先看一个playbook的示例简单了解一下==
vim httpd.yaml
- hosts: webserver
vars:
http_port: 80
max_clients: 200
user: root
tasks:
- name: ensure apache is at the latest version
yum: pkg=httpd state=latest
- name: write the apache config file
template: src=https://www.songbingjia.com/root/test/httpd.j2 dest=/etc/httpd/conf/httpd.conf
notify:
- restart apache
- name: ensure apache is running
service: name=httpd state=started
handlers:
- name: restart apache
service: name=httpd state=restarted#---------------------playbook解释------------------------
- hosts: webserver//定义的主机组,即应用的主机
vars://定义变量
http_port: 80
max_clients: 200
user: root//指定用户执行任务
tasks://执行的任务
- name: ensure apache is at the latest version//自定义输出内容,任务名称
yum: pkg=httpd state=latest//yum模块:指定软件包和版本参数;即使用yum安装最新版的httpd
- name: write the apache config file
template: src=/srv/httpd.j2 dest=/etc/httpd.conf//定义一个httpd的模板(在管理端自己创建)
notify://调用下面的操作
- restart apache//操作的名字,在handlers下定义
- name: ensure apache is running
service: name=httpd state=started//输出httpd状态
handlers://处理器
- name: restart apache//被调用的操作名字
service: name=httpd state=restarted//重启httpd服务
文章图片
2、执行playbook
格式:
ansible-playbook [yaml文件名]
例如:ansible-playbook ping.yml
参数:-k(–ask-pass) 用来交互输入ssh密码
-K(-ask-become-pass) 用来交互输入sudo密码
-u 指定用户补充命令:
ansible-playbook XXXX.yaml --syntax-check#检查yaml文件的语法是否正确
ansible-playbook XXXX.yaml --list-task#检查tasks任务
ansible-playbook XXXX.yaml --list-hosts#检查生效的主机
ansible-playbook XXXX.yaml --start-at-task=ensure apache is at the latest version#指定从某个task开始运行
3、hosts和users介绍
还可以为每个任务定义远程执行用户:
vim mysql.yaml
- hosts: mysql
remote_user: root
tasks:
- name: test connection
ping:
remote_user: li #指定远程主机执行tasks的运行用户为li
==执行playbook时:ansible-playbook mysql.yaml -k==
文章图片
4、为每个任务定义远程执行用户
cd /opt
vim 1.yaml- hosts: mysql
remote_user: root
tasks:
- name: test connection
ping:
remote_user: mysqlansible mysql -m user -a name=mysql
ansible mysql -m shell -a echo 123123 | passwd --stdin mysql
ansible-playbook 1.yaml -k
123456
5、指定远程主机切换用户执行剧本
vim 2.yaml- hosts: mysql
remote_user: root
become: yes
become_user: mysql
tasks:
- name: copy text
copy: src=https://www.songbingjia.com/etc/fstab dest=/home/mysql/fstab.bakansible-playbook 2.yaml
6、tasks忽略错误,强制返回成功
2、每一个task必须有一个名称 name,这样在运行playbook时,从其输出的任务执行信息中可以很好的辨别出是属于哪一个task的。
错误示例:遇到错误task自动停止,apache服务不会继续安装
vim 3.yaml- hosts: webserver
remote_user: root
tasks:
- name: stop selinux
command: /usr/sbin/setenforc 0
- name: install httpd
yum: name=httpd
- name: start httpd
service: name=httpd state=startedansible-playbook 3.yaml
加入ignore_errors: True 忽略错误,报错后继续执行
vim 3.yaml- hosts: webserver
remote_user: root
tasks:
- name: stop selinux
command: /usr/sbin/setenforc 0
ignore_errors: True
- name: install httpd
yum: name=httpd
- name: start httpd
service: name=httpd state=startedansible-playbook 3.yaml
文章图片
文章图片
针对多个主机节点执行剧本
vim 4.yaml- hosts: webserver
remote_user: root
tasks:
- name: remove httpd
yum: name=httpd state=absent- hosts: mysql
remote_user: root
tasks:
- name: copy file
copy: src=https://www.songbingjia.com/etc/fstab dest=/opt/haha.txt
文章图片
文章图片
7、Handlers介绍
Handlers也是一些task的列表,和一般的task并没有什么区别。
是由通知者进行的notify,如果没有被notify,则Handlers不会执行,假如被notify了,则Handlers被执行
不管有多少个通知者进行了notify,等到play中的所有task执行完成之后,handlers也只会被执行一次
示例
vim handler.yaml
- hosts: webserver
remote_user: root
tasks:
- name: install httpd package
yum: name=httpd state=latest
- name: install configuration file for httpd
copy: src=https://www.songbingjia.com/root/handler/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
文章图片
文章图片
文章图片
8、playbook使用变量
(1)通过ansible命令传递
例如:编辑如下yaml
vim test1.yml
- hosts: mysql
remote_user: root
vars:
- user:
tasks:
- name: add new user
user: name=user然后执行命令: ansible-playbook test1.yml -e "user=lisi"
可以执行命令查看:ansible mysql -m shell -a cat /etc/shadow |grep "lisi"
文章图片
文章图片
文章图片
(2)直接在yaml中定义变量
vim test2.yml
- 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=https://www.songbingjia.com/root/handler/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
在ansible
文章图片
文章图片
文章图片
文章图片
(3)直接引用一些变量
引用ansible的固定变量
vim test3.yml
- hosts: mysql
remote_user: root
tasks:
- name: copy file
copy: content="ansible_all_ipv4_addresses," dest=/opt/vars.txt
文章图片
==执行命令:ansible-playbook test3.yml
查看vars.txt文件内容:ansible mysql -a cat /opt/vars.txt==
文章图片
引用主机变量
vim /etc/ansible/hosts
在mysql组的主机后面添加如下
[mysql]
192.168.19.18 testvar="test1111" #定义testvar变量的值为test1111vim test3.yml #添加testvar主机变量
- hosts: mysql
remote_user: root
tasks:
- name: copy file
copy: content="ansible_all_ipv4_addresses,testvar" dest=/opt/vars.txt
文章图片
文章图片
==执行命令:ansible-playbook test3.yml
查看vars.txt文件内容:ansible mysql -a cat /opt/vars.txt==
文章图片
7、条件测试
如果需要根据变量、facts(setup)或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试,在Playbook中条件测试使用when子句。
在task后添加when子句即可使用条件测试:when子句支持jinjia2表达式或语法,例如:
vim when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shutdown CentOS"
command: /sbin/shutdown -h now
when: ansible_distribution == "CentOS"
文章图片
多条件判断
vim 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"
文章图片
组条件判断
vim when.yml
- hosts: mysql
remote_user: root
tasks:
- name: "shutdown CentOS 7 and Debian 7 systems"
command: /sbin/shutdown -r now
when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "7") or
(ansible_distribution == "Debian" and ansible_distribution_major_version == "7")
文章图片
9、迭代
当有需要重复性执行的任务时,可以使用迭代机制。其使用格式为将需要迭代的内容定义为item变量引用,并通过with_items语句指明迭代的元素列表即可。例如:
vim install.yaml
- hosts: webserver
remote_user: root
tasks:
- name:
command: rpm -Uvh http://dev.mysql.com/get/mysql-community-release-el7-5.noarch.rpm
- name: "Install Packages"
yum: name= item
with_items:
- httpd
- mysql-server
- php
文章图片
文章图片
也可以自己定义
vim add_users.yaml
- hosts: webserver
remote_user: root
tasks:
- name: "Add users"
user: name= item.namestate=present groups= item.groups
with_items:
-name: test1, groups: wheel
-name: test2, groups: root
文章图片
文章图片
推荐阅读
- Nessus 主机漏洞扫描器安装配置使用
- SAP UI5 设备类型检测 Device API 的工作原理
- HarmonyOS - 方舟开发框架ArkUI 基于JSAPI实现五子棋游戏
- kubernetes与velero的第一次尝试
- 解决IntelliJ idea的Maven Cannot resolve XXX PluginsDependencis等爆红问题总结
- Python 地图篇 - 使用pyecharts绘制世界地图中国地图省级地图市级地图实例详解
- 代码实现nadaraya-waston核回归#51CTO博主之星评选#
- Bash 特性
- Docker 安装部署