ansible运维工具（二）

ansible playbook（二）

运行palybook时 要使用ansible-playbook命令

palybook执行任务的顺序是，在第一个主机上完成第一个任务，然后在第二个主机上完成第一个任务

而不是在第一个主机上完成所有任务，然后再在第二个主机上完成所有任务,以任务为中心，在所有主机上执行

如何构建ansible的playbook

Inventory

Modules

Ad Hoc Commands

PlayBooks

Tasks 任务，及调用某模块所完成的操作

Variable 变量

Templates 模版

Handlers 处理器，通常指的是在某条件满足时触发执行的操作

Roles 角色

如果想说清楚的playbooks，还要额外的了解一些基础概念

Ansible中使用的YAML基础元素：
    变量
    Inventory
    条件判断
    迭代
基本结构

	- hosts: websrvs
	  remote_user:
      tasks:
      	- name: task1
      	  module_name:
        - name: task2
          module_name:

	- hosts: dbsrvs

简单示例1：

- hosts: websrvs
  remote_user: root
  tasks:
    - name: create nginx group
      group: name=nginx system=yes gid=208
    - name: create nginx user
      user: name=nginx uid=208 system=yes group=nginx

- hosts: dbsrvs
  remote_user: root
  tasks:
    - name: copy file to dbsrvs
      copy: src=/etc/inittab dest=/tmp/inittab.ansible

简单实例2:

- hosts: websrvs
  remote_user: root
  tasks:
    - name: install httpd packege
      yum: name=httpd state=latest
    - name: install configuration file for httpd
      copy: src=conf/httpd.conf dest=/etc/httpd/conf/httpd.conf
    - name: start httpd service
      service: enabled=true name=httpd  state=started

简单实例3-handler:

当配置文件发生改变时，应该让服务重启。那么重启服务就要用handler,当这个服务发生变化时使用notify属性通知要执行的handler里定义的任务如下：

- hosts: websrvs
  remote_user: root
  tasks:
    - name: install httpd packege
      yum: name=httpd state=latest
    - name: install configuration file for httpd
      copy: src=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
~

简单实例4-定义变量：

- hosts: websrvs
  remote_user: root
  vars:
    - package: httpd
    - service: httpd
  tasks:
    - name: install httpd packege
      yum: name={{ package }} state=latest
    - name: install configuration file for httpd
      copy: src=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={{ service }} state=restarted

简单示例5-使用facts变量：

- hosts: websrvs
  remote_user: root
  tasks:
    - name: copy file
      copy: content= "{{ ansible_all_ipv4_addresses }}" dest=/tmp/vars.ans

同样在inventory 中为主机 或者主机组定义的变量也可以通过 {{ 变量名 }}直接调用。

简单示例6-条件判断语句when:

- hosts: all
  remote_user: root
  vars:
    - username: user10
  tasks:
    - name: create {{ username }} user
      user: name= {{username}}
      when: ansible_fqdn  == 'node1.my.com'

简单示例7-迭代

重复执行同类task时使用

定义循环列表：with_items

    - name: add serveral users
      user: name={{ item }} state=present groups=wheel
      with_items:
        - testuser1
        - testuser2
要安装多个程序包的时候使用很方便，定义yum
	- apache
	- php
	- mysql-server

注意： with_item中的列表值也可以是字典

    - name add serveral users
      user: name= {{ itesm.name }} state=present groups= {{ item.groups }}
      with_items:
        - { name: 'testuser1', groups: 'wheel' }
        - { name: 'testuser2', groups: 'root' }

比较是用的是，一个tasks下安装程序包，定义配置文件就可以用yum，和copy

    with_items:
      - { name: apache, conf: conffiles/httpd.conf }
      - { name: php, conf: conffiles/php.ini }
      - { name: mysql-server, conf: conffiles/my.cnf }

模版template 的使用，常用于静态配置文件中定义变量以及条件语句，一般在ansible中模版文件后缀名为.j2因为使用的是jinjia2模版语言。同时也要安装python的jinjia2扩展包，对于我们来将最常用的就是变量。

使用举例：

inventory中定义如下：

[websrvs]

172.16.100.7 http_port=80 maxClients=100

172.16.100.8 http_port=8080 maxClients=200

假如有一个配置文件中关于端口和maxClients配置项更改如下
Server Name {{ ansible_fqdn }}
Listen {{ http_port }}
maxClients {{ maxClients }}
一般都会创建一个名为templates/httpd.conf.j2

接着我们在playbooks就把之前使用copy模块定义配置文件的地方改用template模块，如下：

- hosts: websrvs
  remote_user: root
  vars:
    - package: httpd
    - service: httpd
  tasks:
    - name: install httpd packege
      yum: name={{ package }} state=latest
    - name: install configuration file for httpd
      template: src=/root/templates/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={{ service }} state=restarted

