Ansible 的脚本 之playbook 剧本

目录

第一章.playbooks的组成

1.1playbooks的组成部分

1.2运行playbook

1.3定义、引用变量

1.4.指定远程主机sudo切换用户

1.6.when条件判断

1.7.迭代

第二章.Templates模块

2.1.准备模板

2.2.修改主机清单文件

2.3.编写 playbook

第三章.tags 模块

3.1.yaml文件编写

第四章.Roles 模块

简述Ansible角色

4.1.roles 的目录结构：

4.2.roles 内各目录含义解释

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

第五章.编写模块

5.1.编写httpd模块

5.2.编写mysql模块

5.3.编写php模块

5.4.编写roles示例

总结

1.1.工作机制

1.2.执行流程

3.日常模块13个

4.playbooks各部分组成:

5.定义任务

6.roles角色模块

---

第一章.playbooks的组成

1.1playbooks的组成部分

playbooks 本身由以下各部分组成
（1）Tasks：任务，即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行
（2）Variables：变量

（3）Templates：模板

（4）Handlers：处理器，当changed状态条件满足时，（notify）触发执行的操作

（5）Roles：角色

示例：
vim demol.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，从而避免多次重启。

---
- name: first play
  gather_facts: false
  hosts: webservers
  remote_user: root
  tasks:
   - name: test connection
     ping:
   - name: disable selinux
     command: '/sbin/setenforce 0'
     ignore_errors: True
   - name: disable firewalld
     service: name=firewalld state=stopped enabled=no
   - name: install httpd
     yum: name=httpd state=latest
   - name: intall configuration httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/http.conf
     notify: "restart httpd"
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:
   - name: restart httpd
     service: name=httpd state=restarted

1.2运行playbook

ansible-playbook demol.yaml
//补充参数：

-k（–ask-pass）：用来交互输入ssh密码

-K（-ask-become-pass）：用来交互输入sudo密码

-u：指定用户

ansible-playbook demol.yaml --syntax-check    #检查yaml文件的语法是否正确

这里现需要修改下面
ansible-playbook demol.yaml --list-task       #检查tasks任务

 
ansible-playbook demol.yaml --list-hosts      #检查生效的主机

 

 

ansible-playbook demol.yaml --start-at-task='install httpd'     #指定从某个task开始运行

1.3定义、引用变量

- name: second play
  hosts: dbservers
  remote_user: root
  vars:                 #定义变量

   - groupname: ky26                                                   #格式为 key: value

   - username: cxk

  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变量信息

- name: second playbook
  hosts: dbservers
  remote_user: root
  vars:
   - groupname: ky26
   - username: cxk
  tasks:
   - name: create group
     group: name={{groupname}} system=yes gid=110
   - name: create user
     user: name={{username}} system=yes uid=119 group={{groupname}}
   - name: test copy file
     copy: content"{{ansible_default_ipv4}}" dest=/opt/test.txt

 

 

 

在192.168.233.111里检测。tail -2 /etc/passwd

 

ansible-playbook demol2.yaml -e "username=cxk"     #在命令行里定义变量

1.4.指定远程主机sudo切换用户

hosts: dbservers

  remote_user: zhangsan    

       
  become: yes                     #2.6版本以后的参数，之前是sudo，意思为切换用户运行

  become_user: root              #指定sudo用户为root

执行playbook时：ansible-playbook test1.yml -K <密码>
 

1.6.when条件判断

在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。

when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

vim demol3.yaml

- hosts: all

  remote_user: root

  tasks:
   - name: shutdown host 
     command: /sbin/shutdown -r now
     when: ansible_default_ipv4.address == "192.168.233.111"      

                                          #when指令中的变量名不需要手动加上 {{}}

或 

     when: inventory_hostname == "<主机名>"

- hosts: all
  remote_user: root
  tasks:
   - name: shutdown host
     command: /sbin/shutdown -r now
     when: ansible_default_ipv4.address == "192.168.233.111"

 

   
