Ansible ：YML/Playbook/Template

下载地址：别人写好的playbook:http://galaxy.ansible.com/

YAML语言简介

语法：

• 在单一档案中，可用连续三个连字号(——)区分多个档案。另外，还有选择性的连续三
• 个点号( ... )用来表示档案结尾
• 次行开始正常写Playbook的内容，一般建议写明该Playbook的功能
• 使用#号注释代码
• 缩进必须是统一的，不能空格和tab混用
• 缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过
• 缩进结合换行来实现的
• YAML文件内容是区别大小写的，k/v的值均需大小写敏感
• k/v的值可同行写也可换行写。同行使用:分隔
• v可是个字符串，也可是另一个列表
• 一个完整的代码块功能需最少元素需包括 name: task
• 一个name只能包括一个task
• YAML文件扩展名通常为yml或yaml

List：列表，其所有元素均使用“-”打头

# A list of tasty fruits
- Apple
- Orange
- Strawberry
- Mango

Dictionary：字典，通常由多个key与value构成

# An employee record
name: Example Developer
job: Developer
skill: Elite
也可以将key:value放置于{}中进行表示，用,分隔多个key:value
示例：
---
# An employee record
{name: Example Developer, job: Developer, skill: Elite}

缩进很重要！！！


#hello world yml file
- hosts: dbserver
  remote_user: root
  tasks:
    - name: hello world
      command: /usr/bin/wall hello world

 PlayBook核心元素

• Hosts 执行的远程主机列表
• Tasks 任务集
• Varniables 内置变量或自定义变量在playbook中调用
• Templates 模板，可替换模板文件中的变量并实现一些简单逻辑的文件
• Handlers 和notity结合使用，由特定条件触发的操作，满足条件方才执行，否
• 则不执行
• tags 标签 指定某条任务执行，用于选择运行playbook中的部分代码。ansible
• 具有幂等性，因此会自动跳过没有变化的部分，即便如此，有些代码为测试其
• 确实没有发生变化的时间依然会非常地长。此时，如果确信其没有变化，就可
• 以通过tags跳过此些代码片断
• ansible-playbook –t tagsname useradd.yml

 PlayBook基础组件

Hosts：
　　playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用
户身份执行任务。hosts用于指定要执行指定任务的主机，须事先定义在主机
清单中
可以是如下形式：

one.example.com
one.example.com:two.example.com
192.168.1.50
192.168.1.*

#
- hosts: 192.168.1.50

• Websrvs:dbsrvs 两个组的并集
• Websrvs:&dbsrvs 两个组的交集
• webservers:!phoenix 在websrvs组，但不在dbsrvs组
• 示例: - hosts: websrvs：dbsrvs

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

- hosts: websrvs
 remote_user: root
 tasks:
  - name: test connection
  ping:
  remote_user: magedu
  sudo: yes #默认sudo为root
  sudo_user:wang #sudo为wang

task列表和action

• play的主体部分是task list。task list中的各任务按次序逐个在hosts中指定的所有主机上执行，即在所有主机上完成第一个任务后，再开始第二个任务
• task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致
• 每个task都应该有其name，用于playbook的执行结果输出，建议其内容尽可能清晰地描述任务执行步骤。如果未提供name，则action的结果将用于输出

tasks：任务列表
格式：(1) action: module arguments
　　　(2) module: arguments 建议使用
注意：shell和command模块后面跟命令，而非key=value

• 某任务的状态在运行后为changed时，可通过“notify”通知给相应的 handlers
• 任务可以通过"tags“打标签，而后可在ansible-playbook命令上使用-t指定进 行调用

---
- hosts: dbserver 
#作用主机
  remote_user: root
  #使用的用户
  tasks:
    - name: install httpd
    #安装的描述
      yum: name=httpd
      #模块名及参数
    - name: start httpd
    #安装的描述
      service: name=httpd state=started enabled=yes  
      #模块名及参数

Shell与PlayBook 对比案例

