ansible--主机清单、YAML、playbook剧本、条件测试

一、主机清单

ansible默认的主机清单是/etc/ansible/hosts文件
主机清单可以手动设置，也可以通过Dynamic Inventory动态生成
一般主机名使用FQDN

1、编辑/etc/ansible/hosts

vi /etc/ansible/hosts
[webserver]         #方括号设置组名
www1.example.org    #定义被监控主机名称，这边可以是主机名也可以是IP地址，主机名需要修改/etc/hosts文件
www2.example.org:2222     #冒号后定义远程连接端口，默认是ssh的22端口

如果是名称类似的主机，可以使用列表这种变量的方式标识各个主机
[webserver]
www[01:50].example.org ansible_ssh_user=root ansible_ssh_pass=123456
#www01.example.org、www02.example.org、、、到www50.example.org都在这个标签内，
#ansible_ssh_user=root ansible_ssh_pass=123456是内置的变量


[dbbservers]
db-[a:f].example.org //也支持匹配a b c ... f

2、Inventory中变量

①、主机变量

[webserver]
www1.magedu.com http_port=80 maxRequestsChild=808
www2.magedu.com http_port=8080 maxRequestsChild=909

②、组变量

[servers:vars]
ntp_server=ntp.example.org
nfs_server=nfs.example.org

③、组嵌套

[apache]		       #apache有两台主机
http1.example.org
http2.example.org

[nginx]		           #nginx有两台主机
ngx1.example.org
ngx2.example.org

[webservers:children]   #组下面也可以包含组
apache
nginx

④、inventory变量参数

参数	                                                     说明
ansible_ssh_host	            将要连接的远程主机名.与你想要设定的主机的别名不同的话,可通过此变量设置.
ansible_ssh_port	            ssh端口号.如果不是默认的端口号,通过此变量设置.
ansible_ssh_user	            默认的 ssh 用户名
ansible_ssh_pass	            ssh 密码(这种方式并不安全,我们强烈建议使用 --ask-pass 或 SSH 密钥)
ansible_ssh_private_key_file	ssh 使用的私钥文件.适用于有多个密钥,而你不想使用 SSH 代理的情况.
ansible_ssh_common_args	        此设置附加到sftp，scp和ssh的缺省即默认命令行
ansible_sftp_extra_args	        此设置附加到默认sftp命令行。，安全级别
ansible_scp_extra_args	        此设置附加到默认scp命令行。，安全级别
ansible_ssh_extra_args	        此设置附加到默认ssh命令行。，安全级别
ansible_ssh_pipelining	        确定是否使用SSH管道。 这可以覆盖ansible.cfg中的设置。
ansible_shell_type	            目标系统的shell类型.默认情况下,命令的执行使用 'sh' 语法,可设置为 'csh' 或 'fish'.
ansible_python_interpreter	    目标主机的 python 路径.适用于的情况: 系统中有多个 Python, 或者命令路径不是"/usr/bin
                                /python",比如 *BSD, 或者 /usr/bin/python
ansible_*_interpreter	        这里的"*"可以是ruby 或perl 或其他语言的解释器，作用和ansible_python_interpreter 类似
ansible_shell_executable	    这将设置ansible控制器将在目标机器上使用的shell，覆盖ansible.cfg中的配置，默认为/bin/sh。

二、YAML

1、YAML简介

YAML：是一种非标记语言。是用来写配置文件的语言，非常简洁和强大。

YAML语法和其他语言类似，也可以表达散列表、标量等数据结构。

结构通过空格来展示；序列里配置项通过-来代表；Map里键值用:来分隔;YAML的扩展名为yaml

2、基本语法规则

大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tab键，只允许使用空格。
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

3、YAML支持的数据结构：

①、对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）

例如：name:Example Developer
       键 值

②、数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）

例如：-Apple
     -Orange

③、纯量：单个的、不可再分的值

例如：number：12.30
       sure：true

4、yaml示例

name:zhangsan
age:20
name:lisi
age:22
people：
-name:zhangsan
age:20
-name:lisi
age:22

对象里面包含多个属性

对象
  属性1   长：5M
  属性2   宽：2M
  属性3   高：1.5M
  
