Ansible中文手册
一. Ansible 介绍
工具 | 简介 |
---|---|
Puppet | 基于 Ruby 开发,采用 C/S 架构,扩展性强,基于 SSL,远程命令执行相对较弱 |
SaltStack | 基于 Python 开发,采用 C/S 架构,相对 puppet 更轻量级,配置语法使用YMAL,使得配置脚本更简单 |
Ansible | 基于 Python paramiko 开发,分布式,无需客户端,轻量级,配置语法使用 YMAL 及 Jinja2模板语言,更强的远程命令执行操作 |
其他 DevOps 请参看:https://github.com/geekwolf/sa-scripts/blob/master/devops.md
Ansible 是一个简单的自动化运维管理工具,可以用来自动化部署应用、配置、编排 task(持续交付、无宕机更新等),采用 paramiko 协议库(fabric 也使用这个),通过 SSH 或者 ZeroMQ 等连接主机,大概每 2 个月发布一个主版本
Ansible 在管理节点将 Ansible 模块通过 SSH协议(或者 Kerberos、LDAP)
推送到被管理端执行,执行完之后自动删除,可以使用 SVN 等来管理自定义模块及编排
由上面的图可以看到 Ansible 的组成由 5 个部分组成:
组件 | 说明 |
---|---|
Ansible | 核心 |
Modules | 包括 Ansible 自带的核心模块及自定义模块 |
Plugins | 完成模块功能的补充,包括连接插件、邮件插件等 |
Playbooks | 网上很多翻译为剧本,个人觉得理解为编排更为合理;定义 Ansible 多任务配置文件,有 Ansible 自动执行 |
Inventory | 定义 Ansible 管理主机的清单 |
二. Ansible 安装
使用环境 Ubuntu14.04.1 LTS
ControlMachine: 192.168.0.4
Managed Nodes0: 192.168.0.5 192.168.0.6
注意:Ansible 默认使用 SSH 协议管理节点
安装要求:
控制服务器:需要安装 Python2.6/2.7
被管理服务器:需要安装 Python2.4 以上版本,若低于 Python2.5 需要安装 python-
simplejson; 若启用了 selinux,则需要安装 libselinux-python
1、方式一:源码安装
1.git clone git://github.com/ansible/ansible.git --recursive
2.cd ./ansible
3.source ./hacking/env-setup
4.sudo easy_install pip
5.sudo pip install paramiko PyYAML Jinja2 httplib2
Ansible 升级操作:
1.git pull --rebase
2.git submodule update --init--recursive
Git 知识请参考:
http://blog.csdn.net/huangyabin001/article/details/30100287
http://git-scm.com/docs/git-submodule
执行脚本 evn-setup 时会读取默认的主机清单文件/etc/ansible/hosts,主机清单文件路径可以通过环境变量ANSIBLE_HOSTS 设置或者执行 ansible 时-i 参数指定
最后可以执行
1.sudo makeinstall
将 ansible 安装到 control server
问题 1 :
1.x86_64-linux-gnu-gcc -pthread -fno-strict-aliasing -fwrapv -Wall-Wstrict-prototypes -fPIC -std=c99 -O3 -
2.fomit-frame-pointer -Isrc/ -I/usr/include/python2.7 -c src/MD2.c -o build/temp.linux-x86_64-
3.2.7/src/MD2.o
4.src/MD2.c:31:20: fatal error: Python.h: No suchfile or directory
5.#include "Python.h"
6.^
7.compilation terminated.
8.error: command 'x86_64-linux-gnu-gcc' failed with exit status 1
解决办法:
1.sudoapt-get install python-dev
2、方式二:yum 和 apt 安装
(由于Ansible 可以管理包含 Python2.4+版本的早期启动,故适用 EL5):
安装 EPEL 源
1.rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
2.rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-6
3.sudo yum install ansible
或者可以使用源码自己打包 rpm 安装
1.git clone git://github.com/ansible/ansible.git
2.cd ./ansible$ make rpm
3.sudo rpm -Uvh~/rpmbuild/ansible-*.noarch.rpm
添加 apt 源
1.vim/etc/apt/source.list
2.deb http://ppa.launchpad.net/ansible/ansible/ubuntu trusty main
3.deb-src http://ppa.launchpad.net/ansible/ansible/ubuntu trusty main
4.sudo apt-get install software-properties-common
5.sudo apt-add-repository ppa:ansible/ansible
6.sudo apt-get update
7.sudo apt-get install ansible
注释:旧的 ubuntu 发行版 software-properties-common 包叫 python-software-properties也可以通过源码 make deb 生成 deb包 apt 去安装
使用 pip 或者 pipsi 的 python 包管理工具安装
1.sudo pip install ansible
2.curlhttps://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | \
3.python
4.pipsi install ansible
三. 开始使用
针对不支持 ControlPersist 的系统如 RHEL6可以通过使用 Ansible 加速模式或者 SSH pipelining( pipelining=on )进行优化来提高连接速度Ansible 加速模式支持 RHEL6 控制端和其他受限的环境
1、加速模式使用方法:
在定义的 playbooks 里面添加 accelerate: true
参数
1.---
2.- hosts: all
3.accelerate: true
4.tasks:
5.- name: some task
6.command: echo {{ item }}
7.with_items:
8.- foo
9.- bar
10.- baz
更改 Ansible 用于加速连接的端口,使用参数 accelerate_port
,端口配置可以设置系统环境变量ACCELERATE_PORT 或者修改 ansible.cfg
配置文件,accelerate_multi_key
允许使用多把密钥
1.[accelerate]
2.accelerate_port = 5099
3.---
4.- hosts: all
5.accelerate: true
6.# default port is 5099
7.accelerate_port: 10000
8.accelerate_multi_key = yes
注释:Ansible 加速模式支持 sudo 操作,但需要注释 /etc/sudoers #Defaults requiretty;
sudo 密码还未支持,所以 sudo 执行需要 NOPASSWD
官方鼓励使用 SSH Keys,也可以通过参数–ask-pass 及–ask-sudo-pass 使用密码
尝鲜 Ansible
控制端:
1.vim /etc/ansilbe/hosts
2.192.168.0.4
3.192.168.0.5
4.192.168.0.6
1.root@geekwolf:~# ssh-keygen
2.root@geekwolf:~# ssh-copy-id -i~/.ssh/id_rsa.pub root@192.168.0.4
3.root@geekwolf:~# ssh-copy-id -i~/.ssh/id_rsa.pub root@192.168.0.5
4.root@geekwolf:~# ssh-copy-id -i~/.ssh/id_rsa.pub root@192.168.0.6
1.ssh-agent bash
2.ssh-add ~/.ssh/id_rsa
1.if [ -f ~/.agent.env ]; then
2.. ~/.agent.env >/dev/null
3.if ! kill -s 0 $SSH_AGENT_PID >/dev/null 2>&1; then
4.echo "Stale agent file found. Spawning new agent..."
5.eval `ssh-agent |tee ~/.agent.env`
6.ssh-add
7.fielse
8.echo "Starting ssh-agent..."
9.eval `ssh-agent |tee ~/.agent.env`
10.ssh-add
11.fi
测试 ping:
1.root@geekwolf:~# ansibleall -m ping
2.192.168.0.4 | success >> {
3."changed": false,
4."ping": "pong"
5.}
6.192.168.0.6 | success >> {
7."changed": false,
8."ping": "pong"
9.}
10.192.168.0.5 | success >> {
11."changed": false,
12."ping": "pong"
13.}
其他事例:
以 bruce 身份 ping 所有主机
1.ansible all -m ping -u bruce
用 bruce 用户以 root 身份 ping
1.ansible all -m ping -u bruce --sudo
用 bruce 用户 sudo到 batman 用户 ping
1.ansible all -m ping -u bruce --sudo --sudo-user batman
在所有节点上执行命令
1.ansible all -a "/bin/echo hello"
2、Ansible 命令参数介绍
Usage: ansible [options]
参数 | 说明 |
---|---|
-m MODULE_NAME, | -module-name=MODULE_NAME 要执行的模块,默认为 command |
-a MODULE_ARGS, | -args=MODULE_ARGS 模块的参数 |
-u REMOTE_USER, | -user=REMOTE_USER ssh 连接的用户名,默认用 root,ansible.cfg 中可以配置 |
-k, –ask-pass | 提示输入 ssh 登录密码,当使用密码验证登录的时候用 |
-s, –sudo | sudo 运行 |
-U SUDO_USER, –sudo-user=SUDO_USER | sudo到哪个用户,默认为 root |
-K, –ask-sudo-pass 提示输入 sudo 密码, | 当不是 NOPASSWD 模式时使用 |
-B SECONDS, –background=SECONDS | run asynchronously, failing after X seconds(default=N/A) |
-PPOLL_INTERVAL, –poll=POLL_INTERVAL | set the poll interval if using |
-B | (default=15) |
-C, –check | 只是测试一下会改变什么内容,不会真正去执行 |
-c CONNECTION | 连接类型(default=smart) |
-f FORKS, –forks=FORKS | fork 多少个进程并发处理,默认 5 |
-i INVENTORY,–inventory-file=INVENTORY | 指定 hosts 文件路径,默认 default=/etc/ansible/hosts |
-l SUBSET, –limit=SUBSET | 指定一个 pattern,对已经匹配的主机中再过滤一次 |
–list-hosts | 只打印有哪些主机会执行这个 playbook 文件,不是实际执行该 playboo |
-M MODULE_PATH, –module-path=MODULE_PATH | 要执行的模块的路径,默认为/usr/share/ansible/ |
-o, –one-line | 压缩输出,摘要输出 |
–private-key=PRIVATE_KEY_FILE | 私钥路径 |
-T TIMEOUT,–timeout=TIMEOUT | ssh 连接超时时间,默认 10 秒 |
-t TREE, –tree=TREE | 日志输出到该目录,日志文件名会以主机名命名 |
-v, –verbose | verbose mode (-vvv for more, -vvvv to enable connection debugging) |
注释:
1.在首次连接或者重装系统之后会出现检查 keys 的提示
1.Theauthenticity of host '192.168.0.5 (192.168.0.5)' can't be established.
2.ECDSA key fingerprint is 05:51:e5:c4:d4:66:9b:af:5b:c9:ba:e9:e6:a4:2b:fe.
3.Are you sure you want to continue connecting (yes/no)?
解决办法:
1.vim/etc/ansible/ansible.cfg 或者 ~/.ansible.cfg
2.[defaults]
3.host_key_checking = False
也可以通过设置系统环境变量来禁止这样的提示
1.export ANSIBLE_HOST_KEY_CHECKING=False
2.在使用 paramiko 模式时,主机 keys 的检查会很慢
3.默认情况下Ansible 会记录一些模块的参数等信息到每个被控端的 syslog 日志文件里,除非在任务或者剧本里设置了 no_log: True 会不记录日志*
3、主机清单 Inventory
Ansible 通过读取默认的主机清单配置/etc/ansible/hosts,可以同时连接到多个远程主机上执行任务,默认路径可以通过修改 ansible.cfg
的hostfile
参数指定路径
1./etc/ansible/hosts 主机清单配置格式如下
2.mail.example.com[webservers]
3.Foo.example.com
4.Bar.example.com
5.[dbservers]
6.One.example.com
7.Two.example.com
8.three.example.com
9.badwolf.example.com:5309 指定 SSH端口 5309
10.jumper ansible_ssh_port=5555 ansible_ssh_host=192.168.1.50 设置主机别名为 jumper
11.www[01:50].example.com 支持通配符匹配 www01 www02 ...www50
12.[databases]
13.db-[a:f].example.com 支持字母匹配 a b c...f
1.[targets]
2.localhost ansible_connection=local
3.other1.example.com ansible_connection=ssh ansible_ssh_user=mpdehaan
4.other2.example.com ansible_connection=ssh ansible_ssh_user=mdehaan
可以为每个主机单独指定一些变量,这些变量随后可以在 playbooks中使用:
1.[atlanta]
2.host1http_port=80 maxRequestsPerChild=808
3.host2http_port=303 maxRequestsPerChild=909
1.[atlanta]
2.host1
3.host2
4.[atlanta:vars]
5.ntp_server=ntp.atlanta.example.com
6.proxy=proxy.atlanta.example.com
1.[atlanta]
2.host1
3.host2
4.[raleigh]
5.host2
6.host3
7.[southeast:children]
8.atlanta
9.raleigh
10.[southeast:vars]
11.some_server=foo.southeast.example.com
12.halon_system_timeout=30
13.self_destruct_countdown=60
14.escape_pods=2
15.[usa:children]
16.southeast
17.northeast
18.southwest
19.northwest
[]表示主机的分组名,可以按照功能、系统等进行分类,便于对某些主机或者某一组功能相同的主机进行操作
为 host 和 group 定义一些比较复杂的变量时(如 array、hash),可以用单独文件保存host
和 group 变量,以 YAML格式书写变量,避免都写在 hosts文件显得混乱,如 hosts 文件路径为:
1./etc/ansible/hosts
则 host 和 group变量目录结构:
1./etc/ansible/host_vars/all #host_vars 目录用于存放host 变量,all 文件对所有主机有效
2./etc/ansible/group_vars/all #group_vars 目录用于存放 group 变量,all 文件对所有组有效
3./etc/ansible/host_vars/foosball #文件 foosball要和 hosts 里面定义的主机名一样,表示只对 foosball主机有效
4./etc/ansible/group_vars/raleigh #文件 raleigh 要和 hosts里面定义的组名一样,表示对raleigh 组下的所有主机有效
这里/etc/ansible/group_vars/raleigh
格式如下:
1.--- #YAML 格式要求
2.ntp_server:acme.example.org #变量名:变量值
3.
4.database_server: storage.example.org
注意:官方建议将/etc/ansible
目录使用 git/svn
来进行版本控制便于跟踪和修改
hosts 文件支持一些特定指令,上面已经使用了其中几个,所有支持的指令如下:
指令 | 说明 |
---|---|
ansible_ssh_host | 指定主机别名对应的真实 IP,如:251 ansible_ssh_host=183.60.41.251,随后连接该主机无须指定完整 IP,只需指定251 就行 |
ansible_ssh_port | 指定连接到这个主机的 ssh端口,默认 22 |
ansible_ssh_user | 连接到该主机的 ssh用户 |
ansible_ssh_pass | 连接到该主机的 ssh密码(连-k 选项都省了),安全考虑还是建议使用私钥或在命令行指定-k 选项输入 |
ansible_sudo_pass | sudo 密码 |
ansible_sudo_exe(v1.8+的新特性) | sudo 命令路径 |
ansible_connection | 连接类型,可以是 local、ssh 或 paramiko,ansible1.2 之前默认为 paramiko |
ansible_ssh_private_key_file | 私钥文件路径 |
ansible_shell_type | 目标系统的 shell类型,默认为 sh,如果设置csh/fish,那么命令需要遵循它们语法 |
ansible_python_interpreter | python 解释器路径,默认是/usr/bin/python,但是如要要连*BSD系统的话,就需要该指令修改 python路径 |
ansible_*_interpreter | 这里的”*”可以是 ruby 或 perl 或其他语言的解释器,作用和 ansible_python_interpreter 类似 |
例子:
1.some_host ansible_ssh_port=2222 ansible_ssh_user=manager
2.aws_host ansible_ssh_private_key_file=/home/example/.ssh/aws.pem
3.freebsd_host ansible_python_interpreter=/usr/local/bin/python
4.ruby_module_host ansible_ruby_interpreter=/usr/bin/ruby.1.9.3
动态获取主机及引用相关参数可以参考,后续的应用一章会详细介绍
http://docs.ansible.com/intro_dynamic_inventory.html
http://rfyiamcool.blog.51cto.com/1030776/1416808
4、通配模式 Patterns
在 Ansible 中,Patterns 意味着要管理哪些机器,在 playbooks 中,意味着哪些主机需要应用特定的配置或者过程
1、命令格式(下一章介绍 Ansible 的命令具体使用):
1.ansible <pattern_goes_here> -m <module_name> -a <arguments>
比如我们的主机列表配置为:
1.192.168.0.6
2.[webservers]
3.192.168.0.4
4.[db]
5.192.168.0.5
1.ansiblewebservers-mservice-a"name=httpdstate=restarted"
模式通常用主机组来表示,上面的命令就代表 webservers 组的所有主机
2、其他的匹配方式:
1.all
2.*
1.one.example.com
2.one.example.com:two.example.com
3.192.168.1.50
4.192.168.1.*
下面的模式,用来知道一个地址或多个组。组名之间通过冒号隔开,表示“OR”的意思,意思是这 两个组中的所有主机
1.webservers
2.webservers:dbservers
1.webservers:!phoenix
1.webservers:&staging
1.webservers:dbservers:&staging:!phoenix
1.webservers:!{{excluded}}:&{{required}}
你完全不需要使用这些严格的模式去定义组来管理你的机器,主机名,IP,组都可以使用通配符去匹配
1.*.example.com
2.*.com
3.one*.com:dbservers
1.webservers1[0] 表示匹配 webservers1 组的第 1个主机
2.webservers1[0:25] 表示匹配 webservers1 组的第 1 个到第 25 个主机(官网文档是”:”表示范围,测试发现应该使用”-”,注意不要和匹配多个主机组混淆)
~
”,表示这是一个正则表达式1.~(web|db).*\.example\.com
1.ansible-playbook site.yml --limit datacenter2
1.ansible-playbook site.yml --limit @retry_hosts.txt
以下是如何使用/usr/bin/ansible
运行一些临时任务的例子,比如关机、重启服务等并不需要写剧本playbooks,这时使用 ansible 的一行命令或者程序就能方便解决,对于配置管理及应用部署使用 playbooks将是很好的选择:
1、并行性和 shell 命令
1.ansible atlanta-a "/sbin/reboot" -f 10
1.ansible atlanta-a "/usr/bin/foo" -u geekwolf
1.ansible atlanta-a "/usr/bin/foo" -u geekwolf --sudo [--ask-sudo-pass]
1.ansible atlanta-a "/usr/bin/foo" -u username -U otheruser [--ask-sudo-pass]
默认情况下,ansible 使用的
module
是command
,这个模块并不支持 shell 变量和管道等,若想使用shell 来执行模块,请使用-m
参数指定 shell 模块
1.ansible raleigh -m shell-a 'echo $TERM'
2、传输文件
1.ansible atlanta-m copy -a "src=/etc/hosts dest=/tmp/hosts"
1.ansible webservers -m file -a "dest=/srv/foo/a.txt mode=600"
2.ansible webservers -m file -a "dest=/srv/foo/b.txt mode=600 owner=mdehaan group=mdehaan"
1.ansible webservers -m file -a "dest=/path/to/c mode=755 owner=mdehaan group=mdehaan state=directory"
1.ansible webservers -m file -a "dest=/path/to/c state=absent"
3、管理软件包
apt、yum 模块分表用于管理 Ubuntu系列和 RedHat 系列系统软件包
1.ansible webservers -m apt -a "name=acme state=present"
1.ansible webservers -m apt -a "name=acme-1.5 state=present"
1.ansible webservers -m apt -a "name=acme state=latest"
1.ansible webservers -m apt -a "name=acme state=absent"
参数 | 说明 |
---|---|
present | 存在, |
latest | 最新 |
absent | 不存在 |
注释:Ansible 支持很多操作系统的软件包管理,使用时 -m 指定相应的软件包管理工具模块,如果没有这样的模块,可以自己定义类似的模块或者使用 command 模块来安装软件包
4、用户和用户组
使用 user 模块对于创建新用户和更改、删除已存在用户非常方便
1.ansible all -m user -a "name=foo password=<crypted password here>"
2.ansible all -m user -a "name=foo state=absent"
生成加密密码方法
1.1.mkpasswd --method=SHA-512
2.2.pip install passlib
3.python -c "from passlib.hash import sha512_crypt; import getpass; print
4.sha512_crypt.encrypt(getpass.getpass())"
其他的模块参数请参考
http://docs.ansible.com/user_module.html#examples
http://docs.ansible.com/modules_by_category.html
5、源码部署
Ansible 模块能够通知变更,当代码更新时,可以告诉 Ansible 做一些特定的任务,比如从 git 部署代码然后重启 apache 服务等
1.ansible webserver2 -mgit -a "repo=https://github.com/Icinga/icinga2.git dest=/tmp/myappversion=HEAD"
6、服务管理
1.ansible webservers -m service -a "name=httpd state=started"
1.ansible webservers -m service -a "name=httpd state=restarted"
1.ansible webservers -m service -a "name=httpd state=stopped"
7、后台运行
长时间运行的操作可以放到后台执行,ansible 会检查任务的状态;在主机上执行的同一个任务会分配同一个 job ID
1.ansible all-B3600 -a "/usr/bin/long_running_operation --do-stuff"
1.ansible all-masync_status -a "jid=123456789"
1.ansible all-B1800 -P 60 -a "/usr/bin/long_running_operation --do-stuff"
8、搜集系统信息
Facts 在 playbooks 一章中会有详细的描述,这里只通过命令获取所有的系统信息
1.ansible all -m setup
1.ansible all -m setup --tree /tmp/facts
1.ansible all -m setup -a 'filter=ansible_*_mb'
1.ansible all -m setup -a 'filter=ansible_eth[0-2]'
详细使用参考
http://docs.ansible.com/setup_module.html
http://docs.ansible.com/playbooks_variables.html
五、Ansible 配置参数
六、Ansible 对 Windows 的支持
1、管理 Windows 测试
从上面的学习中知道 Ansible 管理 Linux主机是通过 SSH 方式,从 Ansible1.7 版本开始,开始支持对 Windows 系统的管理,使用 powershell 进行远程连接;前提是需要在 Ansible 控制端安装
winrm
的 Python 模块和远程主机通信
1.pip install http://github.com/diyan/pywinrm/archive/master.zip#egg=pywinrm
2.vim/etc/ansible/hosts
3.[win2]
4.192.168.0.8
5.vim/etc/ansible/group_vars/win2.yml
6.# it is suggested that these be encrypted with ansible-vault:
7.# ansible-vault edit group_vars/windows.yml
8.ansible_ssh_user: Administrator
9.ansible_ssh_pass: 3KRxuSezVdx5
10.ansible_ssh_port: 5986
11.ansible_connection: winrm
注意:如果是使用 git 方式获取安装,需要更改 ansible 的模块路径参数
1.vim/etc/ansible/ansible.cfg
2.library = /root/ansible/lib/ansible/modules
默认路径是/usr/share/ansible
Windows server 2012 R2:
确保系统 powershell 版本在 3.0 以上(以管理员身份运行 powershell,执行脚本 upgrade_to_ps3.ps1升级 powershell2.0到 powershell3.0;版本号可以通过在 powershell 中执行$host.version 命令查看)
https://github.com/cchurch/ansible/blob/devel/examples/scripts/upgrade_to_ps3.ps1
运行 powershell 脚本自动配置 WinRM
https://github.com/ansible/ansible/blob/devel/examples/scripts/ConfigureRemotingForAnsible.ps1
注意:
1.get-executionpolicy
2.set-executionpolicy remotesigned
问题 1 :
1.root@instance-jb53h7st:~# ansible win -m win_ping
2.192.168.0.7| FAILED=>Traceback (most recent call last):
3.File "/usr/local/lib/pythson2.7/dist-packages/ansible-1.8-
4.py2.7.egg/ansible/runner/__init__.py",line 588, in _executor
5.exec_rc= self._executor_internal(host, new_stdin)
6.File "/usr/local/lib/python2.7/dist-packages/ansible-1.8-
7.py2.7.egg/ansible/runner/__init__.py",line 767, in _executor_internal
8.return self._executor_internal_inner(host, self.module_name, self.module_args,
9.inject, port, complex_args=complex_args)
10.File "/usr/local/lib/python2.7/dist-packages/ansible-1.8-
11.py2.7.egg/ansible/runner/__init__.py",line 930, in _executor_internal_inner
12.conn= self.connector.connect(actual_host, actual_port,actual_user, actual_pass,
13.actual_transport,actual_private_key_file)
14.File "/usr/local/lib/python2.7/dist-packages/ansible-1.8-
15.py2.7.egg/ansible/runner/connection.py", line 51, in connect
16.self.active =conn.connect()
17.File "/usr/local/lib/python2.7/dist-packages/ansible-1.8-
18.py2.7.egg/ansible/runner/connection_plugins/winrm.py", line132, in connect
19.self.protocol= self._winrm_connect()
20.File "/usr/local/lib/python2.7/dist-packages/ansible-1.8-
21.py2.7.egg/ansible/runner/connection_plugins/winrm.py", line86, in _winrm_connect
22.protocol.send_message('')
23.File "/usr/local/lib/python2.7/dist-packages/winrm/protocol.py", line190, in
24.send_message
25.return self.transport.send_message(message)
26.File "/usr/local/lib/python2.7/dist-packages/winrm/transport.py", line 82, in
27.send_message
28.response =urlopen(request, timeout=self.timeout)
29.File "/usr/lib/python2.7/urllib2.py", line127, in urlopen
30.return _opener.open(url, data, timeout)
31.File "/usr/lib/python2.7/urllib2.py", line404, in open
32.response =self._open(req, data)
33.File "/usr/lib/python2.7/urllib2.py", line422, in _open
34.'_open', req)
35.File "/usr/lib/python2.7/urllib2.py", line382, in _call_chain
36.result = func(*args)
37.File "/usr/lib/python2.7/urllib2.py", line1222,inhttps_open
38.return self.do_open(httplib.HTTPSConnection, req)
39.File "/usr/lib/python2.7/urllib2.py", line1187,indo_open
40.r= h.getresponse(buffering=True)
41.File "/usr/lib/python2.7/httplib.py", line1045,ingetresponse
42.response.begin()
43.File "/usr/lib/python2.7/httplib.py", line409, in begin
44.version, status,reason =self._read_status()
45.File "/usr/lib/python2.7/httplib.py", line365, in _read_status
46.line= self.fp.readline(_MAXLINE +1)
47.File "/usr/lib/python2.7/socket.py",line 476, in readline
48.data= self._sock.recv(self._rbufsize)
49.Ansible中文手册 -By Geekwolf http://www.simlinux.com
50.16
51.File "/usr/lib/python2.7/ssl.py",line 341, in recv
52.return self.read(buflen)
53.File "/usr/lib/python2.7/ssl.py",line 260, in read
54.return self._sslobj.read(len)
55.SSLError: [Errno 1] _ssl.c:1429:error:14094438:SSL routines:SSL3_READ_BYTES:tlsv1
56.alertinternalerror
答案:
1.确保 windows被控端使用了 powershell3.0+以上,并且 winrm 服务正确配置:
1.winrm enumerate winrm/config/listener
1.winrm quickconfig
1.winrm e winrm/config/listener
1.Enable-PSRemoting 进行配置,
2.Test-Wsman -Computername Geekwolf-PC 检查是否正常
2.Ansible 使用pywinrm 模块通过 HTTPS 的方式和被控端通信
请确保 ansible_ssh_port:5986 的端口是 https:5986 而不是 windows 的远程端口 3389
2、支持 Windows 的模块
Ansible 支持的 windows 模块列表:
http://docs.ansible.com/list_of_windows_modules.html
模块 | 说明 |
---|---|
win_feature | 安装和卸载功能 |
win_get_url | 从给定的 url 下载文件 |
win_group | 添加和删除本地组 |
win_msi | 安装和卸载 MSI 文件 |
win_ping | windows 版本的ping 模块 |
win_service | 管理 windows 服务 |
win_stat | 返回关于windows 文件的信息 |
win_user | 管理本地账号 |
注释:slurp、raw、setup、script、fetch 模块同样支持windows
例子:
1.root@instance-jb53h7st:~# ansible win2 -m win_user -a "name=bob password=Password12345"
2.192.168.0.8| success >> {
3."changed":true,
4."user_fullname": [
5."bob"
6.],
7."user_name":[
8."bob"
9.],
10."user_path": "WinNT://WORKGROUP/INSTANCE-MPSQMM/bob"
11.192.168.0.8 | success>> {
12."ansible_facts": {
13."ansible_distribution": "Microsoft Windows NT 6.3.9600.0",
14."ansible_distribution_version": "6.3.9600.0",
15."ansible_fqdn":"instance-mpsqmm",
16."ansible_hostname": "INSTANCE-MPSQMM",
17."ansible_interfaces": [
18.{
19."default_gateway": "192.168.0.1",
20."dns_domain": "dhcp_domain",
21."interface_index": 12,
22."interface_name": "Red Hat VirtIO Ethernet Adapter"
23.}
24.],
25."ansible_ip_addresses": [
26."192.168.0.8",
27."fe80::297b:cc63:8b05:5bab"
28.],
29."ansible_os_family": "Windows",
30."ansible_powershell_version":4,
31."ansible_system": "Win32NT",
32."ansible_totalmem": 2147483648,
33."ansible_winrm_certificate_expires": "2015-11-18 18:53:26"
34.},
35."changed": false
36.}
注释:针对 windows 系统的管理我们可能不需要使用 Ansible 提供的甚至自己编写相关的模块(后续会专门讲模块的编写),通常使用 Ansible 的 script 模块来运行 powershell 脚本来解决问题,这对于 windows 管理员更为熟悉:
1.- hosts: windows
2.tasks:
3.- script: foo.ps1 --argument --other-argument
1.- name: test script module
2.hosts: windows
3.tasks:
4.- name: run test script
5.script: files/test_script.ps1
1.- name: test raw module
2.hosts: windows
3.tasks:
4.- name: run ipconfig
5.raw: ipconfig
6.register: ipconfig
7.- debug: var=ipconfig
1.- name: test stat module
2.hosts: windows
3.tasks:
4.- name: test stat module on file
5.win_stat: path="C:/Windows/win.ini"
6.register: stat_file
7.- debug: var=stat_file
8.- name: check stat_file result
9.assert:
10.that:
11.- "stat_file.stat.exists"
12.- "not stat_file.stat.isdir"
13.- "stat_file.stat.size> 0"
14.- "stat_file.stat.md5"
七、Playbooks 详解
Playbooks
是 Ansible 管理配置、部署应用和编排的语言,可以使用 Playbooks 来描述你想在远程主机执行的策略或者执行的一组步骤过程等
如果说 Ansible 模块是工作中的工具的话,那么 playbooks 就是方案; 推荐阅读 ansible-examples 实例
Playbooks 采用YMAL 语法结构
,参考:基本的 YMAL 语法
1、Playbooks 组成
组成 | 说明 |
---|---|
Target section | 定义将要执行 playbook 的远程主机组 |
Variable section | 定义 playbook 运行时需要使用的变量 |
Task section | 定义将要在远程主机上执行的任务列表 |
Handler section | 定义 task 执行完成以后需要调用的任务 |
看下面的例子:
1.---
2.- hosts: webservers
3.vars:
4.http_port: 80
5.max_clients: 200
6.remote_user: root
7.tasks:
8.- name: ensure apache is at the latest version
9.yum: pkg=httpd state=latest
10.- name: write the apache config file
11.template: src=/srv/httpd.j2 dest=/etc/httpd.conf
12.notify:
13.- restart apache
14.- name: ensure apache is running
15.service: name=httpd state=started
16.handlers:
17.- name: restart apache
18.service: name=httpd state=restarted
2、主机和用户
在 playbook 中的每一个 play 都可以选择在哪些机器和以什么用户身份完成,
hosts 一行可以是一个主机组或者也可以是多个,
中间以冒号分隔,可以参考前面讲的通配模式:remote_user
1.---
2.- hosts: webservers
3.remote_user: root
1.---
2.- hosts: webservers
3.remote_user: root
4.tasks:
5.- name: test connection
6.ping:
7.remote_user: yourname
1.---
2.- hosts: webservers
3.remote_user: yourname
4.sudo: yes
1.---
2.- hosts: webservers
3.remote_user: yourname
4.tasks:
5.- service: name=nginx state=started
6.sudo: yes
1.---
2.- hosts: webservers
3.remote_user: yourname
4.sudo: yes
5.sudo_user: postgres
注释:在使用 sudo_user 切换到非 root 用户时,Ansible 会将模块参数(非密码选项参数)记录到/tmp 下的一个临时随机文件,命令执行完后会删除;当 sudo 到 root 或者普通用户登陆时并不记录
3、任务列表
每个任务建议定义一个可读性较强的名字即 name
,在执行 playbook 时会输出,tasks 的声明格式,在旧版本使用”action:module options”,建议使用”module:options”的格式
service: key=value
参数,请参看模块的详细介绍1.tasks:
2.- name: make sure apache is running
3.service: name=httpd state=running
1.tasks:
2.- name: disable selinux
3.command: /sbin/setenforce 0
1.tasks:
2.- name: run this command and ignore the result
3.shell: /usr/bin/somecommand ||/bin/true
或者
1.tasks:
2.- name: run this command and ignore the result
3.shell: /usr/bin/somecommand
4.ignore_errors: True
回车使用空格缩进
1.---
2.- hosts: server
3.tasks:
4.- name: Copy ansible inventory file to client
5.copy: src=/etc/ansible/hosts dest=/tmp/hosts
6.owner=root group=root mode=0644
4、变量的使用
1. 如何创建一个有效的变量名
变量名应该由字母、数组和下划线组成,以字母开头
例如:foo_port、foo5 就是很好的变量名,而 foo-port、foo port、foo.port、12 都是无效的变量名
2. 在 inventory 中定义变量
第四章已经讲过关于主机清单中的变量如何定义的内容,请参看第四章
3.在playbook 中如何定义变量
1.- hosts: webservers
2.vars:
3.http_port: 80
4. 从角色和文件包含中定义变量
参考下面:角色和包含
5. 如何使用变量:Jinja2
Jinja2
是一个被广泛使用的全功能的 Python 模板引擎
, 它有完整的unicode 支持,一个可选的集成沙箱的执行环境,支持 BSD 许可
举一个简单的模板例子
1.My amp goes to {{ max_amp_value }}
或者在 playbook 中使用
1.template: src=foo.cfg.j2 dest={{ remote_install_path }}/foo.cfg
在模板中可以获得一个主机的所有变量,实际上也可以获取其他主机的变量
注释:Ansible 允许在模板中使用循环和条件判断,但是在 playbook 只使用纯粹的 YAML 语法
6.Jinja2 过滤器
变量可以通过 过滤器修改。过滤器与变量用管道符号( | )分割,并且也 可以用圆括号传递可选参数。多个过滤器可以链式调用,前一个过滤器的输出会被作为 后一个过滤器的输入。
例如{{ name|striptags|title }}
会移除 name 中的所有 HTML 标签并且改写 为标题样式的大小写格式。过滤器接受带圆括号的参数,如同函数调用。这个例子会 把一个列表用逗号连接起来: {{ list|join(', ') }}
Jinja2 Filters 在 Ansible 中并不常用,详细可以参考 Jinja2 官网关于 Filters 的讲解
http://docs.jinkan.org/docs/jinja2/templates.html#builtin-filters
下面列举一些在 Ansible 使用较多的 Filters
格式化数据:
1.{{ansible_devices | join('| ') }}
过滤器和条件一起使用:
1.tasks:
2.- shell: /usr/bin/foo
3.register: foo_result
4.ignore_errors: True
5.- debug: msg="it failed"
6.when: foo_result|failed
7.# in most cases you'll want a handler,but if you want to do something right now, this is nice
8.- debug: msg="it changed"
9.when: foo_result|changed
10.- debug: msg="it succeeded"
11.when: foo_result|success
12.- debug: msg="it was skipped"
13.when: foo_result|skipped
注释:register 关键字的作用是将命令执行的结果保存为变量,结果会因为模块不同而不同,在运行 ansible-playbook 时增加-v 参数可以看到 results 可能的值;注册变量就如同通过 setup 模块获取facts 一样
比如当注册变量 foo_result
1.- hosts: web_servers
2.tasks:
3.- shell: /usr/bin/foo
4.register: foo_result
5.ignore_errors: True
6.- shell: /usr/bin/bar
7.when: foo_result.rc ==5
1.root@instance-jb53h7st:~/geekwolf# ansible-playbook t1.yml -v
2.PLAY [192.168.0.4] ************************************************************
3.GATHERING FACTS ***************************************************************
4.ok: [192.168.0.4]
5.TASK: [shell /bin/echso test] *************************************************
6.failed: [192.168.0.4] => {"changed":true, "cmd": "/bin/echso test", "delta": "0:00:00.004034","end":
7."2014-11-28 10:27:37.214545", "rc": 127, "start": "2014-11-28 10:27:37.210511", "warnings": []}
8.stderr: /bin/sh: 1: /bin/echso: not found
9....ignoring
10.TASK: [test] ******************************************************************
11.changed: [192.168.0.4] => {"changed": true, "checksum":
12."28cc27b7ed8d908fce31134ce21cfe903707e637", "dest": "/tmp/p.txt", "gid": 0, "group": "root", "md5sum":
13."e72feb3cab584b809fb751f95f4a9555", "mode": "0644", "owner": "root", "size": 31, "src":
14."/root/.ansible/tmp/ansible-tmp-1417141657.23-249511894486070/source", "state": "file", "uid": 0}
15.TASK: [debug msg="it failed"] *************************************************
16.ok: [192.168.0.4] => {
17."msg": "it failed"
18.}
19.TASK: [debug msg="it changed"] ************************************************
20.ok: [192.168.0.4] => {
21."msg": "it changed"
22.}
23.TASK: [debug msg="it succeeded"] **********************************************
24.skipping: [192.168.0.4]
25.TASK: [debug msg="it was skipped"] ********************************************
26.skipping: [192.168.0.4]
27.PLAY RECAP ********************************************************************
28.192.168.0.4 : ok=5 changed=2 unreachable=0 failed=0
通过上面两个例子我们可以看到 task 的执行输出是和 facts一样的,我们可以通过 Jinja2 模板获取变量值:
1.{{foo_result.cmd }}
2.{{foo_result.delta }}
或者在 task 中直接使用变量
1.foo_result.rc == 127
在 Jinja2 中使用未定义的变量:
1.{{result.cmd|default(5) }}
如果 result.cmd 变量未定义,默认返回值 5 或者其他数字字符串 default(‘hello world!’),而在执行该task 时不会抛错出来
使用 defalut(omit)自动忽略变量和模块参数:
1.root@instance-jb53h7st:~/geekwolf# cat t.yml
2.---
3.- hosts: 192.168.0.4
4.remote_user: root
5.tasks:
6.- name: touch files with an optional mode
7.file: dest={{item.path}} state=touch mode={{item.mode|default(omit)}}
8.with_items:
9.- path: /tmp/foo
10.- path: /tmp/bar
11.- path: /tmp/baz
12.mode: "0433
13.root@instance-jb53h7st:~/geekwolf# ansible-playbook t.yml -v
14.PLAY [192.168.0.4] ************************************************************
15.GATHERING FACTS ***************************************************************
16.ok: [192.168.0.4]
17.TASK: [touch files] ***********************************************************
18.changed: [192.168.0.4] => (item={'path': '/tmp/foo'}) => {"changed": true, "dest": "/tmp/foo", "gid": 0,
19."group": "root","item": {"path": "/tmp/foo"}, "mode": "0644", "owner": "root", "size": 0, "state": "file",
20."uid": 0}
21.changed: [192.168.0.4] => (item={'path': '/tmp/bar'}) => {"changed": true, "dest": "/tmp/bar", "gid": 0,
22."group": "root","item": {"path": "/tmp/bar"}, "mode": "0644", "owner": "root","size": 0,"state": "file",
23."uid": 0}
24.changed: [192.168.0.4] => (item={'path': '/tmp/baz', 'mode': '0433'}) => {"changed": true, "dest":
25."/tmp/baz", "gid": 0, "group": "root", "item": {"mode":"0433", "path": "/tmp/baz"}, "mode": "0433",
26."owner": "root", "size": 0, "state": "file","uid": 0}
27.PLAY RECAP ********************************************************************
28.192.168.0.4 : ok=2 changed=1 unreachable=0 failed=0
上面的例子执行过程只有最后一个文件/tmp/baz 的权限是 444,其他两个文件为系统默认权限,在执行过程中前两个文件并没有设置 mode 变量,default(omit)会自动忽略,从而执行过程中不抛错;
不增加 default(omit)过滤的结果:
1.root@instance-jb53h7st:~/geekwolf# cat t.yml
2.---
3.- hosts: 192.168.0.4
4.remote_user: root
5.tasks:
6.- name: touch files with an optional mode
7.file: dest={{item.path}} state=touch mode={{item.mode}}
8.with_items:
9.- path: /tmp/foo
10.- path: /tmp/bar
11.- path: /tmp/baz
12.mode: "0444
13.root@instance-jb53h7st:~/geekwolf# ansible-playbook t.yml -v
14.PLAY [192.168.0.4] ************************************************************
15.GATHERING FACTS ***************************************************************
16.ok: [192.168.0.4]
17.TASK: [touch files] ***********************************************************
18.fatal: [192.168.0.4] => One or more undefinedvariables: 'dict object' has no attribute 'mode'
19.FATAL: all hosts have already failed -- aborting
20.PLAY RECAP ********************************************************************
21.to retry, use: --limit @/root/t.retry
22.192.168.0.4 : ok=1 changed=0 unreachable=1 failed=0
列表过滤:
1.root@instance-jb53h7st:~/geekwolf# cat t.yml
2.---
3.- hosts: 192.168.0.4
4.remote_user: root
5.vars:
6.- test: [1,2,3,4,5]
7.tasks:
8.- name: vars
9.template: src=p.j2 dest=/tmp/p.txt
10.root@instance-jb53h7st:~/geekwolf# cat p.j2
11.{{test|min}}
12.root@instance-jb53h7st:~/geekwolf# cat /tmp/p.txt
13.1
1.---
2.- hosts: 192.168.0.4
3.remote_user: root
4.vars:
5.- test: [3, 4, 2]
6.tasks:
7.- name: vars
8.template: src=p.j2 dest=/tmp/{{test|max}}
数据集过滤:
1.{{[1,2,1,2,4] | unique}}
输出结果为:[1,2,4]
1.{{[1,2,4,2,5] | union([2,5,33,2])}}
输出结果为:[1,2,4,5,33]
1.{{[1,2,4,2,5] | intersect([2,5,33,2])}}
输出结果为:[2,5]
1.{{[1,2,4,2,5] | difference([2,5,33,2])}}
输出结果为:[1,4]
1.{{[1,2,4,2,5] | symmetric_difference([2,5,33,2])}}
输出结果为:[1,4,33]
version_compare
比较版本1.{{ansible_distribution_version | version_compare('12.04', '>=') }}
如果系统版本大于等于 12.04,那么返回 True,否则 False
version_compare
支持以下操作符:
<, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=, <>, ne
随机数过滤:
1.{{['a','b','c','d','e','f']|random }}
1.{{59 |random}}
1.{{100 |random(step=10) }}
1.{{100 |random(1, 10) }}
2.{{100 |random(start=1, step=10) }}
随机列表过滤:
给已存在的列表随机排序
1.{{['a','b','c']|shuffle }} => ['c','a','b']
2.{{['a','b','c']|shuffle }} => ['b','c','a']
其他有用的过滤器:
1.{{[1,2,4,5,6] | join("-") }}
输出:1-2-4-5-6
1.{{‘/etc/asdf/foo.txt’ | basename }}
输出:foo.txt
1.{{‘/root/geekwolf/t.yml’ |dirname}}
输出:/root/geekwolf
注释:*在使用过程中要注意如果是目录后面一定不要忘记加/,否则会认为是文件
1.{{encoded | b64decode }}
2.{{decoded | b64encode }}
1.{{filename |sha1 }}
1.- debug: msg=test
2.when: some_string_value | bool
match
( 需要一个完整的字符串匹配 )或者 search
( 需要部分匹配的字符串 )来正则匹配字符串1.---
2.- hosts: 192.168.0.4
3.remote_user: root
4.vars:
5.url: "http://simlinux.com/users/foo/resources/bar"
6.tasks:
7.- debug: "msg='matched pattern 1'"
8.when: url | match("http://simlinux.com/users/.*/resources/.*")
9.- debug: "msg='matched pattern 2'"
10.when: url | search("/users/.*/resources/.*")
1.# convert "ansible" to "able"
2.{{'ansible' |regex_replace('^a.*i(.*)$', 'a\\1') }}
3.# convert "foobar" to"bar"
4.{{'foobar' | regex_replace('^f.*o(.*)$', '\\1') }}
7. 变量文件分离
可以将单个主机或者单个主机组等的变量写到独立的小文件里,一定程度上降低了分享 playbook时暴漏敏感信息的风险
示例:
1.---
2.- hosts:all
3.remote_user:root
4.vars:
5.favcolor: blue
6.vars_files:
7.-/vars/external_vars.yml
8.tasks:
9.
10.- name: thisisjust a placeholder
11.command: /bin/echo foo
变量文件就是一个简单的 YAML 格式的字典
1.---
2.# in the above example, this would be vars/external_vars.yml
3.somevar: somevalue
4.password: magic
8. 通过命令行传递变量
通过前面的章节我们了解到可以使用 var_prompt 交互方式及 vars_files 引用变量文件方式传递变量,下面介绍使用命令行如何传递变量:
1.---
2.- hosts: '{{ hosts }}'
3.remote_user: '{{ user }}'
4.tasks:
5.- ...
比如上面的 playbook,我们可以这样传递{{hosts}}、{{user}}变量:
1.ansible-playbook release.yml --extra-vars "hosts=vipers user=starbuck"
在 Ansible1.2 中可以使用 JSON 数据来传递变量
1.--extra-vars '{"pacman":"mrs","ghosts":["inky","pinky","clyde","sue"]}'
在 Ansible1.3 中,可以通过@导入 JSON 文件来传递变量,也可以使用 YMAL 格式以命令行或者@文件的方式导入
1.--extra-vars "@some_file.json"
9. 变量优先级
注释:子组会覆盖父组,主机总是覆盖组定义的变量
10. 变量使用总结
在 playbook 中 action 一行可以使用在 vars 定义的参数
1.cat /etc/ansible/group_vars/server
2.vhost: test
3.vimfile-book.yml
4.---
5.- hosts: server
6.tasks:
7.
8.- name: create a virtual host file for {{ vhost }}
9.template: src=/etc/hosts dest=/tmp/{{ vhost }}
1.vimfile-book.yml
2.---
3.- hosts: server
4.vars:
5.-vhost: test
6.tasks:
7.- name: create a virtual host file for {{ vhost }}
8.template: src=/etc/hosts dest=/tmp/{{ vhost }}
1.vim /root/variables
2.vhost: test
3.vimfile-book.yml
4.---
5.- hosts: server
6.vars_files:
7.- /root/variables
8.tasks:
9.- name: create avirtual host file for {{ vhost}}
10.template: src=/etc/hosts dest=/tmp/{{ vhost }}
1.vimfile-book.yml
2.---
3.- hosts: server
4.vars_prompt:
5.- name: web
6.prompt: 'Please input the web server:'
7.private: no
8.tasks:
9.- name: concent of the file test
10.template: src=/root/test dest=/tmp/test
11.cat /root/test
12.{{web}}
注释:private 设置为 yes 再输入时看不到明文
1.vimfile-book.yml
2.---
3.- hosts: 192.168.0.4
4.tasks:
5.- name: concent of the file test
6.template: src=/root/test dest=/tmp/test
7.cat /root/test
8.{{ansible_devices.vda.size}}
9.{{ansible_mounts[0].device}}
10.{{ansible_eth0["ipv4"]["address"] }}
11.或{{ ansible_eth0.ipv4.address }}
默认 playbook 的 setup 模块式开启的,可以设置 gather_facts:no 关闭
可以通过在远程主机/etc/ansible/facts.d/目录下创建.fact 结尾的文件,也可以是 json、ini 或者返回json 格式数据的可执行文件,这些将被作为远程主机本地的 facts 执行
示例:
1./etc/ansible/facts.d/hello.fact
2.[test]
3.h=hello
4.p=world
5.root@instance-jb53h7st:/etc/ansible/facts.d# ansible 192.168.0.5 -m setup -a "filter=ansible_local"
6.192.168.0.5 | success>> {
7."ansible_facts": {
8."ansible_local": {
9."t": {
10."test": {
11."h": "hello",
12."p": "world"
13.}
14.}
15.}
16.},
17."changed": false
18.}
可以通过{{ ansible_local.preferences.test.h }} 方式来使用该变量
下面是创建使用 local facts 的 playbook示例:
1.- hosts: webservers
2.tasks:
3.- name: create directory for ansible custom facts
4.file: state=directory recurse=yes path=/etc/ansible/facts.d
5.- name: install customimpi fact
6.copy: src=ipmi.fact dest=/etc/ansible/facts.d
7.- name: re-read facts after adding custom fact
8.setup: filter=ansible_local
获取其他主机 facts:
示例:
1.---
2.- hosts: test1.simlinux.com:test2.simlinux.com
3.remote_user: root
4.tasks:
5.- name: get other hosts
6.shell: "echo {{ hostvars['test2.simlinux.com']['ansible_os_family'] }}"
7.when: inventory_hostname == 'test1.simlinux.com'
8.- name: get other hosts
9.template: src=p.j2 dest=/tmp/p.txt
10.when: inventory_hostname == 'test2.simlinux.com'
11.cat p.j2
12.{{hostvars['test1.simlinux.com']['ansible_distribution']}}
也可以使用 Jinja2 的 if 和 for 语句
1.root@instance-jb53h7st:~/geekwolf# cat t.yml
2.---
3.- hosts: server
4.remote_user: root
5.tasks:
6.- name: get other hosts
7.template: src=p.j2 dest=/tmp/p.txt
8.root@instance-jb53h7st:~/geekwolf# cat p.j2
9.{% if 'server' in group_names %}
10.{% for host in groups['server'] %}
11.{{hostvars[host]['ansible_eth0']['ipv4']['address'] }}
12.{% endfor %}
13.{% endif %}
14.{% for host in groups['server'] %}
15.{{hostvars[host]['ansible_product_name'] }}
16.{% endfor %}
注释:模板中,group_names 表示 inventory 中所有的主机组名inventory_hostname 表示配置在 incentory 清单中的主机名,如果有很长的 FQDN,可以使用inventory_hostname_short,inventory_dir 表示主机清单 hosts 文件的所在目录,inventory_file 表示主机清单 hosts 文件绝对路径
play_hosts
delegate_to
5、条件判断与循环
when 条件判断
后面使用 Jinja2表达式
1.tasks:
2.- name: "shutdown Debian flavored systems"
3.command: /sbin/shutdown -t now
4.when: ansible_os_family == "Debian"
若操作系统是 Debian 时就执行关机操作
1.tasks:
2.- command: /bin/false
3.register: result
4.ignore_errors: True
5.- command: /bin/something
6.when: result|failed
7.- command: /bin/something_else
8.when: result|success
9.- command: /bin/still/something_else
10.when: result|skipped
1.tasks:
2.- shell: echo "only on Red Hat 6, derivatives, and later"
3.when: ansible_os_family == "RedHat" and ansible_lsb.major_release|int >=6
1.vars:
2.epic: true
3.tasks:
4.- shell: echo "This certainly is epic!"
5.when: epic
6.tasks:
7.- shell: echo "This certainly isn't epic!"
8.when: not epic
1.tasks:
2.- shell: echo "I've got '{{ foo }}' and amnot afraid to use it!"
3.when: foo is defined
4.- fail: msg="Bailing out. this play requires 'bar'"
5.when: bar is not defined
1.tasks:
2.- command: echo {{ item }}
3.with_items: [ 0, 2, 4, 6, 8, 10 ]
4.when: item > 5
1.tasks:
2.- name: gather site specific fact data
3.action: site_facts
4.- command: /usr/bin/thingy
5.when: my_custom_fact_just_retrieved_from_the_remote_system == '1234'
1.- include: tasks/sometasks.yml
2.when: "'reticulating splines' in output"
3.- hosts: webservers
4.roles:
5.- { role: debian_stock_config, when: ansible_os_family == 'Debian' }
1.---
2.- hosts: all
3.remote_user: root
4.vars_files:
5.- "vars/common.yml"
6.- [ "vars/{{ ansible_os_family }}.yml", "vars/os_defaults.yml" ]
7.tasks:
8.- name: make sure apache is running
9.service: name={{apache }} state=running
10.vars/RedHat.yml
11.apache:httpd
12.vars/Debian
13.apache:apache2
14.如果是 RedHat 系的系统时,会导入 vars/RedHat.yml 文件,然后 vars/os_defaults.yml
1.---
2.- hosts: 192.168.0.4
3.remote_user: root
4.tasks:
5.- name: INTERFACES | Create Ansible header for /etc/network/interfaces
6.template: src={{ item }} dest=/tmp/geekwolf.conf
7.with_first_found:
8.- files:
9.- "{{ansible_distribution }}.conf"
10.- "default.conf"
循 环
with_items
*1.- name: add several users
2.user: name={{ item }} state=presentgroups=wheel
3.with_items:
4.- testuser1
5.- testuser2
也可以通过 vars
选项或者 vars_files
引入变量文件的形式定义使用循环
1.---
2.- hosts: 192.168.0.4
3.remote_user: root
4.# vars_files:
5.# - somelist.yml
6.vars:
7.- somelist: [1,2,3,4,5,6]
8.tasks:
9.- name: lists
10.command: echo {{ item }}
11.with_items: somelist
同样我们在使用 yum 或者 apt 安装多个软件包时也可以使用 with_items
如果是散列的列表
可以这样使用:
1.- name: add several users
2.user: name={{ item.name }} state=present groups={{ item.groups }}
3.with_items:
4.- { name:'testuser1', groups: 'wheel' }
5.- { name:'testuser2', groups: 'root' }
with_nested
将多个库授权给多个用户 select 权限
,参考:mysql_user 模块的使用方法
1.---
2.- hosts: 192.168.0.4
3.remote_user: root
4.tasks:
5.- name: give users select tomultiple databases
6.mysql_user: name={{ item[0] }} priv={{ item[1] }}.*:select append_privs=yes password=foo
7.with_nested:
8.- [ 'alice' , 'bob' ]
9.- [ 'test' , 'test1' ]
或者可以通过引用之前定义的变量文件形式使用:
1.- hosts: 192.168.0.4
2.remote_user: root
3.vars_files:
4.- “users.yml”
5.tasks:
6.- name: give users select to multiple databases
7.mysql_user: name={{ item[0] }} priv={{ item[1] }}.*:select append_privs=yespassword=foo
8.with_nested:
9.- users
10.- [ 'test' , 'test1' ]
with_dict
1.vimusers.yml
2.---
3.users:
4.alice:
5.name: Alice
6.telephone: 123-456-7890
7.bob:
8.name: Bob
9.telephone: 987-654-3210
10.vimdict_playbook.yml
11.---
12.- hosts: 192.168.0.4
13.remote_user: root
14.vars_files:
15.- users.yml
16.tasks:
17.- name: print name and telephone
18.debug: msg="User {{ item.key }} is{{ item.value.name }}({{ item.value.telephone }})"
19.with_dict:users
with_fileglob
遍历文件(不递归、对目录无效)with_fileglob将/root/geekwolf/目录下所有的文件复制到/tmp/fooapp/
1.---
2.- hosts: 192.168.0.4
3.remote_user: root
4.tasks:
5.#确保目的目录存在
6.- file: dest=/tmp/fooapp state=directory
7.- copy: src={{ item }} dest=/tmp/fooapp/ owner=root mode=600
8.with_fileglob:
9.- /root/geekwolf/*
with_together
来并行遍历两个列表1.vimlist_test.yml
2.---
3.alpha: [ 'a', 'b', 'c', 'd' ]
4.numbers: [ 1,2, 3, 4 ,5]
假如我们想要[‘a’,1] [‘b’,2] …[None,6]可以这样实现:
1.vimlist_test.yml
2.---
3.alpha: ['a','b','c','d']
4.numbers: [1,2,3,4,5,6]
5.vimlist_playbook.yml
6.---
7.- hosts: 192.168.0.4
8.remote_user: root
9.vars_files:
10.- list_test.yml
11.tasks:
12.- debug: msg="{{ item.0 }} and {{ item.1 }}"
13.with_together:
14.- alpha
15.- numbers
with_subelements
创建用户 alice 和 bob,为 alice 配置两把公钥到 alice 用户下的 authorized_keys 文件,为 bob 配置一把公钥使得两个用户通过客户端私钥登陆,其中 onekey.pub twokey.pub id_rsa.pub 表示已经创建好的公钥
1.vimsubusers.yml
2.---
3.users:
4.- name: alice
5.authorized:
6.- /tmp/alice/onekey.pub
7.- /tmp/alice/twokey.pub
8.- name: bob
9.authorized:
10.- /tmp/bob/id_rsa.pub
11.vimsub_playbook.yml
12.---
13.- hosts: 192.168.0.4
14.vars_files:
15.- subuser.yml
16.tasks:
17.- user: name={{ item.name }} state=presentgenerate_ssh_key=yes
18.with_items: users
19.- authorized_key: "user={{ item.0.name }} key='{{ lookup('file', item.1) }}'"
20.with_subelements:
21.- users
22.- authorized
详细参考:
authorized_key 模块:http://docs.ansible.com/authorized_key_module.html
look_plugins 插件讲解:http://rfyiamcool.blog.51cto.com/1030776/1441451
1.---
2.- hosts: all
3.tasks:
4.#创建用户组
5.- group: name=evens state=present
6.- group: name=odds state=present
7.#创建格式为 testuser%02x 的 0-32 序列的用户
8.- user: name={{ item }} state=present groups=evens
9.with_sequence: start=0end=32 format=testuser%02x
10.#创建目录:起始位 4,末尾是 16,步长为 2 命名的目录
11.- file: dest=/var/stuff/{{ item}}state=directory
12.with_sequence: start=4end=16 stride=2
13.#简单实用序列的方法:创建 4 个用户组分表是组 group1 group2 group3 group4
14.# create 4 groups
15.- group: name=group{{ item }} state=present
16.with_sequence: count=4
with_random_choice
1.- debug: msg={{ item }}
2.with_random_choice:
3.- "go throughthe door"
4.- "drink from the goblet"
5.- "press the red button"
6.- "do nothing"
until
循环 until1.- action: shell /usr/bin/foo
2.register: result
3.until: result.stdout.find("all systems go") != -1
4.retries: 5
5.delay: 10
上面的例子 shell 模块会一直执行直到模块结果输出有”all systemsgo” 或者每个 10s 重试 5 次后结束;默认是每个 5s 重复 3 次;执行 playbook 时加上-vv 参数可以查看详细过程
with_first_found
1.- name: INTERFACES | Create Ansible header for /etc/network/interfaces
2.template: src={{ item }} dest=/etc/foo.conf
3.with_first_found:
4.- "{{ansible_virtualization_type}}_foo.conf"
5.- "default_foo.conf"
配置匹配文件搜索路径:
1.- name: some configuration template
2.template: src={{ item }} dest=/etc/file.cfg mode=0444 owner=root group=root
3.with_first_found:
4.- files:
5.- "{{inventory_hostname}}/etc/file.cfg"
6.paths:
7.- ../../../templates.overwrites
8.- ../../../templates
9.- files:
10.- etc/file.cfg
11.paths:
12.- templates
1.---
2.- hosts: 192.168.0.4
3.tasks:
4.- name: indexed loop demo
5.debug: msg="at array position {{ item.0 }} there is a value {{ item.1 }}"
6.with_indexed_items: ['a','b','c','d','e']
7.{{item.0}}表示列表索引,{{item.1}}表示列表对象
with_flattened
如果定义了多个列表,遍历多个列表项
1.----
2.# file: roles/foo/vars/main.yml
3.packages_base:
4.- [ 'foo-package', 'bar-package' ]
5.packages_apps:
6.- [ ['one-package', 'two-package' ]]
7.- [ ['red-package'], ['blue-package']]
8.- name: flattened loop demo
9.yum:name={{ item }} state=installed
10.with_flattened:
11.- packages_base
12.- packages_apps
6、Notify 和 和 Handlers
在 playbook 中,notify 行为在每个任务执行的最后会被触发调用 handlers,并且即使 notify 多个任务也只是被触发一次;handlers 是任务列表和普通任务没有区别,通过 notify 触发使用 name 来引用;在一个 play 里面无论对一个handlers 通知调用多少次,都只是在所有任务执行完后执行一次;
例子:当文件发生变化时重启 memcache 和 apache
1.- name: template configurationfile
2.template: src=template.j2 dest=/etc/foo.conf
3.notify:
4.- restart memcached
5.- restart apache
6.
7.handlers:
8.- name: restart memcached
9.service: name=memcached state=restarted
10.- name: restart apache
11.service: name=apache state=restarted
使用 playbooks 来配置 memcached 示例:
1.vimmemcache.yml
2.---
3.- hosts: server
4.remote_user: root
5.tasks:
6.- name: install memcached
7.apt: name=memcached state=installed
8.- name: set memcached size
9.set_fact: memcached_size={{ ansible_memtotal_mb/2 }}
10.- name: copy configureations ansible_memtotal_mb/2
11.template: src=memcached.j2 dest=/etc/memcached.conf
12.notify:
13.- restart memcached
14.- name: ensure memcached is running
15.service: name=memcached state=started
16.handlers:
17.- name: restart memcached
18.service: name=memcached state=restarted
19.vimmemcached.j2
20.-p 11311
21.-l 0.0.0.0
22.-m {{memcached_size}}
23.-c 10240
24.-u memcache
25.-d
文件发生变化时才会通知调用 handlers,在配置文件没变化,memcached 没有启动时这时候就需要确保服务正常启动,在 notify 后面使用 service 模块启动服务
注释:可以使用 gather_facts:no 关闭 setup 模块的执行,默认是 yes
7、角色和包含
任务包含文件并且复用
比如:
1.tasks/foo.yml
2.---
3.# possibly saved as tasks/foo.yml
4.- name: placeholder foo
5.command: /bin/foo
6.- name: placeholder bar
7.command: /bin/bar
可以在 playbook 中使用 include 包含 foo.yml
1.tasks:
2.- include: tasks/foo.yml
include 可以带变量,wp_user 需要在 wordpress.yml 定义{{ wp_user}}
1.tasks:
2.- include: wordpress.yml wp_user=timmy
3.- include: wordpress.yml wp_user=alice
4.- include: wordpress.yml wp_user=bob
Ansible1.4+版本还支持列表和字典
1.tasks:
2.- { include: wordpress.yml,wp_user: timmy, ssh_keys: [ 'keys/one.txt', 'keys/two.txt' ] }
Ansible1.0+开始,变量可以通过 include 文件来使用,也可以通过结构化变量来使用
1.tasks:
2.- include: wordpress.yml
3.vars:
4.wp_user: timmy
5.some_list_variable:
6.- alpha
7.- beta
8.- gamma
include 在 handlers 中的使用
1.---
2.# this might be in a file like handlers/handlers.yml
3.- name: restart apache
4.service: name=apache state=restarted
5.handlers:
6.- include: handlers/handlers.yml
一个 playbook 可以 include 另外一个 playbook
1.- name: this is a play at the top level of afile
2.hosts: all
3.remote_user: root
4.tasks:
5.- name: say hi
6.tags: foo
7.shell: echo "hi..."
8.- include: load_balancers.yml
9.- include: webservers.yml
10.- include: dbservers.yml
角色
Roles 在 Ansible1.2+版本中支持,是为了更好的组织 playbooks
举例说明:
site.yml
webservers.yml
fooservers.yml
roles/
common/
files/
templates/
tasks/
handlers/
vars/
defaults/
meta/
webservers/
files/
templates/
tasks/
handlers/
vars/
defaults/
meta/
在 playbook 中可以这样使用 roles
1.---
2.- hosts: webservers
3.roles:
4.- common
5.- webservers
roles 目录结构说明:
tasks、handlers、vars(只对当前 role 有效)、meta(定义 role 间的直接依赖关系)目录内存在
main.yml 文件时会将对应的任务、处理、变量和meta 添加到 play
files 存放文件,ansible 默认会从这里找文件,对应 task 里面的 copy、script 模块
template 存放模板,对应 task 里面的 template 模块
tasks 存放任务,include 默认读取这里的任务
defaults 默认的变量存放位置,使用/devaults/main.yml,相对其他参数变量设置的优先级最低
注释:Ansible1.4+以后的版本,可以通过 roles_path 参数配置 roles 路径,多路径使用冒号分隔,可以将常见角色集中存放,指定 roles 路径,这样多个 playbook 可以共用
1.给角色添加参数
1.---
2.- hosts: webservers
3.roles:
4.- common
5.- { role:foo_app_instance, dir: '/opt/a', port: 5000 }
6.- { role:foo_app_instance, dir: '/opt/b', port: 5001 }
2.条件判断是否使用该角色
1.---
2.- hosts: webservers
3.roles:
4.- { role:some_role, when: "ansible_os_family == 'RedHat'" }
3.使用tags 标记分配给指定角色
1.---
2.- hosts: webservers
3.roles:
4.- { role:foo, tags: ["bar", "baz"] }
4.使用pre_tasks 和 post_tasks 分别在 roles 应用的前后执行一些任务
1.---
2.- hosts: webservers
3.pre_tasks:
4.- shell: echo 'hello'
5.roles:
6.- { role:some_role }
7.tasks:
8.- shell: echo 'still busy'
9.post_tasks:
10.- shell: echo 'goodbye'
1.---
2.dependencies:
3.- { role: common,some_parameter: 3 }
4.- { role: apache, port: 80 }
5.- { role: postgres, dbname: blarg, other_parameter: 12}
角色可以指定绝对路径
1.---
2.dependencies:
3.- { role: '/path/to/common/roles/foo', x: 1 }
角色依赖也可以从版本控制库或者 tar 包获得,使用逗号作为分隔符(分隔路径、版本
(tag,commit,branch 等)、可选的角色名字)
1.---
2.dependencies:
3.- { role: 'git+http://git.example.com/repos/role-foo,v1.1,foo'}
4.- { role: '/path/to/tar/file.tgz,,friendly-name' }
角色被作为依赖只能执行一次,如果其他角色也使用同样的依赖将不会被执行,可以通过
meta/main.yml 文件 allow_duplicates:yes 来覆盖解决
比如一个叫 car 的角色的依赖是
1.cat car/meta/main.yml
2.---
3.dependencies:
4.- { role: wheel, n: 1 }
5.- { role: wheel, n: 2 }
6.- { role: wheel, n: 3 }
7.- { role: wheel, n: 4 }
我们在 wheel 角色的 meta/main.yml 文件添加
1.---
2.allow_duplicates: yes
3.dependencies:
4.- { role: tire }
5.- { role: brake }
最终的角色执行过程则是:
1.tire(n=1)
2.brake(n=1)
3.wheel(n=1)
4.tire(n=2)
5.brake(n=2)
6.wheel(n=2)
7....
8.car
简单来讲,在一个 task 里面 A 角色依赖 B, B 依赖 C 和 D,C 依赖 D,那么最后执行的过程如果不在 C 角色的 meta/main.yml 文件增加 allow_duplicates:yes 就不会在执行 D 了
在角色中嵌入模块:
当写了内部模块来帮助配置管理软件和机器,又想让其他人很容易的使用自定义模块的时候可以将模块放在
1.roles/
2.my_custom_modules/
3.library/
4.module1
5.module2
模块可以被 my_custom_modules 角色使用,也可以被在my_custom_modules 之后的角色调用
1.- hosts: webservers
2.roles:
3.- my_custom_modules
4.- some_other_role_using_my_custom_modules
5.- yet_another_role_using_my_custom_modules
8、运行 Playbook
1.ansible-playbook playbook.yml -f 10
查看模块执行成功与否的详细信息
1.ansible-playbook playbook.yml --verbose
查看一个 playbook 中都会对哪些主机产生影响
1.ansible-playbook playbook.yml --list-hosts
查看都有哪些任务要执行
1.ansible-playbook playbook.yml --list-tasks
9、Ansible 工作模式
前面的学习使用都是基于 Ansible 的 push 模式来工作,即不要在远程主机做任何操作只需要在控制机编排 playbook,push 到远程主机即可完成任务,另外一个工作模式就是pull
pull 模式适用场景:
1.被控节点在配置时不可用,比如自动伸缩的服务池
2.被控节点较多,控制机资源有限无法满足高线程和低时间的运行效率
Ansible 基于 pull 模式的工作流程:
1.每台被控端需要安装 Ansible 和 git(svn)
2.所有的配置及 playbooks 都存放在 git 仓库
3.被控端的 ansible-pull 计划任务会定期检查给定的 git 的 tag 或者分支
4.ansible-pull 执行特定的 playbooks 即 local.yml 或者 hostname.yml
5.每次更改 playbooks 只需要提交到 git 即可
现在我们首先使用 push 模式,对被控机做一些设置才能使用 pull 模式:
新系统:Centos6.5 x64IP:192.168.0.2
1、设置被控节点支持pull模式(之后不需要控制机,或者结合 cobbler等来节省这一步)
1.---
2.- hosts: 192.168.0.2
3.user: root
4.vars:
5.# schedule is fed directly to cron
6.schedule: '*/15 * * * *'
7.# User to runansible-pull as from cron
8.cron_user: root
9.# File thatansible will use for logs
10.logfile: /var/log/ansible-pull.log
11.# Directory to where repository will be cloned
12.workdir: /var/lib/ansible/local
13.# Repository to check out -- YOU MUST CHANGE THIS
14.# repo must contain a local.yml file at top level
15.repo_url: https://github.com/geekwolf/ansible-playbooks.git
16.tasks:
17.- name: SetupEPEL
18.action: command rpm -ivh http://mirrors.hustunique.com/epel/6/x86_64/epel-release-6-
19.8.noarch.rpm
20.creates=/etc/yum.repos.d/epel.repo
21.- name: Install ansibleand git
22.action: yum name={{ item }} state=latest enablerepo=epel
23.with_items:
24.- ansible
25.- git
26.- name: Create local directory to work from
27.action: file path={{workdir}} state=directory owner=root group=root mode=0751
28.- name: Copy ansible inventory file to client
29.action: copy src=hosts dest=/etc/ansible/hosts
30.owner=root group=root mode=0644
31.- name: Create crontab entry to clone/pull git repository
32.action: template src=templates/etc_cron.d_ansible-pull.j2 dest=/etc/cron.d/ansible-pull owner=root
33.group=root mode=0644
34.- name: Create logrotate entry for ansible-pull.log
35.action: template src=templates/etc_logrotate.d_ansible-pull.j2 dest=/etc/logrotate.d/ansible-pull
36.owner=root group=root mode=0644
37.- name: ssh keys
38.action: shell/usr/bin/ssh-keygen -t rsa -P '' -f /root/.ssh/id_rsa && cat ~/.ssh/id_rsa.pub
39.>>~/.ssh/authorized_keys && /usr/bin/ssh-keyscan 127.0.0.1 github.com >> ~/.ssh/known_hosts
注释:
上述操作之后被控机将定时同步 git 上的playbooks 然后执行,可以参考
https://github.com/geekwolf/ansible-playbooks.git;ansible-pull 可以使用参数-o 来实现只有 playbooks文件发生变化时才执行
问题:
1.msg: github.com has an unknown hostkey. Set accept_hostkey to True or manually add the hostkey prior to running the git module
答案:
1.sudo ssh-keyscan github.com>> /etc/ssh/ssh_known_hosts
八、Playbooks 高级特性
使用 Redis 做 facts 缓存
这个特性是在 Ansible1.8+中才得到支持,启用 facts 缓存后,一个主机组中的机器可以引用其他主机组中的变量;目前 Ansible 版本是 1.8.1,facts cache 仍处于 beta,并未支持 redis 端口密码等
开启 facts 缓存:
1.vim/etc/ansible/ansible.cfg
2.[defaults]
3.fact_caching = redis
4.fact_caching_timeout = 86400 # seconds
目前支持 facts cache 的唯一缓存引擎是 Redis
1.apt-get install redis-server
2.service redis start
3.pip install redis
待续……
九、实战
待续……
相关帮助
有疑问就读官方文档: http://docs.ansible.com/
Jinja2 中文文档: http://docs.jinkan.org/docs/jinja2/
IRC 交流: https://webchat.freenode.net/ channel : Ansible
Bug 提交: https://github.com/ansible/ansible/issues
使用问题交流 : https://groups.google.com/forum/#!forum/ansible-project
新手推荐学习视频 : http://edu.51cto.com/course/course_id-2220.html