tags的使用

我们前面定义的playbook中有多个tasks，如果我们想单独运行这个playbook中的某一个task就需要通过tabs来实现。

- hosts: websrvs
  remote_user: root
  vars:
    - package: httpd
    - service: httpd
  tasks:
    - name: install httpd packege
      yum: name={{ package }} state=latest
    - name: install configuration file for httpd
      template: src=/root/templates/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={{ service }} state=restarted

使用下面命令，只运行tags为conf的任务

	ansible-playbook apache.yml --tags='conf'

当然可以--tage='aa,bb,cc'指明多个tag

特殊tags

假如有的任务你想只要运行这个playbook（即使指定--tags）就需要执行这个task，那么就可以使用

tags: always

以上内容就可以满足我们对ansible的使用了，接来下了解角色的定义，让我们更方便的使用ansible

我们想让一批主机完成 一批任务就可以使用playbook进行配置执行。那么我们想那为什么还要有role角色这个东西的存在。存在的意义是什么。这里我们在playbook已经可以实现为一批主机执行一批任务了，为什么还要有role角色这个玩意。 那好我们来举个例子，假如一台服务器上安装nginx又安装了php还安装了mysql。那么你可以写一个playbook的yaml文件，但是我们现在又有一台主机想只执行 nginx 和php，那么你怎么实现。当然可以再次更改playbook，为其添加一个play，但这违背了开发的尽量不写重复代码的宗旨。所以你实现的方式很low。那么这时候你如果想，事先定义了三个角色，一个nginx,php，mysql 在应用到主机上就完美了，那就是roles。

roles的应用

ansible 自1.2版本引入的新特性，用于层次性、结构化地组织playbook，roles能够根据层次型结构自动装载变量文件、tasks以及handles等，要使用roles只需要在playbook中使用include指令即可，简单来讲，roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中，并可以便捷地include他们的一种机制，角色一般用于基于主机的构建服务的场景中，但也可以适用于构建守护进程等场景中：

一个roles的案例如下所示：
	site.yml
    webservers.yml
    fooservers.yml
    roles/
    	common/
          files/
          templates/
          tasks/
          handlers/
          vars/
          meta/
        webservers/
          files/
          templates/
          tasks/
          handlers/
          vars/
          meta/
而在playbook中，也可以这样使用roles:
...
- hosts: webservers
  roles:
    - common
    - webservers
也可以向roles传递参数，例如：
...
- hosts: webservers
  roles:
    - common
    - { role: foo_app_instance, dir: '/opt/a', port: 5000}
    - { role: foo_app_instance, dir: '/opt/b', port: 5001}
设置也可以条件式地使用roles， 例如：
...

- hosts: webservers
  roles:
    - {role: some_role, when: "ansible_os_family == 'redhat'"}

8.1创建role的步骤

（1） 创建以roles命名的目录；

（2） 在roles目录中分别创建以各种角色名称命名的目录，如 webservers等；

（3） 在每一个角色命名的目录中分别创建 files,handlers,meta, tasks,templates 和vars目录：用不到的目录可以创建为空目录，也可以不创建；

（4） 在playbook文件中，调用各角色

8.2 role内各目录汇总可用的文件

tasks目录： 至少应该包含一个名为main.yml的文件，其定义来此角色的任务列表；此文件可以使用include包含其它的位于此目录中的task文件；
files目录： 存放又copy或script等模块调用的文件；
templates目录： template模块会自动在此目录中寻找jinjia2模版文件；
handlers目录： 此目录中应当包含一个mian.yml文件，用于定义此角色用到的handler,在handler中使用include包含的其它的handler文件也应该位于此目录；
vars目录：应当包含一个mian.yml文件，用于定义此角色用到的变量；
meta目录：应当包含一个main.yml文件，用于定义此角色的特殊设定及其依赖关系，ansible 1.3及其以后的版本才支持；
default目录： 为当前角色设定变量时使用此目录，应当包含一个main.yml文件

示例：

1.创建roles目录

mkdir /root/ansible_playbooks/roles

mkidr -pv /root/ansible_playbooks/roles/{webservers, dbservers}/{tasks,files,templates,handlers,vars,meta}

2. 把要用到的文件放到 files目录下，把要用到的template文件放到 templates目录下

3. 在tasks目录中编辑main.yml

vim /root/ansible_playbooks/roles/webservers/tasks/main.yml

- name: install httpd packeg

yum: name=httpd

- name: install configuration file for httpd

template: src=httpd.conf dest=/etc/httpd/conf/httpd.conf

tags:

- conf

notify:

- restart httpd

- name: start httpd service

service: enabled=true name={{ service }} state=started

