playbook ansible
(一)playbook简述
ansbile-playbook是一系统ansible命令的集合,其利用yaml 语言编写,运行过程,ansbile-playbook命令根据自上而下的顺序依次执行。同时,playbook开创了很多特性,它可以允许你传输某个命令的状态到后面的指令,如你可以从一台机器的文件中抓取内容并附为变量,然后在另一台机器中使用,这使得你可以实现一些复杂的部署机制,这是ansible命令无法实现的。
playbook通过ansible-playbook命令使用,它的参数和ansible命令类似,如参数-k(–ask-pass) 和 -K (–ask-sudo) 来询问ssh密码和sudo密码,-u指定用户,这些指令也可以通过规定的单元写在playbook 。ansible-playbook的简单使用方法: ansible-playbook example-play.yml 。
(二)简单的实例
一,通过playbook添加用户实例
1,给远程主机添加用户test
- [[email protected] ansible]# vim user.yml
- ########add user.yml
- - name: create user
- hosts: all
- user: root
- gather_facts: false
- vars:
- - user: "test"
- tasks:
- - name: create user
- user: name="{{ user }}"
上面的playbook 实现的功能是新增一个用户:
2,查看具体的执行结果
- [[email protected] ansible]# ansible-playbook user.yml
- PLAY [create user] *************************************************************
- TASK [create user] ************************************************************
- changed: [Server5]
- changed: [192.168.180.4]
- fatal: [192.168.180.23]: FAILED! => {"changed": false, "cmd": "/sbin/useradd -m test", "failed": true, "msg": "[Errno 13] 权限不够", "rc": 13}
- ok: [Server6]
- ok: [192.168.180.6]
- ok: [192.168.180.5]
- changed: [192.168.180.10]
- ok: [192.168.180.2]
- to retry, use: --limit @/etc/ansible/user.retry
- PLAY RECAP *********************************************************************
- 192.168.180.10 : ok=1 changed=1 unreachable=0 failed=0
- 192.168.180.2 : ok=1 changed=0 unreachable=0 failed=0
- 192.168.180.23 : ok=0 changed=0 unreachable=0 failed=1
- 192.168.180.4 : ok=1 changed=1 unreachable=0 failed=0
- 192.168.180.5 : ok=1 changed=0 unreachable=0 failed=0
- 192.168.180.6 : ok=1 changed=0 unreachable=0 failed=0
- Server5 : ok=1 changed=1 unreachable=0 failed=0
- Server6 : ok=1 changed=0 unreachable=0 failed=0
3,删除远程主机的账号:只需user: name="{{ user }}" state=absent remove=yes 即可
,把刚才添加的test用户删除:
- [[email protected] ansible]# vim user.yml
- ########add user.yml
- - name: create user
- hosts: all
- user: root
- gather_facts: false
- vars:
- - user: "test"
- tasks:
- - name: create user
- user: name="{{ user }}" state=absent remove=yes
- [[email protected] ansible]# ansible-playbook user.yml
- PLAY [create user] *************************************************************
- TASK [create user] ************************************************************
- changed: [Server5]
- changed: [192.168.180.4]
- ok: [192.168.180.23]
- changed: [192.168.180.6]
- ok: [192.168.180.5]
- ok: [Server6]
- fatal: [192.168.180.2]: FAILED! => {"changed": false, "failed": true, "msg": "userdel:/ftmp/test 并不属于 test,所以不会删除\n", "name": "test", "rc": 12}
- changed: [192.168.180.10]
- to retry, use: --limit @/etc/ansible/user.retry
- PLAY RECAP *********************************************************************
- 192.168.180.10 : ok=1 changed=1 unreachable=0 failed=0
- 192.168.180.2 : ok=0 changed=0 unreachable=0 failed=1
- 192.168.180.23 : ok=1 changed=0 unreachable=0 failed=0
- 192.168.180.4 : ok=1 changed=1 unreachable=0 failed=0
- 192.168.180.5 : ok=1 changed=0 unreachable=0 failed=0
- 192.168.180.6 : ok=1 changed=1 unreachable=0 failed=0
- Server5 : ok=1 changed=1 unreachable=0 failed=0
- Server6 : ok=1 changed=0 unreachable=0 failed=0
二,通过playbook一键升级bash
- [[email protected] ansible]# vim update_bash.yml
- - hosts: all
- remote_user: root
- gather_facts: True
- tasks:
- - name: update bash in redhat 6 version
- yum: name=http://mirrors.aliyun.com/centos/6.6/os/x86_64/Packages/bash-4.1.2
- -29.el6.x86_64.rpm.rpm state=present
- when: ansible_os_family == "RedHat" and ansible_distribution_version|int >=6
- - name: update bash in redhat 5 version
- yum: name=http://mirrors.hustunique.com/centos/5/updates/x86_64/RPMS/bash-3.
- 2-33.el5.1.x86_64.rpm state=present
- when: ansible_os_family == "RedHat" and ansible_distribution_version|int <=5
- [[email protected] ansible]# ansible
- ansible ansible-doc ansible-playbook ansible-vault
- ansible-console ansible-galaxy ansible-pull
- [[email protected] ansible]# ansible-playbook update_bash.yml
- PLAY [all] *********************************************************************
- TASK [setup] *******************************************************************
- ok: [Server6]
- ok: [192.168.180.23]
- ok: [Server5]
- ok: [192.168.180.6]
- ok: [192.168.180.5]
- ok: [192.168.180.4]
- ok: [192.168.180.2]
- ok: [192.168.180.10]
- TASK [update bash in redhat 6 version] *****************************************
- fatal: [192.168.180.4]: FAILED! => {"changed": false, "failed": true, "msg": "Failure downloading http://mirrors.aliyun.com/centos/6.6/os/x86_64/Packages/bash-4.1.2-29.el6.x86_64.rpm.rpm, ‘NoneType‘ object has no attribute ‘read‘"}
- skipping: [192.168.180.23]
- TASK [update bash in redhat 5 version] *****************************************
- fatal: [192.168.180.23]: FAILED! => {"changed": false, "failed": true, "msg": "Failure downloading http://mirrors.hustunique.com/centos/5/updates/x86_64/RPMS/bash-3.2-33.el5.1.x86_64.rpm, ‘NoneType‘ object has no attribute ‘read‘"}
- to retry, use: --limit @/etc/ansible/update_bash.retry
- PLAY RECAP *********************************************************************
- 192.168.180.10 : ok=1 changed=0 unreachable=0 failed=1
- 192.168.180.2 : ok=1 changed=0 unreachable=0 failed=1
- 192.168.180.23 : ok=1 changed=0 unreachable=0 failed=1
- 192.168.180.4 : ok=1 changed=0 unreachable=0 failed=1
- 192.168.180.5 : ok=1 changed=0 unreachable=0 failed=1
- 192.168.180.6 : ok=1 changed=0 unreachable=0 failed=1
- Server5 : ok=1 changed=0 unreachable=0 failed=1
- Server6 : ok=1 changed=0 unreachable=0 failed=1
三,通过playbook 安装apache
- [[email protected] ansible]# vim apache.yml
- - hosts: web1
- user: root
- gather_facts: True
- tasks:
- - name: install apache on CentOS
- yum: name=httpd state=present
- when: ansible_os_family =="CentOS"
- [[email protected] ansible]# ansible-playbook apache.yml
- PLAY [web1] ********************************************************************
- TASK [setup] *******************************************************************
- ok: [Server6]
- ok: [Server5]
- TASK [install apache on CentOS] ************************************************
- skipping: [Server6]
- skipping: [Server5]
- PLAY RECAP *********************************************************************
- Server5 : ok=1 changed=0 unreachable=0 failed=0
- Server6 : ok=1 changed=0 unreachable=0 failed=0
(三)playbook构成
playbook是由一个或多个“play”组成的列表。play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中即可以让它们联同起来按事先编排的机制一同工作。其主要有以下四部分构成
- playbooks组成:
- Target section: 定义将要执行 playbook 的远程主机组
- Variable section: 定义 playbook 运行时需要使用的变量
- Task section: 定义将要在远程主机上执行的任务列表
- Handler section: 定义 task 执行完成以后需要调用的任务
而其对应的目录层为五个,如下:
- 一般所需的目录层有:(视情况可变化)
- vars 变量层
- tasks 任务层
- handlers 触发条件
- files 文件
- template 模板
下面介绍下构成playbook 的四层结构。
1、Hosts和Users
- #######示例
- - hosts: web1
- tasks:
- - name: test ping connection:
- remote_user: test
- sudo: yes
playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。
2,任务列表和action
play的主体部分就是任务列表。
任务列表中的各任务按次序逐个在hosts中指定的所有主机上执行即在所有主机上完成第一个任务后再开始第二个。在自上而下运行某playbook时如果中途发生错误,所有已执行任务都将回滚因此在更正playbook后重新执行一次即可。
task的目的是使用指定的参数执行模块,而在模块参数中可以使用变量。模块执行是幂等的,这意味着多次执行是安全的,因为其结果均一致。每个task都应该有其name用于playbook的执行结果输出,建议其内容尽可能清晰地描述任务执行步骤。如果未提供name则action的结果将用于输出。
定义task的可以使用"action: module options"或"module: options"的格式,推荐使用后者以实现向后兼容。如果action一行的内容过多也可使用在行首使用几个空白字符进行换行。
- tasks:
- - name: make sure apache is running
- service: name=httpd state=running
- 在众多模块中只有command和shell模块仅需要给定一个列表而无需使用“key=value”格式例如
- 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
3,handlers
用于当关注的资源发生变化时采取一定的操作。
"notify"这个action可用于在每个play的最后被触发,这样可以避免多次有改变发生时每次都执行指定的操作,取而代之仅在所有的变化发生完成后一次性地执行指定操作。
在notify中列出的操作称为handler也即notify中调用handler中定义的操作。
注意:在notify中定义内容一定要和tasks中定义的 - name 内容一样,这样才能达到触发的效果,否则会不生效。
- - name: template configuration file
- template: src=template.j2 dest=/etc/foo.conf
- notify:
- - restart memcached
- - restart apache
- handler是task列表这些task与前述的task并没有本质上的不同。
- handlers:
- - name: restart memcached
- service: name=memcached state=restarted
- - name: restart apache
- service: name=apache state=restarted
4,tags
tags用于让用户选择运行或略过playbook中的部分代码。ansible具有幂等性,因此会自动跳过没有变化的部分,即便如此,有些代码为测试其确实没有发生变化的时间依然会非常地长。此时如果确信其没有变化就可以通过tags跳过这些代码片断。
5,示例。下面再给出一个安装httpd web服务的示例:
- [[email protected] ansible]# vim playbook/install_web.yml
- ########httpd
- - hosts: all
- user: root
- gather_fasks: False
- vars:
- packages: httpd
- tasks:
- - name: Install httpd
- yum: name={{ packages }} state=present
- - name: Cofiguration httpd
- copy: src=/root/httpd.conf dest=/etc/httpd/conf/httpd.conf
- tags: httpd_conf
- notify:
- - restart httpd
- - name: Start httpd
- service: name=httpd state=started enabled=no
- tags: start
- - name: Add centos user
- user: name={{ item }} state=absent
- tags: adduser
- with_items:
- - centos
- - admin
- handlers:
- - name: restart httpd
- service: name=httpd state=restart
来源: http://www.bubuko.com/infodetail-2295104.html