ANSIBLE PLAYBOOKS:任务剧本(任务集),编排定义Ansible任务集的配置文件,由Ansible顺序依次执行,通常是JSON格式的YML文件
INVENTORY:Ansible管理主机的清单/etc/anaible/hosts
MODULES:Ansible执行命令的功能模块,多数为内置核心模块,也可自定义
PLUGINS:模块功能的补充,如连接类型插件、循环插件、变量插件、过滤插件等,该功能不常用
API:供第三方程序调用的应用程序编程接口
ANSIBLE:组合INVENTORY、API、MODULES、PLUGINS的绿框,可以理解为是ansible命令工具,其为核心执行工具
Ansible命令执行来源:
USER,普通用户,即SYSTEM ADMINISTRATOR
CMDB(配置管理数据库) API 调用
PUBLIC/PRIVATE CLOUD API 调用
USER-> Ansible Playbook -> Ansibile
利用ansible实现管理的方式:
# 1、Ad-Hoc 即 ansible 命令,主要用于临时命令使用场景
# 2、Ansible-playbook 主要用于长期规划好的,大型项目的场景,需要有前提的规划
Ansible-playbook(剧本)执行过程:
# 1、将已有编排好的任务集写入 Ansible-Playbook
# 2、通过 ansible-playbook 命令分拆任务集至逐条 ansible 命令,按预定规则逐条执行
Ansible主要操作对象:
# 1、HOSTS 主机
# 2、NETWORKING 网络设备
注意事项:
# 1、执行ansible的主机一般称为主控端,中控,master或堡垒机
# 2、主控端Python版本需要2.6或以上
# 3、被控端Python版本小于2.4需要安装python-simplejson
# 4、被控端如开启SELinux需要安装libselinux-python
# 5、windows不能做为主控端
# yum install ansible
# yum -y install python-jinja2 PyYAML python-paramiko python-babel python-crypto
# tar xf ansible-1.5.4.tar.gz
# cd ansible-1.5.4
# python setup.py build
# python setup.py install
# mkdir /etc/ansible
# cp -r examples/* /etc/ansible
# git clone git://github.com/ansible/ansible.git --recursive
# cd ./ansible
# source ./hacking/env-setup
pip 是安装 Python 包的管理器,类似 yum
# yum install python-pip python-devel
# yum install gcc glibc-devel zibl-devel rpm-bulid openssl-devel
# pip install --upgrade pip
# pip install ansible --upgrade
[root@Tang ~]# ansible --version
ansible 2.8.5
config file = /etc/ansible/ansible.cfg
configured module search path = [u'/root/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
ansible python module location = /usr/lib/python2.7/site-packages/ansible
executable location = /usr/bin/ansible
python version = 2.7.5 (default, Oct 30 2018, 23:45:53) [GCC 4.8.5 20150623 (Red Hat 4.8.5-36)]
# /etc/ansible/ansible.cfg # 主配置文件,配置 ansible 工作特性
# /etc/ansible/hosts # 主机清单
# /etc/ansible/roles/ # 存放角色的目录
# /usr/bin/ansible # 主程序,临时命令执行工具
# /usr/bin/ansible-doc # 查看配置文档,模块功能查看工具
# /usr/bin/ansible-galaxy # 下载/上传优秀代码或Roles模块的官网平台
# /usr/bin/ansible-playbook # 定制自动化任务,编排剧本工具/usr/bin/ansible-pull 远程执行命令的工具
# /usr/bin/ansible-vault # 文件加密工具
# /usr/bin/ansible-console # 基于Console界面与用户交互的执行工具
inventory 文件遵循 INI 文件风格,中括号中的字符为组名。可以将同一个主机同时归并到多个不同的组中;此外,当如若目标主机使用了非默认的SSH端口,还可以在主机名称之后使用冒号加端口号来标明
ntp.neotang.com
[webservers]
www1.neotang.com:2222
www2.neotang.com
[dbservers]
db1.neotang.com
db2.neotang.com
db3.neotang.com
如果主机名称遵循相似的命名模式,还可以使用列表的方式标识各主机,中括号内的数字或字母会自动展开
[websrvs]
www[01:100].example.com
[dbsrvs]
db-[a:f].example.com
示例:
[root@Tang ~]# cat /etc/ansible/hosts | grep testhosts -A 1
[testhosts]
www.neotang[1:5].com
[root@Tang ~]# ansible testhosts --list-hosts
hosts (5):
www.neotang1.com
www.neotang2.com
www.neotang3.com
www.neotang4.com
www.neotang5.com
[defaults]
#inventory = /etc/ansible/hosts # 主机列表配置文件
#library = /usr/share/my_modules/ # 库文件存放目录
#remote_tmp = $HOME/.ansible/tmp # 临时py命令文件存放在远程主机目录
#local_tmp = $HOME/.ansible/tmp # 本机的临时命令执行目录
#forks = 5 # 默认并发数
#sudo_user = root # 默认 sudo 用户
#ask_sudo_pass = True # 每次执行 ansible 命令是否询问 ssh 密码
#ask_pass = True
#remote_port = 22 # ssh 登陆时使用的端口号
#host_key_checking = False # 检查对应服务器的 host_key,建议取消注释
#log_path=/var/log/ansible.log # 日志文件
#module_name = command # 默认模块,使用 command 模块时,不需要指明模块
[root@Tang ~]# ansible
ansible ansible-connection ansible-doc
ansible-galaxy-2 ansible-playbook-2 ansible-pull-2.7
ansible-2 ansible-console ansible-doc-2
ansible-galaxy-2.7 ansible-playbook-2.7 ansible-vault
ansible-2.7 ansible-console-2 ansible-doc-2.7
ansible-inventory ansible-pull ansible-vault-2
ansible-config ansible-console-2.7 ansible-galaxy
ansible-playbook ansible-pull-2 ansible-vault-2.7
# ansible-doc [options] [module...]
-a # 显示所有模块的文档
-l, --list # 列出可用模块
-s, --snippet # 显示指定模块的 playbook 片段
# ansible-doc –l # 列出所有模块
# ansible-doc ping # 查看指定模块帮助用法
# ansible-doc –s ping # 查看指定模块帮助用法
ansible 通过 ssh 实现配置管理、应用部署、任务执行等功能,建议配置 ansible 端能基于密钥认证的方式联系各被管理节点。
# ansible <host-pattern> [-m module_name] [-a args]
# --version # 显示版本
# -m module # 指定模块,默认为command
# -v # 详细过程
# –vv
# -vvv # 更详细
# --list-hosts # 显示主机列表,可简写 --list
# -k, --ask-pass # 提示输入ssh连接密码,默认Key验证
# -K, --ask-become-pass # 提示输入sudo时的口令
# -C, --check # 检查语法,并不执行
# -T, --timeout=TIMEOUT # 执行命令的超时时间,默认10s
# -u, --user=REMOTE_USER # 执行远程执行的用户
# -b, --become # 代替旧版的 sudo 切换
# --become-user=USERNAME # 指定sudo的runas用户,默认为root
功用:匹配主机的列表
All :表示所有Inventory中的所有主机
# ansible all –m ping
*
:通配符
# ansible “*” -m ping
# ansible 192.168.1.* -m ping
# ansible “*srvs” -m ping
逻辑或 关系
# ansible “websrvs:appsrvs” -m ping
# ansible “192.168.1.10:192.168.1.20” -m ping
逻辑与 关系
# ansible “websrvs:&dbsrvs” –m ping
# 在websrvs组并且在dbsrvs组中的主机
逻辑非 关系
# ansible ‘websrvs:!dbsrvs’ –m ping
# 在websrvs组,但不在dbsrvs组中的主机
# 注意:此处为单引号
综合逻辑 关系
# ansible ‘websrvs:dbsrvs:&appsrvs:!ftpsrvs’ –m ping
正则表达式
# ansible “websrvs:&dbsrvs” –m ping
# ansible “~(web|db).*\.magedu\.com” –m ping
# 以 tang 用户执行 ping 存活检测
# ansible all -m ping -u tang -k
# 以 tang sudo 至 root 执行 ping 存活检测
# ansible all -m ping -u tang -k -b
# 以 tang sudo至 neo 用户执行 ping 存活检测
# ansible all -m ping -u tang -k -b --become-user=neo
# 以 tang sudo 至 root 用户执行ls
# ansible all -m command -u tang -a 'ls /root' -b --become-user=root -k -K
在远程主机执行命令,默认模块,可忽略 -m 选项。
此命令不支持 $VARNAME < > | ; &
等,用 shell 模块实现
# ansible srvs -m command -a "service vsftpd start"
# ansible srvs -m command -a "echo neotang |passwd --stdin neotang"
和 command 相似,用 shell 执行命令
调用bash执行命令 类似 cat /tmp/stanley.md | awk -F‘|’ ‘{print $1,$2}’ &> /tmp/example.txt
这些复杂命令,即使使用 shell 也可能会失败,解决办法:写到脚本里,copy 到远程,执行,再把需要的结果拉回执行命令的机器
# ansible srv -m shell -a "echo neotang |passwd –stdin neotang"
在远程主机上运行 ansible 服务器上的脚本
# -a "/PATH/TO/SCRIPT_FILE“
# ansible websrvs -m script -a /data/f1.sh
从服务器复制文件到客户端
# ansible srv -m copy -a "src=/root/f1.sh dest=/tmp/f2.sh owner=neotang mode=600 backup=yes"
# 如目标存在,默认覆盖,此处指定先备份
# ansible srv -m copy -a "content=‘test content\n’ dest=/tmp/f1.txt"
# 指定内容,直接生成目标文件
从客户端取文件至服务器端,copy 相反,目录可先 tar
# ansible srv -m fetch -a "src=/root/a.sh dest=/data/scripts"
设置文件属性
# ansible srv -m file -a "path=/root/a.sh owner=neotang mode=755"
# ansible web -m file -a "src=/app/testfile dest=/app/testfile-link state=link"
管理主机名
# ansible node1 -m hostname -a "name=websrv"
minute,hour,day,month,weekday
# ansible srv -m cron -a "minute=*/5 job=‘/usr/sbin/ntpdate 172.16.0.1 &>/dev/null’ name=Synctime"
# 创建任务,如果不指定 name 参数,名称为 None
# ansible srv -m cron -a "state=absent name=Synctime"
# 删除任务
# ansible srv -m yum -a 'name=httpd state=present' # 安装
# ansible srv -m yum -a 'name=httpd state=latest' # 安装最新版本
# ansible srv -m yum -a 'name=httpd state=absent' # 删除
管理服务
# ansible srv -m service -a 'name=httpd state=stopped'
# ansible srv -m service -a 'name=httpd state=started enabled=yes'
# ansible srv -m service -a 'name=httpd state=reloaded'
# ansible srv -m service -a 'name=httpd state=restarted'
# ansible srv -m user -a 'name=user1 comment=“test user” uid=2048 home=/app/user1 group=root'
# ansible srv -m user -a 'name=sysuser1 system=yes home=/app/sysuser1'
# ansible srv -m user -a 'name=user1 state=absent remove=yes'
# 删除用户及家目录等数据
# ansible srv -m group -a "name=testgroup system=yes"
# ansible srv -m group -a "name=testgroup state=absent"
# 连接 https://galaxy.ansible.com 下载相应的roles
# 列出所有已安装的 galaxy
# ansible-galaxy list
# 安装 galaxy
# ansible-galaxy install geerlingguy.redis
# 删除 galaxy
# ansible-galaxy remove geerlingguy.redis
# 执行 playbook 命令如下:
# ansible-playbook hello.yml
# cat hello.yml
- hosts: websrvs
remote_user: root
tasks:
- name: hello world
command: /usr/bin/wall hello world
# ansible-vault [create|decrypt|edit|encrypt|rekey|view]
# ansible-vault encrypt hello.yml # 加密
# ansible-vault decrypt hello.yml # 解密
# ansible-vault view hello.yml # 查看
# ansible-vault edit hello.yml # 编辑加密文件
# ansible-vault rekey hello.yml # 修改口令
# ansible-vault create new.yml # 创建新文件
root@test (2)[f:10] $
,执行用户@当前操作的主机组 (当前组的主机数量)[f:并发数]$示例:
# root@all (2)[f:5]$ list
# root@all (2)[f:5]$ cd appsrvs
# root@appsrvs (2)[f:5]$ list
# root@appsrvs (2)[f:5]$ yum name=httpd state=present
# root@appsrvs (2)[f:5]$ service name=httpd state=started
YAML 是一个可读性高的用来表达资料序列的格式。YAM L参考了其他多种语言,包括:XML、C语言、Python、Perl以及电子邮件格式RFC2822等
YAML Ain’t Markup Language,即YAML不是XML。不过,在开发的这种语言时,YAML的意思其实是:“Yet Another Markup Language”(仍是一种标记语言)
特性
YAML 的可读性好
YAML 和脚本语言的交互性好
YAML 使用实现语言的数据类型
YAML 有一个一致的信息模型
YAML 易于实现
YAML 可以基于流来处理
YAML 表达能力强,扩展性好
更多的内容及规范参见http://www.yaml.org
---
区分多个档案。另外,还有选择性的连续三个点号...
用来表示档案结尾:
分隔name: task
List:列表,其所有元素均使用-
打头
示例:
# A list of tasty fruits
- Apple
- Orange
- Strawberry
- Mango
Dictionary:字典,通常由多个key与value构成
示例:
---
# An employee record
name: Example Developer
job: Developer
skill: Elite
也可以将key:value
放置于{}
中进行表示,用,
分隔多个key:value
示例:
---
# An employee record
{name: Example Developer, job: Developer, skill: Elite}
YAML 的语法和其他高阶语言类似,并且可以简单表达清单、散列表、标量等数据结构。其结构(Structure)通过空格来展示,序列(Sequence)里的项用"-“来代表,Map里的键值对用”:"分隔
示例:
name: John Smith
age: 41
gender: Male
spouse:
name: Jane Smith
age: 37
gender: Female
children:
- name: Jimmy Smith
age: 17
gender: Male
- name: Jenny Smith
age 13
gender: Female
# ansible-playbook –t tagsname useradd.yml
playbook中的每一个play的目的都是为了让特定主机以某个指定的用户身份执行任务。hosts用于指定要执行指定任务的主机,须事先定义在主机清单中
可以是如下形式:
one.example.com
one.example.com:two.example.com
192.168.1.50
192.168.1.*
Websrvs:dbsrvs 或,两个组的并集
Websrvs:&dbsrvs 与,两个组的交集
webservers:!phoenix 在websrvs组,但不在dbsrvs组
示例: - hosts: websrvs:dbsrvs
- hosts: websrvs
remote_user: root
tasks:
- name: test connection
ping:
remote_user: neo
sudo: yes # 默认 sudo 为root
sudo_user:tang # sudo 为 tang
tasks:任务列表
两种格式:
(1) action: module arguments
(2) module: arguments 建议使用
注意:shell 和 command模块后面跟命令,而非key=value
某任务的状态在运行后为 changed 时,可通过 “notify” 通知给相应的 handlers
任务可以通过"tags“打标签,可在ansible-playbook命令上使用-t指定进行调用
示例:
tasks:
- name: disable selinux
command: /sbin/setenforce 0
如果命令或脚本的退出码不为零,可以使用如下方式替代
tasks:
- name: run this command and ignore the result
shell: /usr/bin/somecommand || /bin/true
或者使用ignore_errors来忽略错误信息
tasks:
- name: run this command and ignore the result
shell: /usr/bin/somecommand
ignore_errors: True
运行playbook的方式
# ansible-playbook <filename.yml> ... [options]
常见选项
--check -C # 只检测可能会发生的改变,但不真正执行操作
--list-hosts # 列出运行任务的主机
--list-tags # 列出 tag
--list-tasks # 列出 task
--limit # 主机列表 只针对主机列表中的主机执行
-v -vv -vvv # 显示过程
示例
# ansible-playbook file.yml --check # 只检测
# ansible-playbook file.yml
# ansible-playbook file.yml --limit websrvs
#!/bin/bash
#
# 安装Apache
yum install --quiet -y httpd
# 复制配置文件
cp /tmp/httpd.conf /etc/httpd/conf/httpd.conf
cp/tmp/vhosts.conf /etc/httpd/conf.d/
# 启动Apache,并设置开机启动
service httpd start
chkconfig httpd on
---
- hosts: all
tasks:
- name: "安装Apache"
yum: name=httpd
- name: "复制配置文件"
copy: src=/tmp/httpd.conf dest=/etc/httpd/conf/
- name: "复制配置文件"
copy: src=/tmp/vhosts.conf dest=/etc/httpd/conf.cd/
- name: "启动Apache,并设置开机启动"
service: name=httpd state=started enabled=yes
# sysuser.yml
---
- hosts: all
remote_user: root
tasks:
- name: create mysql user
user: name=mysql system=yes uid=36
- name: create a group
group: name=httpd system=yes
# httpd.yml
---
- hosts: websrvs
remote_user: root
tasks:
- name: Install httpd
yum: name=httpd state=present
- name: Install configure
file copy: src=files/httpd.conf dest=/etc/httpd/conf/
- name: start service
service: name=httpd state=started enabled=yes
Handlers 是 task 列表,这些task与前述的task并没有本质上的不同,用于当关注的资源发生变化时,才会采取一定的操作
Notify 此 action 可用于在每个 play 的最后被触发,这样可避免多次有改变发生时每次都执行指定的操作,仅在所有的变化发生完成后一次性地执行指定操作。在 notify 中列出的操作称为 handler,也即 notify 中调用 handler 中定义的操作
示例1:
- hosts: websrvs
remote_user: root
tasks:
- name: Install httpd
yum: name=httpd state=present
- name: Install configure file
copy: src=files/httpd.conf dest=/etc/httpd/conf/
notify: restart httpd
- name: ensure apache is running
service: name=httpd state=started enabled=yes
handlers:
- name: restart httpd
service: name=httpd status=restarted
示例2:
- hosts: websrvs
remote_user: root
tasks:
- name: add group nginx
tags: user
user: name=nginx state=present
- name: add user nginx
user: name=nginx state=present group=nginx
- name: Install Nginx
yum: name=nginx state=present
- name: config
copy: src=/root/config.txt dest=/etc/nginx/nginx.conf
notify:
- Restart Nginx
- Check Nginx Process
handlers:
- name: Restart Nginx
service: name=nginx state=restarted enabled=yes
- name: Check Nginx process
shell: killall -0 nginx > /tmp/nginx.log
httpd.yml
- hosts: websrvs
remote_user: root
tasks:
- name: Install httpd
yum: name=httpd state=present
- name: Install configure file
copy: src=files/httpd.conf dest=/etc/httpd/conf/
tags: conf
- name: start httpd service
tags: service
service: name=httpd state=started enabled=yes
# ansible-playbook –t conf httpd.yml # 进行脚本执行,只会执行相应 tags 的 tasks
变量名:仅能由字母、数字和下划线组成,且只能以字母开头
变量来源:
1、ansible setup facts 远程主机的所有变量都可直接调用
2、在/etc/ansible/hosts中定义
普通变量:主机组中主机单独定义,优先级高于公共变量
公共(组)变量:针对主机组中所有主机定义统一变量
3、通过命令行指定变量,优先级最高
# ansible-playbook –e varname=value
4、在 playbook 中定义(注意变量定义格式)
vars:
- var1: value1
- var2: value2
5、在独立的变量 YAML 文件中定义
6、在role中定义
变量命名:变量名仅能由字母、数字和下划线组成,且只能以字母开头
变量定义:key=value
示例:http_port=80
变量调用方式:
1、通过{{ variable_name }} 调用变量,且变量名前后必须有空格,有时用“{{ variable_name }}”才生效
2、ansible-playbook –e 选项指定
# ansible-playbook test.yml -e "hosts=www user=tang"
可以在 inventory 中定义主机时为其添加主机变量以便于在 playbook 中使用。
[websrvs]
www1.neotang.com http_port=80 maxRequestsPerChild=808
www2.neotang.com http_port=8080 maxRequestsPerChild=909
组变量是指赋予给指定组内所有主机上的在 playbook 中可用的变量。
[websrvs]
www1.neo.com
www2.neo.com
[websrvs:vars]
ntp_server=ntp.neo.com
nfs_server=nfs.neo.com
1、普通变量
[websrvs]
192.168.99.101 http_port=8080 hname=www1
192.168.99.102 http_port=80 hname=www2
2、公共(组)变量
[websvrs:vars]
http_port=808
mark=“_”
[websrvs]
192.168.99.101 http_port=8080 hname=www1
192.168.99.102 http_port=80 hname=www2
# ansible websvrs –m hostname –a ‘name={{ hname }}{{ mark }}{{ http_port }}’
3、命令行指定变量:
# ansible websvrs –e http_port=8000 –m hostname –a ‘name={{ hname }}{{ mark }}{{ http_port }}’
# setup 的变量获取(获取主机 253 所有的变量信息)
# ansible 172.16.141.253 -m setup | less
# cat var.yml
- hosts: websrvs
remote_user: root
tasks:
- name: create log file
file: name=/var/log/ {{ ansible_fqdn }} state=touch
# ansible-playbook var.yml
# cat var.yml
- hosts: websrvs
remote_user: root
tasks:
- name: install package
yum: name={{ pkname }} state=present
# ansible-playbook –e pkname=httpd var.yml
# cat var.yml
- hosts: websrvs
remote_user: root
vars:
- username: user1
- groupname: group1
tasks:
- name: create group
group: name={{ groupname }} state=present
- name: create user
user: name={{ username }} state=present
# ansible-playbook var.yml
# ansible-playbook -e "username=user2 groupname=group2” var2.yml
定义变量文件
cat vars.yml
var1: httpd
var2: nginx
进行变量文件引用
cat var.yml
- hosts: web
remote_user: root
vars_files:
- vars.yml
tasks:
- name: create httpd log
file: name=/app/{{ var1 }}.log state=touch
- name: create nginx log
file: name=/app/{{ var2 }}.log state=touch