这里指定模版文件的时候，就不用指定目录来，它会自己去找角色目录下的template目录下的文件

4. 这里我们用到了notify，也就是说我们需要定义handlers，接下来

    vim /root/ansible_playbooks/roles/webservers/handlers/main.yml
      - name: restart httpd
      service: name={{ service }} state=restarted

5. 如果想定义变量
    vim /root/ansible_playbooks/roles/webservers/vars/main.yml
		- http_port: 80
		- service: httpd
		- maxclients: 200
6. 这样我们就定义了webservers 这个角色，将来我们想要调用这个角色，需要在roles这个目录的同级目录下有site.yml文件
vim site.yml
- hosts： websrvs
  remote_user: root
  roles:
    - webservers

至此 我们ansible-playbook site.yml

为了体现这个roles的灵活性：

vim site.yml

- hosts： 172.16.100.7

remote_user: root

roles:

- webservers

- hosts： 172.16.100.8
  remote_user: root
  roles:
    - dbservers

- hosts： 172.16.100.9
  remote_user: root
  roles:
    - webservers
    - dbservers

4.1 YAML 简介
YAML是一个可读性高的用来表达资料序列的格式。YAML在设计时参考了其他多种语言，包括：XML、C语言、PYTHON、Perl以及电子邮件格式的RFC2882等，Clark Evans 在2001年首次发表了这种语言，另外Ingy dot Net 与 Ben-Kiki 也是这语言的共同设计者。

YAML Ain't Markup Language, 即YAML不是XML，不过，在开发的这种语言是，YAML的意思其实是： “Yet Another Markup  Language"(仍是一种标记语言)，其特性：

也是用于在不同主机之间共享数据时，能够通过某种特定形式描述数据本身结构的一种数据组织形式。不同xml的是，yaml通过使用键值对+缩进的形式表示的

YAML 的可读性好
YAML 和脚本语言的交互性好
YAML 使用实现语言的数据类型
YAML 又一个一直的信息模型
YAML 易于实现
YAML 可以基于流来处理
YAML 表达能力强，扩展性好
更多的内容及规范参见http://www.yaml.org/

4.2 YAML 语法

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
YAML 文件扩展名通常为.yaml, 如 example.yaml.

4.2.1 list
列表的所有元素均使用"-"大头，例如：
# A list of tasty fruits
- Apple
- Orange
- strawberry
- mango

4.2.2 dictionay
字典通过key与value进行标示， 例如：
---
# An employee record
name: Examle Developer
job: Developer
skill: Elite

也可以将key:value 放置于{}中进行表示，例如：
---
# An employee record
{name: Examle Developer, job: Developer, skill: Elite}

五、Ansible基础元素

5.1 变量

5.1.1 变量命名
变量名仅能由字母、数字和下划线组成，且只能以字母开头
5.1.2 facts
facts 是由正在通信的远程目标主机发回的信息，这些信息被保存在ansible变量中，要获取指定的远程主机所支持的所有facts,可使用如下命令进行：
# ansible hostname -m setup
5.1.3 register
把任务的输出定义为变量，然后用于其他任务，示例如下：

tasks:
	- shell: /usr/bin/foo
	- register: foo_result
	- ignore_errors:True
5.1.4 通过命令行传递变量
在运行playbook的时候也可以传递一些变量供playbook使用：示例如下：
	ansible-playbook test.yml --extra-vars "hosts=www user=mageedu"

5.1.5 通过role传递变量
当给一个主机应用角色的时候可以传递变量， 然后在角色内使用这些变量，示例如下：
	- hosts: webservers
      roles:
        - common
        - {role: foo_app_instance, dir:'/web/htdocs/a.com', port:8080}

5.2 Inventory
ansible 的主要作用在于批量主机操作， 为了便捷地使用其中的部分主机， 可以在inventory file 中将其分组命名， 默认的inventory file为/etc/ansible/hosts.

inventory file 可以有多个，且也可以通过 Dynamic Inventory来动态生成。

5.2.1 inventory文件格式
inventory 文件遵循INI文件风格， 中括号中的字符为组名，可以将同一个主机同时归到多个不同的组中；此外，当如若目标主机使用了非默认的SSH端口，还可以在主机名称之后使用冒号来标明。

ntp.mageedu.com

[webserver]
www1.my.com:2222
www2.my.com

[dbserver]
db1.my.com
db2.my.com
db3.my.com

如果主机名遵循相似的命名模式，还可以使用列表的方式标识各主机，例如：

[webservers]
www[01:10].my.com
[databases]
db-[a:f].my.com

5.2.2主机变量

可以在inventory中定义主机时为其添加主机变量以便与在playbook中使用，例如：
[webservers]
www1.my.com http_port=80 maxRequestsPerChild=808
www1.my.com http_port=8080 maxRequestsPerChild=909