---
- hosts: webserver
remote_user: root
tasks: 
  - name: "安装Apache"
    yum: name=httpd
  - name: "复制配置文件"
    copy: src=/tmp/httpd.conf dest=/etc/httpd/conf/
  - name: "复制配置文件"
    copy: src=/tmp/vhosts.conf dest=/etc/httpd/conf.d/
  - name: "启动Apache,并设置开机启动"
    service: name=httpd state=started enabled=yes

#！/bin/bash
#安装Apache
yum install --quiet -y httpd
#复制配置文件
cp /tmp/httpd.confg /etc/httpd/conf/httpd.conf
cp /tmp/vhosts.conf /etc/httpd/conf.
#启动Apache，并设置开机启动
systemctl enable --now httpd

tasks:
- name: disable selinux
 command: /sbin/setenforce 0

Playbook命令

运行playbook的方式
　　ansible-playbook <filename.yml> ... [options]
常见选项

• --check 只检测可能会发生的改变，但不真正执行操作
• --list-hosts 列出运行任务的主机
• --limit 主机列表 只针对主机列表中的主机执行
• -v 显示过程 -vv -vvv 更详细

ansible-playbook file.yml --check 只检测
ansible-playbook file.yml
ansible-playbook file.yml --limit websrvs

示例：

1、利用pyaybook创建mysql用户：mysql_user.yml

---
- hosts: dbserver
  remote_user: root
  tasks: 
    - name: "创建组"
      group: name=mysql system=yes gid=306
    - name: "创建用户"
      user: name=mysql shell=/sbin/nologin system=yes group=mysql uid=306 home=/data/mysql create_home=no

2、安装nginx

---
#install nginx
- hosts: testserver
  remote_user: root
  #上面那条命令是为了不收集远程主机的信息
  tasks:
    - name: add group nginx
      group: name=nginx state=present
    - name: add user nginx
      user: name=nginx state=present group=nginx
    - name: install nginx
      yum: name=nginx state=present
    - name: start nginx
      service: name=nginx state=started enabled=yes

 Handlers和notify结合使用出发条件

Handlers
       是task列表，这些task与前述的task并没有本质上的不同,用于当关注的资源发生变化时，才会采取一定的操作
       Notify此action可用于在每个play的最后被触发，这样可避免多次有改变发生时每次都执行指定的操作，仅在所有的变化发生完成后一次性地执行指定操作。在notify中列出的操作称为handler，也即notify中调用handler中定义的操作

Playbook中handlers使用

---
- hosts: websrvs
  remote_user: root
  tasks:
   - name: Install httpd
     yum: name=httpd state=present
   - name: Install configure file
     copy: src=files/httpd.conf dest=/etc/httpd/conf/
     notify: restart httpd
     #如果配置文件发生变化，将触发handlers
   - name: ensure apache is running
     service: name=httpd state=started enabled=yes
  handlers:
   - name: restart httpd
     service: name=httpd status=restarted

---
- hosts: webserver
  remote_user: root
  tasks:
    - name: add group nginx
      group: name=nginx state=present
    - name: add user nginx
      user: name=nginx state=present group=nginx
    - name: install nginx
      yum: name=nginx state=present
    - name: config
      copy: src=/root/config.txt dest=/etc/nginx/nginx.conf
      notify:
        - Restart Nginx
        - Check Nginx process
  handlers:
    - name: Restart Nginx
      service: name=nginx state=restarted enabled=yes
    - name: Check Nginx process
      shell: killall -0 nginx &> /tmp/nginx.log

Playbook中tags使用

 在playbook文件中，可以利用tags组件，为特定task指定标签，当在执行playbook时，可以只执行特定tags的task，而3不是整个playbook。

案例：

---
- hosts: websrvs
  remote_user: root

  tasks:
   - name: add group nginx
     tags: user
     user: name=nginx state=present
   - name: add user nginx
     tages: group
     user: name=nginx state=present group=nginx
   - name: Install Nginx
     yum: name=nginx state=present
   - name: config
     copy: src=/root/config.txt dest=/etc/nginx/nginx.conf
     notify:
   - Restart Nginx
   - Check Nginx Process
  handlers:
    - name: Restart Nginx
      service: name=nginx state=restarted enabled=yes
    - name: Check Nginx process
      shell: killall -0 nginx > /tmp/nginx.log