ansible-playbook demol3.yaml

 触发关机重启

1.7.迭代

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

vim demol4.yaml

name: play1
  hosts: dbservers
  gather_facts: false

  tasks: 
    - name: create directories
      file:
        path: "{{item}}"
        state: directory

      with_items:                                                             #等同于 loop:
        - /tmp/test1
        - /tmp/test2

    - 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'}

例一：

- name: play1
  hosts: webservers
  gather_facts: false
  tasks:
   - name: create directories
     file: path={{item}} state=directory
     with_items:
      - /opt/cxk
      - /opt/cnm
      - /opt/zrr

 

ansible-playbook demol4.yaml

 

例二：

- name: play1
  hosts: webservers
  gather_facts: false
  tasks:
   - name: create directories
     file: path={{item}} state=directory
     with_items:
      - /opt/cxk
      - /opt/cnm
   - name: add users
     user: name={{item.name}} state=present groups={{item.groups}}
     with_items:
      - name: money
        groups: wheel
      - name: wahaha
        groups: root

 

 

 

第二章.Templates模块

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

2.1.准备模板

先准备一个以 .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行，修改

 

2.2.修改主机清单文件

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

vim /etc/ansible/hosts       

[webservers]
192.168.233.111 http_port=192.168.233.111:80 server_name=www.ky26.com:80 root_dir=/etc/httpd/htdocs

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

2.3.编写 playbook

vim demol6.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
     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 demol6.yaml

 

注！

第三章.tags 模块

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

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

3.1.yaml文件编写

vim demol7.yaml

hosts: demol7
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags:
      - cxk     #可自定义
    - name: touch file
      file: path=/opt/testhost state=touch
      tags:
      - always    #表示始终要运行的代码

---
- hosts: webservers
  remote_user: root
  tasks:
   - name: copy host file
     copy: src=/etc/hosts dest=/opt/host
     tags:
      - xxoo
   - name: touch file
     file: path=/opt/testhost state=touch

ansible-playbook webhosts.yaml --tags="xxoo"

 

vim dbhosts.yaml

- hosts: dbbservers
  remote_user: root
  tasks:
   - name: copy host file
     copy: src=/etc/hosts dest=/opt/hosts
     tags:
      - only
   - name: touch file
     file: path=/opt/testhost state=touch

 

vim demol8.yaml

---
- hosts: webservers
  remote_user: root
  tasks:
   - name: copy host file
     copy: src=/etc/hosts dest=/opt/host
     tags:
      - haha
   - name: touch file
     file: path=/opt/testss stste=touch
     tags:
      - always
   - name: touch dir
     file: path=/opt/ceshi state=directory
     tags:
      - ceshi

ansible-playbook demol8.yaml --tags="haha"
//分别去两台被管理主机上去查看文件创建情况

第四章.Roles 模块

Ansible为了层次化、结构化地组织Playbook，使用了角色（roles），roles可以根据层次型结构自动装载变量文件、task以及handlers等。简单来讲，roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中，并可以便捷地include它们。roles一般用于基于主机构建服务的场景中，但也可以用于构建守护进程等场景中。
 

简述Ansible角色

数据中心有各种不同类型的主机。如web服务器、数据库服务器，基于开发环境的服务器。随着时间的推移，具有处理所有这些情况的任务和人员的Ansible playbook将变得庞大而复杂。

角色允许将复杂的剧本组织成独立的、更小的剧本和文件

角色提供了一种从外部文件加载任务、处理程序和变量的方法。

角色也可关联和引用静态的文件和模板

角色可以编写成满足普通用途需求，并且能被重复利用.

定义角色的文件具有特定的名称，并以严格的目录结构进行组织.

4.1.roles 的目录结构：

cd /etc/ansible/

tree roles/

