初探自动化运维之Ansible三（Playbook）

最新推荐文章于 2023-03-14 09:29:22 发布

radish.-

最新推荐文章于 2023-03-14 09:29:22 发布

阅读量172

点赞数

本文链接：https://blog.csdn.net/weixin_45341507/article/details/103444801

版权

Playbook

1. playbook介绍

在这里插入图片描述

playbook 剧本是由一个或多个“play”组成的列表
play的主要功能在于将预定义的一组主机，装扮成事先通过ansible中的task定义好的角色。Task实际是调用ansible的一个module，将多个play组织在一个playbook中，即可以让它们联合起来，按事先编排机制执行预定义的动作
Playbook 文件是采用YAML语言编写的

2. YAML 语言

2.1 YAMl 语言介绍

YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言，另外Ingydöt Net与Oren Ben-Kiki也是这语言的共同设计者,目前很多软件中采有此格式的文件，如:ubuntu，anisble，docker，k8s等
YAML：YAML Ain’t Markup Language，即YAML不是XML。不过，在开发的这种语言时，YAML的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）
YAML 官方网站：http://www.yaml.org

2.2 YAML 语言特性

YAML的可读性好
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强，扩展性好

2.3 YAML语法简介

+在单一文件第一行，用连续三个连字号“-” 开始，还有选择性的连续三个点号( … )用来表示文件的结尾

