Ansible--playbook剧本

目录

一、playbook：

playbook的组成：

palybook的编写注意事项

二、playbook的编写格式（示例）

[2.1 编写yaml文件](#2.1 编写yaml文件)

[2.2 定义、引用变量](#2.2 定义、引用变量)

[2.3 指定远程主机sudo切换用户](#2.3 指定远程主机sudo切换用户)

[2.4 when条件判断](#2.4 when条件判断)

[2.5 迭代](#2.5 迭代)

[2.6 Templates 模块](#2.6 Templates 模块)

[2.7 tags 模块](#2.7 tags 模块)

[2.8 Roles 模块](#2.8 Roles 模块)

[1. roles 内各目录含义解释：](#1. roles 内各目录含义解释：)

[2. 在一个 playbook 中使用 roles 的步骤：](#2. 在一个 playbook 中使用 roles 的步骤：)

[3. 示例：](#3. 示例：)

---

一、playbook：

playbook剧本是用于批量操作大量主机的脚本，就是将大量的控制指令，集中在一起按顺序执行；与shell脚本、和存储过程有异曲同工之妙。

playbook中有一个或多个play，play的主要功能在于将预定义的一组主机，装扮成事先通过ansible中的task定义好的角色。

Task实际是调用ansible的一个module，将多个play组织在一个playbook中，即可以让它们联合起来，按事先编排的机制执行预定义的动作

Playbook 文件是采用YAML格式编写的。

playbook的组成：

• Tasks：任务，即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行
• Variables：变量
• Templates：模板
• Handlers：处理器，当changed状态条件满足时，（notify）触发执行的操作
• Roles：角色

palybook的编写注意事项

• 一个play最开始需要使用**"---"三条杠开头**，以表明这是一个yaml文件，可省略
• 次行开始正常写Playbook的内容，一般建议写明该Playbook的功能;
• 可以使用**#号**注释代码；
• 缩进必须是统一的，不能使用tab键；
• 缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过缩进结合换行来实现的；
• YAML文件内容是区分大小写 的，key/value的值均需大小写敏感；
• 多个key/value可同行写也可换行写，同行使用","逗号分隔；
• 一个完整的代码块功能需最少元素需包括 name 和 task；
• 一个name只能包括一个task；
• 每个冒号 ":"后面均需要有个空格，然后再跟值，否则不生效
• YAML文件扩展名通常为yml或yaml。

二、playbook的编写格式（示例）

playbook基于yaml语言编写

2.1 编写yaml文件

//示例：
vim test1.yaml
---     #yaml文件以---开头，以表明这是一个yaml文件，可省略
- name: first play     #定义一个play的名称，可省略
  gather_facts: false    #设置不进行facts信息收集，这可以加快执行速度，可省略
  hosts: webservers    #指定要执行任务的被管理主机组，如多个主机组用冒号分隔
  remote_user: root    #指定被管理主机上执行任务的用户
  tasks:     #定义任务列表，任务列表中的各任务按次序逐个在hosts中指定的主机上执行
   - name: test connection    #自定义任务名称
     ping:     #使用 module: [options] 格式来定义一个任务
   - name: disable selinux
     command: '/sbin/setenforce 0'    #command模块和shell模块无需使用key=value格式
     ignore_errors: True     #如执行命令的返回值不为0，就会报错，tasks停止，可使用ignore_errors忽略失败的任务
   - name: disable firewalld
     service: name=firewalld state=stopped    #使用 module: options 格式来定义任务，option使用key=value格式
   - name: install httpd
     yum: name=httpd state=latest
   - name: install configuration file for httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf    #这里需要一个事先准备好的/opt/httpd.conf文件
     notify: "restart httpd"    #如以上操作后为changed的状态时，会通过notify指定的名称触发对应名称的handlers操作
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:     #handlers中定义的就是任务，此处handlers中的任务使用的是service模块
   - name: restart httpd    #notify和handlers中任务的名称必须一致
     service: name=httpd state=restarted
##Ansible在执行完某个任务之后并不会立即去执行对应的handler，而是在当前play中所有普通任务都执行完后再去执行handler，这样的好处是可以多次触发notify，但最后只执行一次对应的handler，从而避免多次重启。

• 运行playbook

  ansible-playbook test1.yaml
  //补充参数：
  -k（--ask-pass）：用来交互输入ssh密码
  -K（-ask-become-pass）：用来交互输入sudo密码
  -u：指定用户
  ansible-playbook test1.yaml --syntax-check #检查yaml文件的语法是否正确
  ansible-playbook test1.yaml --list-task #检查tasks任务
  ansible-playbook test1.yaml --list-hosts #检查生效的主机
  ansible-playbook test1.yaml --start-at-task='install httpd' #指定从某个task开始运行

2.2 定义、引用变量

- name: second play
  hosts: dbservers
  remote_user: root
  vars:                 #定义变量
   - groupname: mysql   #格式为 key: value
   - username: nginx
  tasks:
   - name: create group
     group: name={{groupname}} system=yes gid=306    #使用 {{key}} 引用变量的值
   - name: create user
     user: name={{username}} uid=306 group={{groupname}} 
   - name: copy file
     copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt    #在setup模块中可以获取facts变量信息
 
 
ansible-playbook test1.yaml -e "username=nginx"     #在命令行里定义变量

2.3 指定远程主机sudo切换用户

---
- hosts: dbservers
  remote_user: zhangsan            
  become: yes	                 #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_user: root              #指定sudo用户为root
执行playbook时：ansible-playbook test1.yml -k -K 

2.4 when条件判断

在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。
 
//when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务
vim test2.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: shutdown host 
     command: /sbin/shutdown -r now
     when: ansible_default_ipv4.address == "192.168.30.100"      #when指令中的变量名不需要手动加上 {{}}
或 
     when: inventory_hostname == "<主机名>"
	
ansible-playbook test2.yaml

2.5 迭代

Ansible提供了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。

vim test3.yaml
---
- name: play1
  hosts: dbservers
  gather_facts: false
  tasks: 
    - name: create file
      file:
        path: "{{item}}"
        state: touch
      with_items: [ /opt/a, /opt/b, /opt/c, /opt/d ]
##定义  /opt/a, /opt/b, /opt/c, /opt/d 这些目录，使用file模块创建文件
 
- name: play2
  hosts: dbservers
  gather_facts: false		
  vars:
    test:
    - /tmp/test1
    - /tmp/test2
    - /tmp/test3
    - /tmp/test4
  tasks: 
    - name: create directories
      file:
        path: "{{item}}"
        state: directory
      with_items: "{{test}}"
##纵写格式
 
- name: play3
  hosts: dbservers
  gather_facts: false
  tasks:
    - name: add users
      user: name={{item.name}} state=present groups={{item.groups}}
      with_items:
        - name: test1         ##一个-表示一组值
          groups: wheel
        - name: test2
          groups: root
或
      with_items:
        - {name: 'test1', groups: 'wheel'}
        - {name: 'test2', groups: 'root'}    ##横写格式
 
ansible-playbook test3.yaml

2.6 Templates 模块

Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件，可以看作是一个编译过的模板文件，用来产生目标文本，传递Python的变量给模板去替换模板中的标记。

• 先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量

  cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2

  vim /opt/httpd.conf.j2
  Listen {{http_port}} #42行，修改
  ServerName {{server_name}} #95行，修改
  DocumentRoot "{{root_dir}}" #119行，修改

• 修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量

  vim /etc/ansible/hosts
  [webservers]
  192.168.30.14 http_port=192.168.30.14:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs

  [dbservers]
  192.168.30.15 http_port=192.168.30.15:80 server_name=www.benet.com:80 root_dir=/etc/httpd/htdocs

• 编写 playbook

  im apache.yaml

  • hosts: all
    remote_user: root
    vars:
    • package: httpd
    • service: httpd
      tasks:
    • name: install httpd package
      yum: name={{package}} state=latest
    • name: install configure file
      template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf #使用template模板
      notify:
      • restart httpd
    • name: create root dir
      file: path=/etc/httpd/htdocs state=directory
    • name: start httpd server
      service: name={{service}} enabled=true state=started
      handlers:
    • name: restart httpd
      service: name={{service}} state=restarted

  ansible-playbook apache.yaml

2.7 tags 模块

可以在一个playbook中为某个或某些任务定义"标签"，在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。

playbook还提供了一个特殊的tags为always。作用就是当使用always作为tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。

vim webhosts.yaml
---
- hosts: webservers
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags:
      - only     #可自定义
    - name: touch file
      file: path=/opt/testhost state=touch
	  tags:
	  - always    #表示始终要运行的代码
 
ansible-playbook webhosts.yaml --tags="only"
 
vim dbhosts.yaml
---
- hosts: dbservers
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags:
        - only
    - name: touch file
      file: path=/opt/testhost state=touch
 
 
ansible-playbook dbhosts.yaml --tags="only"
//分别去两台被管理主机上去查看文件创建情况

2.8 Roles 模块

• roles用于层次性、结构化地组织playbook。roles能够根据层次型结构自动装载变量文件、tasks以及handlers等。要使用roles只需要在playbook中使用include指令引入即可。
• 简单来讲，roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中，并可以便捷的include它们的一种机制。roles一般用于基于主机构建服务的场景中，但也可以是用于构建守护进程等场景中。主要使用场景代码复用度较高的情况下。
• 假如我们现在有3个被管理主机，第一个要配置成httpd，第二个要配置成haproxy服务器，第三个要配置成MySQL（mariadb）服务器。我们如何来定义playbook？
• 第一个play用到第一个主机上，用来构建httpd，第二个play用到第二个主机上，用来构建haproxy。这些个play定义在playbook中比较麻烦，将来也不利于模块化调用，不利于多次调用。比如说后来又加进来一个主机，这第3个主机既是httpd服务器，又是haproxy服务器，我们只能写第3个play，上面写上安装httpd和haproxy。这样playbook中的代码就重复了。
• 为了避免代码重复，可以定义一个角色叫httpd，第二个角色叫haproxy，并使用roles实现代码重复被调用。

//roles 的目录结构：

cd /etc/ansible/

tree roles/

roles/

├── web/ #相当于 playbook 中的 每一个 play 主题

│ ├── files/

│ ├── templates/

│ ├── tasks/

│ ├── handlers/

│ ├── vars/

│ ├── defaults/

│ └── meta/

└── db/

├── files/

├── templates/

├── tasks/

├── handlers/

├── vars/

├── defaults/

└── meta/

1. roles 内各目录含义解释：

●files
用来存放由 copy 模块或 script 模块调用的文件。

●templates
用来存放 jinjia2 模板，template 模块会自动在此目录中寻找 jinjia2 模板文件。

●tasks
此目录应当包含一个 main.yml 文件，用于定义此角色的任务列表，此文件可以使用 include 包含其它的位于此目录的 task 文件。

●handlers
此目录应当包含一个 main.yml 文件，用于定义此角色中触发条件时执行的动作。

●vars
此目录应当包含一个 main.yml 文件，用于定义此角色用到的变量。

●defaults
此目录应当包含一个 main.yml 文件，用于为当前角色设定默认变量。 这些变量具有所有可用变量中最低的优先级，并且可以很容易地被任何其他变量覆盖。所以生产中我们一般不在这里定义变量

●meta
此目录应当包含一个 main.yml 文件，用于定义此角色的元数据信息及其依赖关系。

2. 在一个 playbook 中使用 roles 的步骤：

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

mkdir /etc/ansible/roles/ -p #yum装完默认就有

（2）创建全局变量目录（可选）

1. mkdir /etc/ansible/group_vars/ -p

2. touch /etc/ansible/group_vars/all #文件名自己定义，引用的时候注意

（3）在 roles 目录中分别创建以各角色名称命名的目录，如 httpd、mysql

1. mkdir /etc/ansible/roles/httpd

2. mkdir /etc/ansible/roles/mysql

（4）在每个角色命名的目录中分别创建目录

创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建

mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta}
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta}

（5）创建 main.yml 文件

在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名

touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml

（6）修改 site.yml 文件，针对不同主机去调用不同的角色

**vim /etc/ansible/site.yml

• hosts: webservers
  remote_user: root
  roles:
• httpd
• hosts: dbservers
  remote_user: root
  roles:
• mysql**

（7）运行 ansible-playbook

1. cd /etc/ansible

2. ansible-playbook site.yml

3. 示例：

mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta} -p
touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml

• 编写httpd模块

**写一个简单的tasks/main.yml
vim /etc/ansible/roles/httpd/tasks/main.yml

• name: install apache
  yum: name={{pkg}} state=latest
• name: start apache
  service: enabled=true name={{svc}} state=started
  //定义变量：可以定义在全局变量中，也可以定义在roles角色变量中，一般定义在角色变量中
  vim /etc/ansible/roles/httpd/vars/main.yml
  pkg: httpd
  svc: httpd**

• 编写mysql模块

**vim /etc/ansible/roles/mysql/tasks/main.yml

• name: install mysql
  yum: name={{pkg}} state=latest
• name: start mysql
  service: enabled=true name={{svc}} state=started
  vim /etc/ansible/roles/mysql/vars/main.yml
  pkg:
• mariadb
• mariadb-server
  svc: mariadb**

• 编写php模块

**vim /etc/ansible/roles/php/tasks/main.yml

• name: install php
  yum: name={{pkg}} state=latest
• name: start php-fpm
  service: enabled=true name={{svc}} state=started
  vim /etc/ansible/roles/php/vars/main.yml
  pkg:
• php
• php-fpm
  svc: php-fpm**

• 编写roles示例

**vim /etc/ansible/site.yml

• hosts: webservers
  remote_user: root
  roles:
• httpd
• mysql
• php
  cd /etc/ansible
  ansible-playbook site.yml**