集合
  对象1
  对象2
  对象3

三、剧本playbook（Ansible的脚本）

ansible核心组件

通过task任务调用ansible的模板将多个play组织在一个playbook中运行

1、playbooks的组成

1、Tasks：任务，即调用模块完成的某操作；
2、Variables：变量
3、Templates：模板
4、Handlers：处理器触发器，当某条件满足时，触发执行的操作；
5、Roles：角色。

2、实例

- hosts: webserver              #定义的主机组，即应用的主机
  vars:                        #定义变量
    http_port: 80
    max_clients: 200
  user: root
  tasks:                                            #执行的任务
  - name: ensure apache is at the latest version	#任务名可以自定义
    yum: pkg=httpd state=latest	                    #模块:具体参数，检查httpd是否是最新版本
  - name: write the apache config file
    template: src=/srv/httpd.j2 dest=/etc/httpd.conf	#模板，这个src文件放在管理端，dest到被管理端去
    notify:	                                            #调用下面处理器，指定处理器名
    - restart apache
  - name: ensure apache is running
    service: name=httpd state=started
  handlers:                                             #处理器
    - name: restart apache
      service: name=httpd state=restarted	             #服务：参数，状态要为过去式

3、执行一个playbook

ansible-playbook  [yaml 文件名]

例如：

ansible-playbook ping.yml

参数：-k(–ask-pass) 用来交互输入ssh密码
     -K(-ask-become-pass) 用来交互输入sudo密码，提权
     -u 指定用户

补充命令：
      ansible-playbook nginx.yaml --syntax-check    #检查yaml文件的语法是否正确
      ansible-playbook nginx.yaml --list-task       #检查tasks任务
      ansible-playbook nginx.yaml --list-hosts      #检查生效的主机
     ansible-playbook nginx.yaml --start-at-task=‘Copy Nginx.conf’     # 指定从某个task开始运行

4、hosts和users介绍

---（开头）
- hosts: webserver               #指定主机组，可以是一个或多个组。，剧本的场景
  remote_user: root                #指定远程被管理端主机执行的用户名，用户要有权限，剧本的演员

5、还可以为每个task任务定义远程执行用户

- hosts: mysql			#剧本的场景
  remote_user: root     #剧本的演员 
  tasks:				#剧本做要什么事
    - name: test connection
      ping:				#模块名
      remote_user: mysql          #指定远程主机执行tasks的运行用户为mysql
 执行playbook时：ansible-playbook ping.yml -k

6、指定远程主机sudo切换用户

- hosts: mysql
  remote_user: root            
  become: yes	               #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_user: mysql          #指定sudo用户为mysql
  tasks:
  - name: copy text
  copy: src=/etc/fstab dest=/home/mysql/fstab.bak

执行playbook时：ansible-playbook ping.yml -K

在mysql节点上，查看操作是否成功

7、tasks列表和action

①、Playbook的主体部分是task列表，task列表中的各任务按次序逐个在hosts中指定的主机上执行，即在所有主机上完成第一个任务后再开始第二个任务。在运行playbook时（从上到下执行），如果一个host执行task失败，整个tasks都会回滚，请修正playbook 中的错误，然后重新执行即可。
Task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量，模块执行时幂等的，这意味着多次执行是安全的，因为其结果一致。

②、每一个task必须有一个名称name，这样在运行playbook时，从其输出的任务执行信息中可以很好的辨别出是属于哪一个task的。如果没有定义name，‘action’的值将会用作输出信息中标记特定的task。

③、定义一个task，常见的格式:”module: options” 例如：yum: name=httpd

④、ansible的自带模块中，command模块和shell模块无需使用key=value格式

小示例：

- hosts: 192.168.221.10
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/sbin/setenforce 0'
   - name: make sure apache is running
     service: name=httpd state=started

 play中只要执行命令的返回值不为0，就会报错，tasks停止

在webserver节点上，查看操作是否成功

修改如下：

- hosts: webserver
  remote_user: root
  tasks:
   - name: disable selinux
     command: '/sbin/setenforce 0'
     ignore_errors: True             #确认忽略报错，强制返回成功
   - name: make sure apache is running
     service: name=httpd state=started

以下是另外一个示例