次行开始正常写Playbook的内容，一般建议写明该Playbook的功能
使用#号注释代码
缩进必须是统一的，不能空格和tab混用
缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过缩进结合换行来实现的
YAML文件内容是区别大小写的，key/value的值均需大小写敏感
多个k/v可同行写也可换行写，同行使用，分隔
+v可是个字符串，也可是另一个列表
一个完整的代码块功能需最少元素需包括 name 和 task
一个name只能包括一个task
YAML文件扩展名通常为yml或yaml
YAML的语法和其他高阶语言类似，并且可以简单表达清单、散列表、标量等数据结构。其结构(Structure）通过空格来展示，序列（Sequence）里的项用"-“来代表，Map里的键值对用”:"分隔

2.3.1 List列表

列表由多个元素组成，且所有元素前均使用“-”打头
范例：

# A list of tasty fruits
- Apple
- Orange
- Strawberry
- Mango
#[Apple,Orange,Strawberry,Mango]

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

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

2.3.3 三种常见的数据交换格式

在这里插入图片描述

3. Playbook核心元素

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

3.1 hosts 组件

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

[root@localhost ~]# ansible all  --list-hosts
  hosts (2):
    192.168.66.18
    192.168.66.28
[root@localhost ~]# vim /etc/ansible/hosts  # 定义被管理主机配置文件

# If you have multiple hosts following a pattern you can specify
# them like this:

## www[001:006].example.com

# Ex 3: A collection of database servers in the 'dbservers' group

## [dbservers]
## 
## db01.intranet.mydomain.net
## db02.intranet.mydomain.net
## 10.25.1.56
## 10.25.1.57

# Here's another example of host ranges, this time there are no
# leading 0s:

## db-[99:101]-node.example.com
[websrvs]
192.168.66.18 被管理主机

[dbsrvs]
192.168.66.28 被管理主机
"/etc/ansible/hosts" 48L, 1064C

3.2 remote_user 组件

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

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

3.3 task列表和action组件

play的主体部分是task list，task list中有一个或多个task,各个task 按次序逐个在hosts中指定的所有主机上执行，即在所有主机上完成第一个task后，再开始第二个task
task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致
每个task都应该有其name，用于playbook的执行结果输出，建议其内容能清晰地描述任务执行步骤。如果未提供name，则action的结果将用于输出
task两种格式：
(1) action: module arguments
(2) module: arguments 建议使用
- 注意：shell和command模块后面跟命令，而非key=value
  范例：

---
- hosts: websrvs
  remote_user: root
  tasks:
    - name: install httpd
      yum: name=httpd
    - name: start httpd
      service: name=httpd state=started enabled=yes

3.4 其它组件

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

4. ShellScripts VS Playbook 案例

#SHELL脚本实现
#!/bin/bash
# 安装Apache
yum install --quiet -y httpd
# 复制配置文件
cp /tmp/httpd.conf /etc/httpd/conf/httpd.conf
cp/tmp/vhosts.conf /etc/httpd/conf.d/
# 启动Apache，并设置开机启动
systemctl enable --now httpd

# Playbook实现
---
- hosts: websrvs
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

5. playbook 命令

格式：ansible-playbook <filename.yml> ... [options]
常见选项

–check -C #只检测可能会发生的改变，但不真正执行操作
–list-hosts #列出运行任务的主机
–list-tags #列出tag
–list-tasks #列出task
–limit 主机列表 #只针对主机列表中的主机执行
-v -vv -vvv #显示过程

范例:

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

5.1 Playbook 初步

范例：install_httpd.yml

---
#install httpd
- 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/
    - name: start service
      service: name=httpd state=started enaled=yes

范例：remove_httpd.yml

#remove_httpd.yml
---
- hosts: websrvs
  remote_user: root
  
  tasks:
    - name: remove httpd package
      yum: name=httpd state=absent
    - name: remove apache user
      user: name=apache state=absent
    - name: remove data file
      file: name=/etc/httpd state=absent

范例：mysql_user.yml

---
- hosts: dbsrvs
  remote_user: root

  tasks:
    - {name: create group, group: name=mysql system=yes gid=306}
    - name: create user
      user: name=mysql shell=/sbin/nologin system=yes group=mysql uid=306 home=/data/mysql create_home=no

范例：install_nginx.yml

---
# install nginx
- hosts: websrvs
  remote_user: root

  tasks:
  - name: add group nginx
    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: Start Nginx
    service: name=nginx state=started enabled=yes

范例：安装mysql-5.6.46-linux-glibc2.12

[root@ansible ~]#ls -l /data/ansible/files/mysql-5.6.46-linux-glibc2.12-
x86_64.tar.gz
-rw-r--r-- 1 root root 403177622 Dec 4 13:05 /data/ansible/files/mysql-5.6.46-
linux-glibc2.12-x86_64.tar.gz
[root@ansible ~]#cat /data/ansible/files/my.cnf
[mysqld]
socket=/tmp/mysql.sock
user=mysql
symbolic-links=0
datadir=/data/mysql
innodb_file_per_table=1
log-bin
pid-file=/data/mysql/mysqld.pid
[client]
port=3306
socket=/tmp/mysql.sock
[mysqld_safe]
log-error=/var/log/mysqld.log
[root@ansible ~]#cat /data/ansible/files/secure_mysql.sh
#!/bin/bash
/usr/local/mysql/bin/mysql_secure_installation <<EOF
y
magedu
magedu
y
y
y
y
EOF

[root@ansible ~]#cat /data/ansible/install_mysql.yml
---
# install mysql-5.6.46-linux-glibc2.12-x86_64.tar.gz
- hosts: websrvs
  remote_user: root
  tasks:
    - name: install packages
      yum: name=libaio,perl-Data-Dumper,perl-Getopt-Long
    - name: create mysql group
      group: name=mysql gid=306
    - name: create mysql user
      user: name=mysql uid=306 group=mysql shell=/sbin/nologin system=yes create_home=no home=/data/mysql
    - name: copy tar to remote host and file mode
      unarchive: src=/data/ansible/files/mysql-5.6.46-linux-glibc2.12-
x86_64.tar.gz dest=/usr/local/ owner=root group=root
    - name: mkdir /usr/local/mysql
      file: src=/usr/local/mysql-5.6.46-linux-glibc2.12-x86_64
dest=/usr/local/mysql state=link
    - name: data dir
      shell: chdir=/usr/local/mysql/ ./scripts/mysql_install_db --
datadir=/data/mysql --user=mysql
      tags: data
    - name: config my.cnf
      copy: src=/data/ansible/files/my.cnf dest=/etc/my.cnf
     - name: service script
       shell: /bin/cp /usr/local/mysql/support-files/mysql.server
/etc/init.d/mysqld
     - name: enable service
       shell: /etc/init.d/mysqld start;chkconfig --add mysqld;chkconfig mysqld on
       tags: service
     - name: PATH variable
       copy: content='PATH=/usr/local/mysql/bin:$PATH'
dest=/etc/profile.d/mysql.sh
     - name: secure script
       script: /data/ansible/files/secure_mysql.sh
       tags: script

范例：install_mariadb.yml

---
#Installing MariaDB Binary Tarballs
- hosts: dbsrvs
  remote_user: root
  tasks:
    - name: create group
      group: name=mysql gid=27 system=yes
    - name: create user
      user: name=mysql uid=27 system=yes group=mysql shell=/sbin/nologin home=/data/mysql create_home=no
    - name: mkdir datadir
      file: path=/data/mysql owner=mysql group=mysql state=directory
    - name: unarchive package
      unarchive: src=/data/ansible/files/mariadb-10.2.27-linux-x86_64.tar.gz dest=/usr/local/ owner=root group=root
    - name: link
      file: src=/usr/local/mariadb-10.2.27-linux-x86_64 path=/usr/local/mysql state=link
    - name: install database
      shell: chdir=/usr/local/mysql ./scripts/mysql_install_db --
datadir=/data/mysql --user=mysql
    - name: config file
      copy: src=/data/ansible/files/my.cnf dest=/etc/ backup=yes
    - name: service script
      shell: /bin/cp /usr/local/mysql/support-files/mysql.server
/etc/init.d/mysqld
    - name: start service
      service: name=mysqld state=started enabled=yes
    - name: PATH variable
      copy: content='PATH=/usr/local/mysql/bin:$PATH'
dest=/etc/profile.d/mysql.sh

5.2 Playbook中使用handlers和notify

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

案例:

---
- 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   # notify 命名为了 restart httpd
    - name: ensure apache is running
      service: name=httpd state=started enabled=yes
   handlers:  
     - name: restart httpd    # 所以handlers 命名为restart httpd 两者对应 
       service: name=httpd state=restarted

案例:

---
- hosts: websrvs
  remote_user: root
  tasks:
    - name: add group nginx
      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: 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

5.3 Playbook中使用tags组件

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

案例:

vim  httpd.yml
---
# tags example
- 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/
      tags: conf
    - name: start httpd service
      tags: service
      service: name=httpd state=started enabled=yes

ansible-playbook –t conf,service  httpd.yml

5.4 Playbook中使用变量

变量名:仅能由字母、数字和下划线组成，且只能以字母开头
变量定义:
key=value
案例：

http_port=80

变量调用方式：
通过{{ variable_name }} 调用变量，且变量名前后建议加空格，有时用“{{ variable_name }}”才生效
变量来源：
- 1.ansible 的 setup facts 远程主机的所有变量都可直接调用
- 2.通过命令行指定变量，优先级最高
  - ansible-playbook -e varname=value
- 3.在playbook文件中定义
  vars:
  - var1: value1
  - var2: value2
- 4.在独立的变量YAML文件中定义

- hosts: all
  vars_files:
    - vars.yml

5.在 /etc/ansible/hosts 中定义
- 主机(普通)变量:主机组中主机单独定义，优先级高于公共变量
- 组(公共)变量:针对主机组中所有主机定义统一变量
6.在role中定义

5.4.1 使用 setup模块中变量

案例：使用setup变量

---
#var.yml
- hosts: websrvs
remote_user: root
tasks:
 - name: create log file
  file: name=/var/log/ {{ ansible_fqdn }} state=touch
#执行下面语句
# ansible-playbook var.yml

5.4.2 在playbook 命令行中定义变量

范例:

vim var.yml
---
- hosts: websrvs
remote_user: root
tasks:
 - name: install package
  yum: name={{ pkname }} state=present
#执行下面语句
# ansible-playbook –e pkname=httpd var.yml

5.4.3 在playbook文件中定义变量

范例：

vim var2.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 -e "username=user2 groupname=group2” var2.yml

5.4.4 使用变量文件

可以在一个独立的playbook文件中定义变量，在另一个playbook文件中引用变量文件中的变量，比playbook中定义的变量优化级高

vim vars.yml
---
# variables file
pack: vsftpd
service: vsftpd
vim install_app.yml
---
#install app and configure
- hosts: appsrvs
remote_user: root
vars_files:
  - vars.yml
tasks:
  - name: install package
  yum: name={{pack}}
  tags: install
  - name: start service
   service: name={{service}} state=started enabled=yes
handlers:
  - name: restart httpd service
   service: name={{service}} state=restarted

范例：

cat vars2.yml
---
var1: httpd
var2: nginx
   
cat web.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

5.4.5 主机清单文件中定义变量

主机变量：

在inventory 主机清单文件中为指定的主机定义变量以便于在playbook中使用
范例：

[websrvs]
www1.magedu.com http_port=80 maxRequestsPerChild=808
www2.magedu.com http_port=8080 maxRequestsPerChild=909

组（公共）变量：

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

websrvs]
www1.magedu.com
www2.magedu.com
[websrvs:vars]
ntp_server=ntp.magedu.com
nfs_server=nfs.magedu.com

范例：

vim /etc/ansible/hosts
[websrvs]
192.168.0.101 http_port=8080 hname=www1
192.168.0.102 http_port=80   hname=www2
[websvrs:vars]
http_port=808
mark=“-”
[websrvs]
192.168.0.101 http_port=8080 hname=www1
192.168.0.102 http_port=80 hname=www2
ansible websvrs –m hostname –a ‘name={{ hname }}{{ mark }}{{ http_port }}’
bash
#命令行指定变量：
ansible websvrs –e http_port=8000 –m hostname –a   ‘name={{ hname }}{{ mark
}}{{ http_port }}’