5.2.3组变量

组变量是指赋予给指定组内所有主机上的palybook中可用的变量，例如：

[webservers]
www1.my.com
www2.my.com

[webservers:vars]
ntp_server=ntp.my.com
nfs_server=nfs.my.com

5.2.4 组嵌套
inventory 中，组还可以包含其他组，并且也可以向组中的主机指定变量，不过，这些变量只能在ansible-playbook中使用，而ansible不支持，例如：
[apache]
http1.my.com
http2.my.com

[nginx]
ngx1.my.com
ngx2.my.com

[webservers:children]
apache
nginx

[webservers:vars]
ntp_server=ntp.my.com

5.2.5 inventory参数
ansible基于ssh连接inventory中指定的远程主机时，还可以通过参数指定其交互方式；这些参数如下所示：
[webservers]
172.16.100.7 ansible_ssh_user=root ansible_ssh_pass=mypasswd ansible_ssh_port=12008

5.3 条件测试
在task后添加when子句即可使用条件测试；when语句支持jinjia2表达式语法，例如：

    tasks:
      - name: "shutdown Debian flavored systems"
      command: /sbin/shutdown -h now
      when: ansible_os_family == 'Debian'
when语句中还可以使用jinjia2的大多"filter", 例如要忽略此前某语句的错误并基于其结果<failed或者sucess> 运行后面指定的语句，可使用类似如下形式：

	tasks:
    	- command: /bin/false
    	  register: result
          ignore_errors; True
        - command: /bin/something
          when: result|failed
        - command: /bin/somethin_else
          when: result|skipped
   此外，when 语句中还可以使用facts或playbook中定义的变量
5.4 迭代，其实就表示循环

当有需要重复性执行的任务时，可以使用迭代机制，其使用格式为将需要迭代的内容定义为item变量引用，并通过with_items 语句来指明迭代的元素列表即可
- 例如：

    - name: add serveral users
      user: name={{ item }} state=present groups=wheel
      with_items:
        - testuser1
        - testuser2

上面语句的功能等同于下面的语句：

    - name: add user testuser1
      user: name=testuser1 state=present groups=wheel
    - name: add user testuser2
      user: name=testuser2 state=present groups=wheel

事实上，with_items中可以使用元素还可以为hashes, 例如：

    - name add serveral users
      user: name= {{ itesm.name }} state=present groups= {{ item.groups }}
      with_items:
        - { name: 'testuser1', groups: 'wheel' }
        - { name: 'testuser2', groups: 'root' }

ansible的循环机制还有更多的高级功能， 具体请参见官方文档（http://docs.ansible.com/playbooks_loops.html）

七. 如何编写playbook

ansible playbooks

playbook是由一个或多个'play'组成的列表，play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲，所谓task无非是调用ansible的一个module.将多个play组织在一个palybook中，即可以让他们联同起来按事先编排的机制同唱一台大戏，下面是一个简单示例。

- hosts: webnodes
  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: retart apache
      service: name=httpd state=restarted

7.1 palybook的基础组件

7.1.1 Hosts和Users

playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。hosts 用于指定要执行任务的主机，其可以是一个或多个由某好分隔主机组；remote_user 则用于指定远程主机上的执行任务的用户，如上图示例中的

	- hosts: webnodes
      remote_user: root

不过，remote_user也可用于各task中，也可以通过指定其通过sudo的方式在远程主机上执行任务，其可用于play全局或某任务，此外，甚至可以在sudo时使用sudo_user指定sudo时切换的用户。

- hosts: webnodes

remote_user: ted1

tasks:

- name: test connection

ping:

remote_user: ted2

sudo : yes

7.1.2 任务列表和action

play的主体部分石task list.task list中的各任务按次序逐个在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
    	  sehll: /usr/bin/somecommand|| /bin/true

或者使用ignore_errors来忽略错误信息：（即使运行有错误，不管他继续执行其他tasks）

	tasks:
    	- name: run this command and ignore the result
    	  shell: /usr/bin/somecommand
          ignore_errors: True

7.1.3 handlers

用于当天关注的资源发生变化时采取一定的操作。

'notify'这个action可用于在每个play的最后被触发。 这样可以避免多次由改变发生时每次都执行指定的操作，取而代之，仅在所有的变化发生完成后一次性执行指定操作。在notify中列出的操作成为handler,也即notify中调用handler中定义的操作。

- 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=mamcached state=restarted

- name: restart apache

service: name=apache state=restarted

示例：
    - hosts: websrvs
      remote_user: root
      tasks:
        - name: install httpd packege
          yum: name=httpd state=latest
        - name: install configuration file for httpd
          copy: src=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