ansible-playbook -t user,group install_nginx.yml

Playbook 中变量的使用

　　变量名：仅能由字母、数字和下划线组成，且只能以字母开头

　　变量来源：

　　　　1、ansible setup facts 远程主机的所有变量都可直接调用（需要在playbook中调用）

　　　　2、在/etc/ansible/hosts中定义

　　　　　　普通变量：主机组中主机单独定义，优先级高于公共变量

　　　　　　公共（组）变量：针对主机组中所有主机定义统一变量

　　　　3、通过命令行指定变量，优先级最高

ansible-playbook –e varname=value

　　　　4、在playbook中定义

vars:
 - var1: value1
 - var2: value2

　　　　5、在独立的变量YAML文件中定义

　　　　6、在role中定义

变量命名：变量名仅能由字母、数字和下划线组成，且只能以字母开头　　　

变量定义：key=value

变量的调用方式：

通过{{ variable_name }} 调用变量，且变量名前后必须有空格，有时用
“{{ variable_name }}”才生效
ansible-playbook –e 选项指定
 ansible-playbook test.yml -e "hosts=www user=magedu"

示例：通过playbook中setup中的变量来创建文件

---
- hosts: webserver
  remote_user: root

  tasks:
    - name: create log file
      file: name=/var/log/{{ ansible_nodename }}.log state=touch

示例：在playbook文件中使用自定义变量

1、ansible-playbook -e "username=user2 groupname=group2” var2.yml   

备注：可再执行playbook时，使用-e参数指定变量，来运行yml，内容中用{{}} 引用次变量

---
- hosts: websrvs
  remote_user: root
  vars:
    - username: user1
    - groupname: group1
  tasks:
    - name: create group
      group: name={{ groupname }} state=present
    - name: create user
      user: name={{ username }} state=present
 

 #ansible-playbook var.yml
 #ansible-playbook -e "username=user2 groupname=group2” var2.yml

示例：使用变量文件

---
#cat vars.yml
#var1: httpd
#var2: nginx
#cat var.yml
- hosts: web
  remote_user: root
  vars_files:
    - vars.yml
  tasks:
    - name: create httpd log
      file: name=/app/{{ var1 }}.log state=touch
    - name: create nginx log
      file: name=/app/{{ var2 }}.log state=touch

主机清单中定义变量

在inventory主机清单文件中为指定的主机定义的变量，方便与在playbook中使用

范例：

---
#/etc/ansible/hosts
[webserver]
www1.baidu.com http_port=80 maxRequestsPerChild=808
www2.baidu.com http_port=8080 maxRequestsPerChild=909

在inventory主机清单文件中赋予给指定组内所有主机上的在playbook中可用的变量

---
#/etc/ansible/hosts
#普通变量
[testserver]
192.168.170.130 http_port=80 hname=www1
192.168.170.131 http_port=8080 hname=www2
#公共（组）变量
[webserver:vars]
mark="_"
[webserver]
192.168.1.100 http_port=8080 hname=www1
192.168.1.200 http_port=80 hname=www2

#ansible webserver -m hostname -a 'name={{ hname }}{{ mark }}{{ http_prot }}'
#修改主机名

Template模板

模板是一个文本文件，可用做为生成模板的模板，切模板可用嵌套jinjia的语法

templates功能：根据模块文件动态生成对应的配置文件 

jinjia2语言还用IMiNLI能否，有下面形式：

• 字符串：使用单引号或双引号
• 数字：整数，浮点数
• 列表：[item1, item2, ...]
• 元组：(item1, item2, ...)
• 字典：{key1:value1, key2:value2, ...}
• 布尔型：true/false

算术运算符：+, -, *, /, //, %, **

比较操作：==, !=, >, >=, <, <=

