ansible 个人使用习惯笔记
语法检查别名
alias ansible-playbook-check='ansible-playbook --syntax-check'
查看模块帮助,例如查看file模块的帮助文档
ansible-doc file
查看可用模块:自动进入less模块,可/搜索
ansible-doc -l
语法检查别名
alias ansible-playbook-check='ansible-playbook --syntax-check'
查看模块帮助,例如查看file模块的帮助文档
ansible-doc file
查看可用模块:自动进入less模块,可/搜索
ansible-doc -l
playbook中可以写多种循环:
with_list
with_items
with_indexed_items
with_flattened
with_together
with_dict
with_sequence
with_subelements
with_nested / with_cartesian
with_random_choice
列表 with_list
这个例子会分别执行['protected/yiic1', '0755'], ['protected/yiic2', '0766'],['protected/yiic3', '0777']
- name: change files mode
file:
path: '{{ destdir }}/{{ item.0 }}'
mode: '{{ item.1 }}'
with_list:
- ['protected/yiic1', '0755']
- ['protected/yiic2', '0766']
- ['protected/yiic3', '0777']
标准循环(with_items):
注意例2的结果将会分别执行1,2,3,'a','b'
#例1
- name: add several users
user: name={{ item }} state=present groups=wheel
with_items:
- testuser1
- testuser2
#例2
- name: add several users
user: name={{ item }} state=present groups=wheel
with_items:
- [1,2,3]
- ['b','c']
嵌套循环(with_nested / with_cartesian):可以实现 mkdir -p /testdir/testdir/{a,b,c}/{test1,test2} 这样的效果
- file:
state: directory
path: "/testdir/testdir/{{ item.0 }}/{{ item.1 }}"
with_nested:
- [ a, b, c ]
- [ test1, test2 ]
对哈希表使用循环
---
users:
alice:
name: Alice Appleworth
telephone: 123-456-7890
bob:
name: Bob Bananarama
telephone: 987-654-3210
...
tasks:
- name: Print phone records
debug: msg="User {{ item.key }} is {{ item.value.name }} ({{ item.value.telephone }})"
with_dict: "{{users}}"
对文件列表使用循环
---
- hosts: all
tasks:
# first ensure our target directory exists
- file: dest=/etc/fooapp state=directory
# copy each file over that matches the given pattern
- copy: src={{ item }} dest=/etc/fooapp/ owner=root mode=600
with_fileglob:
- /playbooks/files/fooapp/*
对并行数据集使用循环(一个数组对应另一个数组)
---
alpha: [ 'a', 'b', 'c', 'd' ]
numbers: [ 1, 2, 3, 4 ]
#如果你想得到’(a, 1)’和’(b, 2)’之类的集合.可以使用’with_together’:
tasks:
- debug: msg="{{ item.0 }} and {{ item.1 }}"
with_together:
- "{{alpha}}"
- "{{numbers}}"
对子元素使用循环
---
users:
- name: alice
authorized:
- /tmp/alice/onekey.pub
- /tmp/alice/twokey.pub
mysql:
password: mysql-password
hosts:
- "%"
- "127.0.0.1"
- "::1"
- "localhost"
privs:
- "*.*:SELECT"
- "DB1.*:ALL"
- name: bob
authorized:
- /tmp/bob/id_rsa.pub
mysql:
password: other-mysql-password
hosts:
- "db1"
privs:
- "*.*:SELECT"
- "DB2.*:ALL"
#那么可以这样实现:
- user: name={{ item.name }} state=present generate_ssh_key=yes
with_items: "{{users}}"
- authorized_key: "user={{ item.0.name }} key='{{ lookup('file', item.1) }}'"
with_subelements:
- users
- authorized
#根据mysql hosts以及预先给定的privs subkey列表,我们也可以在嵌套的subkey中迭代列表:
- name: Setup MySQL users
mysql_user: name={{ item.0.user }} password={{ item.0.mysql.password }} host={{ item.1 }} priv={{ item.0.mysql.privs | join('/') }}
with_subelements:
- users
- mysql.hosts
对整数序列使用循环
with_sequence 可以以升序数字顺序生成一组序列.你可以指定起始值、终止值,以及一个可选的步长值.
指定参数时也可以使用key=value这种键值对的方式.如果采用这种方式,’format’是一个可打印的字符串.
数字值可以被指定为10进制,16进制(0x3f8)或者八进制(0600).负数则不受支持.请看以下示例:
---
- hosts: all
tasks:
# create groups
- group: name=evens state=present
- group: name=odds state=present
# create some test users
- user: name={{ item }} state=present groups=evens
with_sequence: start=0 end=32 format=testuser%02x
# create a series of directories with even numbers for some reason
- file: dest=/var/stuff/{{ item }} state=directory
with_sequence: start=4 end=16 stride=2
# a simpler way to use the sequence plugin
# create 4 groups
- group: name=group{{ item }} state=present
with_sequence: count=4
随机选择
‘random_choice’功能可以用来随机获取一些值.它并不是负载均衡器(已经有相关的模块了).它有时可以用作一个简化版的负载均衡器,比如作为条件判断:
- debug: msg={{ item }}
with_random_choice:
- "go through the door"
- "drink from the goblet"
- "press the red button"
- "do nothing"
Do-Until循环
有时你想重试一个任务直到达到某个条件.比如下面这个例子:
- action: shell /usr/bin/foo
register: result
until: result.stdout.find("all systems go") != -1
retries: 5
delay: 10
上面的例子递归运行shell模块,直到模块结果中的stdout输出中包含”all systems go”字符串,或者该任务按照10秒的延迟重试超过5次.”retries”和”delay”的默认值分别是3和5.
该任务返回最后一个任务返回的结果.单次重试的结果可以使用-vv选项来查看. 被注册的变量会有一个新的属性’attempts’,值为该任务重试的次数.
查找第一个匹配的文件
这其实不是一个循环,但和循环很相似.如果你想引用一个文件,而该文件是从一组文件中根据给定条件匹配出来的.这组文件中部分文件名由变量拼接而成.针对该场景你可以这样做:
- name: INTERFACES | Create Ansible header for /etc/network/interfaces
template: src={{ item }} dest=/etc/foo.conf
with_first_found:
- "{{ansible_virtualization_type}}_foo.conf"
- "default_foo.conf"
该功能还有一个更完整的版本,可以配置搜索路径.请看以下示例:
- name: some configuration template
template: src={{ item }} dest=/etc/file.cfg mode=0444 owner=root group=root
with_first_found:
- files:
- "{{inventory_hostname}}/etc/file.cfg"
paths:
- ../../../templates.overwrites
- ../../../templates
- files:
- etc/file.cfg
paths:
- templates
迭代程序的执行结果
有时你想执行一个程序,而且按行循环该程序的输出.Ansible提供了一个优雅的方式来实现这一点.但请记住,该功能始终在控制机上执行,而不是本地机器:
- name: Example of looping over a command result
shell: /usr/bin/frobnicate {{ item }}
with_lines: /usr/bin/frobnications_per_host --param {{ inventory_hostname }}
好吧,这好像有点随意.事实上,如果你在做一些与inventory有关的事情,比如你想编写一个动态的inventory源(参见 动态 Inventory),那么借助该功能能够快速实现.
如果你想远程执行命令,那么以上方法则不行.但你可以这样写:
- name: Example of looping over a REMOTE command result
shell: /usr/bin/something
register: command_result
- name: Do something with each result
shell: /usr/bin/something_else --param {{ item }}
with_items: "{{command_result.stdout_lines}}"
使用索引循环列表
如果你想循环一个列表,同时得到一个数字索引来标明你当前处于列表什么位置,那么你可以这样做.虽然该方法不太常用:
- name: indexed loop demo
debug: msg="at array position {{ item.0 }} there is a value {{ item.1 }}"
with_indexed_items: "{{some_list}}"
循环配置文件
ini插件可以使用正则表达式来获取一组键值对.因此,我们可以遍历该集合.以下是我们使用的ini文件:
[section1]
value1=section1/value1
value2=section1/value2
[section2]
value1=section2/value1
value2=section2/value2
以下是使用 with_ini 的例子:
- debug: msg="{{item}}"
with_ini: value[1-2] section=section1 file=lookup.ini re=true
新手学习教程:
https://www.w3cschool.cn/automate_with_ansible
官方文档:
https://docs.ansible.com/
安装:
yum install -y ansible
配置文件:/etc/ansible/hosts (例子:https://www.w3cschool.cn/automate_with_ansible/automate_with_ansible-1khc27p1.html)
#ansible_ssh_host
#ansible_ssh_port
#ansible_ssh_user
#ansible_ssh_pass
#ansible_ssh_private_key_file
[dev]
192.168.0.200 ansible_ssh_port=123456
[online]
pc1 ansible_ssh_host=192.168.0.200 ansible_ssh_user=root ansible_ssh_port=123456
若有对 Control Machine 本机操作的需求,建议于 /etc/ansible/hosts 补上 local 的设定。
# For root user.
$ /bin/echo -e "[local]\nlocalhost ansible_connection=local" >> /etc/ansible/hosts
# For sudo user.
$ sudo su -c '/bin/echo -e "[local]\nlocalhost ansible_connection=local" >> /etc/ansible/hosts'
Hello World
当已上的设置都完成了,您可以试著在终端机里用 Ansible 呼叫本机印出 Hello World。
$ ansible dev -m command -a 'echo Hello World.'
localhost | SUCCESS | rc=0 >>
Hello World.
欢迎来到 Ansible 的世界!:D
如果遇到第一次连接会检查是否有链接过的记录时,可能需要把下面这个设置启用(不检查):
Using a SSH password instead of a key is not possible because Host Key checking is enabled and sshpass does not support this. Please add this host's fingerprint to your known_hosts file to manage this host.
配置:/etc/ansible/ansible.conf
host_key_checking = False
实操技巧:
使用剧本的时候 -e :
# 多个变量间用空格隔开,遇到值有空格时用引号
ansible-playbook xxx.yml -e "var1=val1 var2=val2 var3='val val'"
# 将参数写到文件中,再引用,文件内容格式为json: {"a":"123", "b": "321"}
ansible-playbook xxx.yml -e "@path/to/file"
# 刷本中写变量,-e 传入的变量会覆盖的, xxx.yml:
- name: xxx
hosts: xxx
vars_files:
- xxx.json
vars:
a: 123
b: 321
上传文件的时候,可能需要上传多个文件,怎么写:
tasks:
- name: upload cert files
copy: src={{ item.src }} dest={{ item.dest }}
with_items:
- { src: '/root/site/{{ mark }}.key', dest: '/data/cert/{{ mark }}.key' }
- { src: '/root/site/{{ mark }}.pem', dest: '/data/cert/{{ mark }}.pem' }