- hosts: webserver
  remote_user: root
  tasks:
   - name: create nginx group
     group: name=nginx system=yes gid=208
   - name: create nginx user
     user: name=nginx uid=208 group=nginx system=yes
- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file to mysql
     copy: src=/etc/inittab dest=/opt/inittab.back

在webserver上查看操作是否成功

8、Handlers介绍

Handlers也是一些task的列表，和一般的task并没有什么区别。
是由通知者进行的notify，如果没有被notify，则Handlers不会执行，假如被notify了，则Handlers被执行
不管有多少个通知者进行了notify，等到play中的所有task执行完成之后，handlers也只会被执行一次

示例

- hosts: webserver
  remote_user: root
  tasks:
   - name: install httpd package
     yum: name=httpd state=latest
   - name: install configuration file for httpd
     copy: src=/opt/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

9、也可以引入变量

- 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=/opt/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

10、playbook使用变量的方法

①、通过ansible命令传递

例如：编辑如下yaml

vi a.yml
- hosts: mysql
  remote_user: root
  vars:
  - user:
  tasks:
  - name: add new user
    user: name={{user}}


然后执行命令： ansible-playbook a.yml -e “user=testvar”

可以执行命令查看：ansible mysql -m command -a ‘tail /etc/passwd’

②、直接在yaml中定义变量—如上handlers示例

③、直接引用一些变量

如：引用ansible的固定变量

vi test.yml
- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}}" dest=/opt/vars.txt	#content为具体内容
 
执行命令：ansible-playbook test.yml

去mysql节点上查看vars.txt文件内容

④、引用主机变量

vi /etc/ansible/hosts
在mysql组的主机后面添加如下
[mysql]
192.168.221.30 testvar="8080"          #定义testvar变量的值为80.183
vi test.yml
- hosts: mysql
  remote_user: root
  tasks:
   - name: copy file
     copy: content="{{ansible_all_ipv4_addresses}}，{{testvar}}" dest=/opt/vars.txt

执行命令：ansible-playbook test.yml
去mysql上查看vars。txt文件内容

在mysql上查看操作是否成功

四、条件测试

1、条件测试——when

如果需要根据变量、facts（setup）或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试，在Playbook中条件测试使用when子句。
在task后添加when子句即可使用条件测试：when子句支持jinjia2表达式或语法，例如：

vi when.yml
- hosts: mysql
  remote_user: root
  tasks:
    - name: "shutdown CentOS"
      command: /sbin/shutdown -h now	#关机
      when: ansible_distribution == "CentOS"	

2、多条件判断

vi when.yml

- hosts: mysql
  remote_user: root
  tasks:
    - name: "shut down CentOS 7 systems"
      command: /sbin/shutdown -r now
      when:		#这个代表两个条件都符合才会执行这个task
        - ansible_distribution == "CentOS"
        - ansible_distribution_major_version == "7"

3、组条件判断

vi when.yml

- hosts: mysql
  remote_user: root
  tasks:
    - name: "shut down CentOS 6 and Debian 7 systems"
      command: /sbin/shutdown -t now
      when: (ansible_distribution == "CentOS" and ansible_distribution_major_version == "6") or
            (ansible_distribution == "Debian" and ansible_distribution_major_version == "7")

4、自定义变量进行条件测试（version2.9版本之后被移出，无法使用）

vi when.yml
- hosts: all
  vars:
    exist: "True"
  tasks:
  - name: creaet file
    command:  touch /tmp/test.txt
    when: exist | match("True")		#match代表匹配
  - name: delete file
    command:  rm -rf /tmp/test.txt
    when: exist | match("False")	

五、迭代

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

- hosts: webserver
  remote_user: root
  tasks:
    - name: "Install Packages"
      yum: name={{ item }} state=latest
      with_items:	#会轮流把软件都安装好
        - httpd
        - mysql-server
        - php

在webserver查看操作是否成功

也可以自己定义属组，一个对象包含两个属性

- hosts: webserver
  remote_user: root
  tasks:
    - name: "Add users"
      user: name={{ item.name }} state=present groups={{ item.groups }}
      with_items:
        - { name:'test1', groups:'wheel'}
        - { name:'test2', groups:'root'}