逻辑运算：and, or, not

流表达式：For If When

templates文件必须存放于templates目录下，且命名为 .j2 结尾

yaml/yml 文件需和templates目录平级，目录结构如下：

./ ├── temnginx.yml

   └── templates

            └── nginx.conf.j2

Templates示例：：利用templates 同步nginx配置文件

准备templates/nginx.conf.j2文件（我做实验把原来的nginx配置渐渐拷贝过来，加了个j2后缀）

---
- hosts: testserver
  remote_user: root
  tasks:
    - name: install nginx
      yum: name=nginx state=present
    - name: template config to remote hosts
      template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
    - name: start nginx serivce
      serivce: name=nginx state=started enabled=yes

tmplates 算术运算

vim nginx.conf.j2
 worker_processes {{ ansible_processor_vcpus**2 }};
 worker_processes {{ ansible_processor_vcpus+2 }}; 

#使用收集的cpu的变量，改变nginx的线程情况，

tmplate中使用流程控制for和if

tmplate中也可以使用流程控制for循环和if条件判断，实现动态生成文件功能

---
- hosts: testserver
  remote_user: root
  vars:
    nginx_vhosts:
      - listen: 8080
  tasks:
    -name: config file
     template: src=nginx.conf.j2 dest=/data/nginx2.conf

#templates /nginx.conf.j2
#类似与python django的模板语言，
{% for vhost in nginx_vhosts %}
  server{
   listen {{ vhost.listen }}
}
{% endfor %}

#最终生成了
server{
  listen 8080
  }

if

---
- hosts: mageduweb
  remote_user: root
  vars:
    nginx_vhosts:
      - web1
      - web2
      - web3
  tasks:
    - name: template config
      template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf

{% for vhost in
nginx_vhosts %}
server {
 listen {{ vhost }}
}
{% endfor %}
#生成结果如下
server {
 listen web1
}
server {
 listen web2
}
server {
 listen web3
}

playbook中的when

条件测试:如果需要根据变量、facts或此前任务的执行结果来做为某task执行与 否的前提时要用到条件测试,通过when语句实现，在task中使用

示例1

tasks:
 - name: "shutdown RedHat flavored systems"
   command: /sbin/shutdown -h now
   when: ansible_os_family == "RedHat

示例2：当操作系统版本是6的话就不执行

---
- hosts: websrvs
  remote_user: root
  tasks:
    - name: add group nginx
      tags: user
      user: name=nginx state=present
    - name: add user nginx
      user: name=nginx state=present group=nginx
    - name: Install Nginx
      yum: name=nginx state=present
    - name: restart Nginx
      service: name=nginx state=restarted
      when: ansible_distribution_major_version == "6"

迭代with_items

• 迭代：当需要重复执行任务时，可以使用迭代机制
• 对迭代项的引用，固定变量名为'item'
• 要是在task中使用with_items给定要迭代的元素列表
• 列表格式：
• 　　字符串
•         字典

示例1

- name: add several 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

示例2：将多个文件进行copy到被控端

---
- hosts: testsrv
  remote_user: root

  tasks:
    - name: Create rsyncd config
      copy: src={{ item }} dest=/etc/{{ item }}
      with_items:
        - rsyncd.secrets
        - rsyncd.conf

- hosts: websrvs
  remote_user: root
  tasks:
    - name: copy file
      copy: src={{ item }} dest=/tmp/{{ item }}
      with_items:
        - file1
        - file2
        - file3
    - name: yum install httpd
      yum: name={{ item }} state=present
      with_items:
        - apr
        - apr-util
        - httpd

示例：迭代嵌套子变量

- hosts: websrvs
  remote_user: root
  tasks:
    - name: add some groups
      group: name={{ item }} state=present
      with_items:
        - group1
        - group2
        - group3
    - name: add some users
      user: name={{ item.name }} group={{ item.group }} state=present
      with_items:
        - { name: 'user1', group: 'group1' }
        - { name: 'user2', group: 'group2' }
        - { name: 'user3', group: 'group3' }