5.4 迭代
当有需要重复性执行的任务时,可以使用迭代机制。其使用格式为将需要迭代的内容定义为item变量引 用,并通过with_items语句来指明迭代的元素列表即可。例如:
- name: add server user user: name={{ item }} state=persent groups=wheel with_items: - testuser1 - testuser2 |
上面语句的功能等同于下面的语句:
- name: add user testuser1 user: name=testuser1 state=present group=wheel - name: add user testuser2 user: name=testuser2 state=present group=wheel |
事实上, with_items中可以使用元素还可为hashes,例如:
- name: add several users user: name={{ item.name}} state=present groups={{ item.groups }} with_items: - { name: 'testuser1', groups: 'wheel'} - { name: 'testuser2', groups: 'root'} |
Ansible的循环机制还有更多的高级功能,具体请参考官方文档[2]
# grep '{{' conf/httpd.conf MaxClients {{ maxClients }} Listen {{ httpd_port }}
# cat /etc/ansible/hosts [webserver] 127.0.0.1 httpd_port=80 maxClients=100 192.168.10.149 httpd_port=8080 maxClients=200
# cat apache.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 template: src=/root/conf/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=httpd state=restarted |
playbook是由一个或多个"play"组成的列表。 play的主要功能在于将事先归并为一组的主机装扮成事先 通过ansible中的task定义好的角色。从根本上来讲,所有task无非是调用ansible的一个module。将多 个play组织在一个playbook中,即可以让他们连同起来按事先编排的机制同唱一台大戏。下面是一个简 单示例。
- hosts: webserver vars: http_port: 80 max_clients: 256 remote_user: root tasks: - name: ensure apache is at the latest version yum: name=httpd state=latest - name: ensure apache is running service: name=httpd state=started handlers: - name: restart apache service: name=httpd state=restarted |
7.1 playbook基础组件
7.1.1 Hosts和Users
playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。 hosts用于 指定要执行指定任务的主机,其可以使一个或多个由冒号分隔主机组; remote_user则用于指定远程主 机的执行任务的用户,如上面的实例中的
- hosts: webserver remote_user: root |
不过, remote_user也可用于各task中,也可以通过指定其通过sudo的方式在远程主机上执行任务,其
可用于play全局或其任务;此外,甚至可以在sudo时使用sudo_user指定sudo时切换的用户。
- hosts: webserver remote_user: devopsman tasks: - name: test connection ping: remote_user: devopsman sudo: yes |
7.1.2 任务列表和action
play的主题部分是task list。task list中的各任务按次序逐个在hosts中指定的所有主机上执行,即在所有 主机上完成第一个任务后再开始第二个。在运行自上而下某playbook时,如果中途发生错误,所有已执 行任务都可能回滚,在更正playbook后重新执行一次即可。
taks的目的是使用指定的参数执行模块,而在模块参数中可以使用变量。模块执行是幂等的。这意味着 多次执行是安全的,因为其结果均一致。
每个task都应该有其name,用于playbook的执行结果输出,建议其内容尽可能清晰地描述任务执行步 骤,如果为提供name,则action的结果将用于输出。
定义task可以使用"action: module options"或”module:options“的格式推荐使用后者以实现向后兼 容。如果action一行的内容过多,也中使用在行首使用几个空白字符进行换行。
tasks: - name:make sure apache is running service: name=httpd state=started tasks: - name: run this command and ignore the result shell: /usr/bin/somecommand | | /bin/true |
在众多的模块中,只有command和shell模块仅需要给定一个列表而无需使用"key=value"格式,例如:
tasks: - name: disable selinux command: /sbin/setenforce 0 |
如果命令或脚本的退出码不为零,可以使用如下方式替代:
或者使用ignore_errors来忽略错误信息:
tasks: - name: run this command and ignore the result shell: /usr/bin/somecommand ignore_errors: True |
7.1.3handlers
用于当关注的资源发生变化时采取一定的操作。
"notify"这个action可用于在每个play的最后被触发,这样可以避免多次有改变发生时每次都执行执行的 操作,取而代之,仅在所有的变化发生完成后一次性地执行指定操作,在notify中列出的操作称为 handlers,也即notify中调用handlers中定义的操作。
- name: template configuration file template: src=template.j2 dest=/etc/foo.conf notify: - restart memcached - restart apache |
handlers是task列表,这些task与前述的task并没有本质上的不同。
handlers: - name: restart memcached service: name=memcached state=restarted - name: restart apache service: name=apache state=restarted |
简单示例1:
# cat nginx.yml - hosts: webserver remote_user: root tasks: - name: create nginxn group group: name=nginx system=yes gid=208 - name: create nginx user |
user: name=nginx uid=208 group=nginx system=yes
- hosts: dbserver remote_user: root tasks: - name: copy file to dbserver copy: src=/etc/inittab dest=/tmp/inittab.ans
# ansible-playbook nginx.yml |
简单示例2:
# cat apache.yml - hosts: webserver remote_user: root tasks: - name: install httpd package yum: name=httpd state=latest - name: install configuration file for httpd copy: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf - name: start httpd service service: enabled=true name=httpd state=started # ansible-playbook apache.yml |
handlers 示例:
# cat apache.yml - hosts: webserver remote_user: root tasks: - name: install httpd package yum: name=httpd state=latest - name: install configuration file for httpd copy: src=/root/conf/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
# ansible-playbook apache.yml |
variable 示例1:
# cat apache.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=/root/conf/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=httpd state=restarted |
variable 示例2:(在playbook中可以使用所有的变量)
# cat facts.yml - hosts: webserver remote_user: root tasks: - name: copy file copy: content="{{ ansible_all_ipv4_addresses }} " dest=/tmp/vars.ans |
ansible自1.2版本引入的新特性,用于层次性、结构化地组织playbook。 roles能够根据层次型结构自动 转载变量文件、 tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。简单来 讲, roles就是通过分别将变量、文件、任务、模板以及处理器放置于单独的目录中,并可以便捷地 include他们的一种机制。角色一般用于基于主机构建服务的场景中,但也可以使用于构建守护进程的场 景中
一个roles的案例如下所示:
site.yml webserver.yml fooserver.yml roles/ common/ files/ templates/ tasks/ handlers/ vars/ meta/ webserver/ files/ templates/ tasks/ handlers/ vars/ meta/ |
而在playbook中,可以这样使用role:
- hosts: webserver roles: - common - webserver |
也可以向roles传递参数,例如:
- hosts: webserver roles: - common - { role: foo_app_instance, dir:'/opt/a',port:5000} - { role: foo_app_instance, dir:'/opt/b',port:5001} |
甚至也可以条件式地使用roles,例如:
- hosts:webserver roles: - { role: some_role, when: "ansible_so_family == 'RedHat" } |
1. 创建以roles命名的目录:
2. 在roles目录中分别创建以各角色命名的目录,如webserver等
3. 在每个角色命名的目录中分别创建files、 handlers、 meta、tasks、templates和vars目录;用不到 的目录可以创建为空目录,也可以不创建
4. 在playbook文件中,调用各角色
8.2 role内各目录中可应用的文件
task目录:至少应该包含一个为main.yml的文件,其定义了此角色的任务列表;此文件可以使用 include包含其它的位于此目录中的task文件;
file目录:存放由copy或script等模板块调用的文件;
template目录: template模块会自动在此目录中寻找jinja2模板文件;
handlers目录:此目录中应当包含一个main.yml文件,用于定义此角色用到的各handlers,在 handler中使用inclnude包含的其它的handlers文件也应该位于此目录中;
vars目录:应当包含一个main.yml文件,用于定义此角色用到的变量
meta目录:应当包含一个main.yml文件,用于定义此角色的特殊设定及其依赖关系; ansible1.3及 其以后的版本才支持;
default目录:应当包含一个main.yml文件,用于为当前角色设定默认变量时使用此目录;
# mkdir -pv ansible_playbooks/roles/{webserver,dbserver}/{tasks,files,templates,meta,handlers ,vars} # cp /etc/httpd/conf/httpd.conf files/ # pwd /root/ansible_playbooks/roles/webserver # cat tasks/main.yml |
- name: install httpd package yum: name=httpd state=present - name: install configuretion file copy: src=httpd.conf dest=/etc/httpd/conf/httpd.conf tags: - conf notify: - restart httpd - name: start httpd service: name=httpd state=started
# cat handlers/main.yml - name: restart httpd service: name=httpd state=restarted
# pwd;ls /root/ansible_playbooks roles site.yml
# cat site.yml - hosts: webserver remote_user: root roles: - webserver
# ansible-playbook site.yml |
tags用于让用户选择运行或跳过playbook中的部分代码。 ansible具有幂等性,因此会自动跳过没有变化 的部分,即便如此,有些代码为测试其确实没有发生变化的时间依然会非常的长。此时,如果确信其没 有变化,就可以通过tags跳过此些代码片段。
tags:在playbook可以为某个或某些任务定义一个"标签",在执行此playbook时,通过为ansible- playbook命令使用--tags选项能耐实现仅运行指定的tasks而非所有的;
# cat apache.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 template: src=/root/conf/httpd.conf dest=/etc/httpd/conf/httpd.conf tags: - conf notify: - restart httpd - name: start httpd service service: enabled=true name={{ service }} state=started |
handlers: - name: restart httpd service: name=httpd state=restarted
# ansible-playbook apache.yml --tags='conf' |