roles/
├── web/                   #可以自定义，下面时不能自定义的，固定格式
│   ├── files/
│   ├── templates/
│   ├── tasks/
│   ├── handlers/
│   ├── vars/
│   ├── defaults/
│   └── meta/
└── db/                       #可以自定义，下面时不能自定义的，固定格式
    ├── files/
    ├── templates/
    ├── tasks/
    ├── handlers/
    ├── vars/
    ├── defaults/
    └── meta/

4.2.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 文件，用于定义此角色的特殊设定及其依赖关系。

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

（1）创建以 roles 命名的目录
mkdir /etc/ansible/roles/ -p    #yum装完默认就有

（2）创建全局变量目录（可选）
mkdir /etc/ansible/group_vars/ -p
touch /etc/ansible/group_vars/all     #文件名自己定义，引用的时候注意

（3）在 roles 目录中分别创建以各角色名称命令的目录，如 httpd、mysql
mkdir /etc/ansible/roles/httpd
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）在每个角色的 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
cd /etc/ansible
ansible-playbook site.yml
 

示例：

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

第五章.编写模块

5.1.编写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

 

5.2.编写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

 

5.3.编写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

 

5.4.编写roles示例

vim /etc/ansible/site.yml

---
 - hosts: webservers
   remote_user: root
   roles:
    - httpd
    - mysql
    - php

 

cd /etc/ansible

ansible-playbook site.yml

 

 

总结

1.1.工作机制

ansible 核心程序

hostinventory:记录管理主机信息，包括端口，密码，ip等

coremodules: 核心横块，是通过调用核心模块来完成管理任务

custmodules: 自定义模块 ，完成核心模块无法完成的功能 (支持多钟语言)

playbooks: 剧本。yaml格式文件，来把多个任务定义在一个yaml文件中

connectionplugins: 连接对端功能 (连接插件)。ansible 和 各主机 (host) 通信使用

1.2.执行流程

1.加载enable自己的配置文件 他的文件默认 (/etc/anible/ansible.cfg)

2.查找对应的主机配置清单 (文件)，找到要执行的主机或组

3.加载对应的模块文件，如 user command group cron 等

4.通过ansibel将模块或命令对应的脚本 (py) 并且将我们的文件传输至远程主机(服务器)

5.对应执行的用户的家目录 目录路劲 anible/tmp/xxx.py 文件目录 (vue）

6.给文件 +x 执行权限

7.执行并返回结果

8.删除临时py文件退出了 (sleep 0)

3.日常模块13个

command

shell

yum

user

group

copy

file

hostname

setup

ping

service/systemd

script

cron

4.playbooks各部分组成:

tasks:任务

Variables:变量

Templates:横板
Handlers:处理器         当整个任务changed状态条件满足的时候            notify触发执行操作

roles: 角色

操作当中的一些规则

---                                          #yaml文件开头,可省略

gather_fact false                      #setup中   收集主机信息

remote_user                            #主机上的执行用户的任务

hosts:                                       # 主机清单中的 主机组                组

5.定义任务

引用变量

when条件判断1=1 

迭代 item  with_items: -{name: ‘hangsan' ,greoup: 'lisi'}

templates模块      jinja       通过httpd.conf.j2         监听（变量）    服务名（变量名）

tags模块              zhangsan    tags             lisi     always       加了always一定会触发

6.roles角色模块

角色名称	web
ansible指定目录的模块	files:存放 copy script模块调用文件 templates:存放 jinjia2模板   从templates模板中自动寻找 jinjia2模板文件 tasks: 定义角色的任务列表  包含一个main.yml文件 也可以使用include  调用其他的目录的tasks文件 vars 角色使用的变量 包含一个main.yml文件 defaults 定义当前角色 设定默认变量 包含一个main.yml文件 meta 定义角色特殊设定 以及依赖关系 包含一个main.yml文件 handlers 定义角色触发执行条件的操作包含一个main.yml文件