ansible的脚本——playbook剧本

hei-tui2023-11-01 20:34

目录

playbook剧本

1、简介

2、playbook的构成成分

3、palybook的编写注意事项

1）task任务的模块语法格式

[2）with_items 和 vars 的语法格式](#2）with_items 和 vars 的语法格式)

3）运行playbook

4）运行palybook的参数补充

4、定义、引用变量

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

6、when条件判断

7、迭代（循环）

[Templates 模块](#Templates 模块)

[1、先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量](#1、先准备一个以 .j2 为后缀的 template 模板文件，设置引用的变量)

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

[3、编写 playbook](#3、编写 playbook)

[tags 模块](#tags 模块)

[Roles 模块](#Roles 模块)

[1、roles 的目录结构](#1、roles 的目录结构)

[2、roles 内各目录含义解释](#2、roles 内各目录含义解释)

[3、在一个 playbook 中使用 roles 的步骤](#3、在一个 playbook 中使用 roles 的步骤)

[1）创建以 roles 命名的目录](#1）创建以 roles 命名的目录)

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

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

4）在每个角色命名的目录中分别创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建

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

[6）修改 site.yml 文件，针对不同主机去调用不同的角色](#6）修改 site.yml 文件，针对不同主机去调用不同的角色)

[7）运行 ansible-playbook](#7）运行 ansible-playbook)

[4、示例：编写 "LAMP" Role模式的playbook](#4、示例：编写 “LAMP” Role模式的playbook)

[1）在 roles 目录中创建以lamp为角色名称命名的目录](#1）在 roles 目录中创建以lamp为角色名称命名的目录)

2）在lamp角色命名的目录中分别创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建

[3）在lamp角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名](#3）在lamp角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名)

4）编写httpd模块

5）编写mysql模块

6）编写php模块

7）编写roles示例

8）运行playbook，看结果

playbook剧本

1、简介

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

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

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

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

2、playbook的构成成分

（1）Tasks：任务，即通过 task 调用 ansible 的模板将多个操作组织在一个 playbook 中运行

（2）Variables：变量

（3）Templates：模板

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

（5）Roles：角色

3、palybook的编写注意事项

  • 一个play最开始需要使用**"---"三条杠**开头，以表明这是一个yaml文件，可省略

  • 次行开始正常写Playbook的内容，一般建议写明该Playbook的功能;

  • 可以使用**#号**注释代码；

  • 缩进必须是统一的，不能使用tab键；

  • 缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过缩进结合换行来实现的；

  • YAML文件内容是区分大小写 的，key/value的值均需大小写敏感；

  • 多个key/value可同行写也可换行写，同行使用**","逗号**分隔；

  • 一个完整的代码块功能需最少元素需包括 name 和 task；

  • 一个name只能包括一个task；

  • 每个冒号":" 后面均需要有个空格，然后再跟值，否则不生效

  • YAML文件扩展名通常为yml或yaml。

    vim XXX.yaml XXX.yml

    • name: 自定义playbook的名称 #指定playbook的名称
      hosts: all | webservers | dbservers #指定主机组，all代表所有主机组
      remote_user: root #指定执行用户，一般不建议指定root用户
      gather_facts: true|false #定义是否要收集远程主机的facts信息
      vars: #自定义变量(仅在当前play中有效)
      • 变量名1: 值
      • 变量名2: 值
        ...
        tasks: #定义tasks普通任务列表，默认从上往下依次执行
      • name: #定义任务的名称
        模块名: 模块参数=值 #定义每个任务要使用的模块和参数(键值对格式)
      • name:
        模块名: 模块参数=值
        ignore_errors: true #忽略任务的失败
      • name:
        模块名: 模块参数=值
        notify: 任务名 #定义此task任务changed状态时要触发的任务名
      • name:
        模块名: 模块参数=值
        when: #定义条件表达式(== != > < >= <=)，条件成立时执行此task任务，否则不执行任务
      • name:
        模块名: 模块参数
        with_items: #定义循环列表
        handlers: #定义handlers处理器任务列表，task任务都执行完后再执行handlers任务
      • name: 任务名 #定义notify触发的任务名
        模块名: 模块参数

示例：使用palybook安装nginx

1）task任务的模块语法格式

横向格式：
模块名: 参数1=值 参数2={{变量名}} ...

纵向格式：
模块名:
  参数1: 值
  参数2: "{{变量名}}"
  ...

2）with_items 和 vars 的语法格式

横向格式：
with_items: ["值1", "值2", "值3", ...]

值为对象(键值对字段)时：
with_items:
- {key1: "值1", key2: "值2"}
- {key1: "值3", key2: "值4"}
...

纵向格式：
with_items:
- 值1
- 值2
- 值3
...

值为对象(键值对字段)时：
with_items:
- key1: "值1"
  key2: "值2"
- key1: "值3"
  key2: "值4"
...

3）运行playbook

ansible-playbook XXX.yaml

4）运行palybook的参数补充

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

4、定义、引用变量

- 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"     #在命令行里定义变量

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

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

6、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.3.102"      #when指令中的变量名不需要手动加上 {{}}
或 
     when: inventory_hostname == "<主机名>"
	
ansible-playbook test2.yaml

7、迭代（循环）

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

im 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 ]


- 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

Templates 模块

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

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、修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量

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

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

3、编写 playbook

vim 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=/data/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

tags 模块

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

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

再次强调：编写yaml文件时，格式很重要，缩进也很重要，有时候报错就是因为格式的问题

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"    #执行标签为only的，但是always标签的也会执行

在被管理的主机查看结果

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实现代码重复被调用。

1、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/

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 文件，用于定义此角色的元数据信息及其依赖关系。

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

4、示例：编写 "LAMP" Role模式的playbook

1）在 roles 目录中创建以lamp为角色名称命名的目录

mkdir /etc/ansible/roles/httpd
mkdir /etc/ansible/roles/mysql
mkdir /etc/ansible/roles/php

2）在lamp角色命名的目录中分别创建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}
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta}

3）在lamp角色的 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
touch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml

4）编写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）编写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

6）编写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

7）编写roles示例

vim /etc/ansible/site.yml
---
- hosts: webservers
  remote_user: root
  roles:
   - httpd
   - mysql
   - php

8）运行playbook，看结果

cd /etc/ansible
ansible-playbook site.yml
相关推荐
大风吹PP凉2 天前
38配置管理工具（如Ansible、Puppet、Chef）
linux·运维·服务器·ansible·puppet
IT-民工211103 天前
Ansible剧本检测Windows防火墙状态
linux·运维·windows·自动化·ansible
腾科张老师3 天前
为什么要使用Ansible实现Linux管理自动化？
linux·网络·学习·自动化·ansible
脱了格子衬衫4 天前
linux安装ansible
linux·运维·ansible
ccnnlxc4 天前
网站架构知识之Ansible剧本（day022）
ansible
jyan_敬言6 天前
【Linux】Ansible集中化运维工具（详解）安装、常用模块、playbook脚本
android·linux·运维·服务器·c语言·数据结构·ansible
ccnnlxc6 天前
网站架构知识之Ansible进阶2（day023）
ansible
ccnnlxc6 天前
网站架构知识之Ansible进阶（day022）
linux·服务器·ansible
咕噜Yuki06096 天前
RHCE 8.0考试指南：使用Ansible进行自动化管理
运维·自动化·ansible·rhce考试·职业技能认证·rhce8.0
赶紧回家去6 天前
ansible进阶功能
ansible
热门推荐
01RAG 实践- Ollama+RagFlow 部署本地知识库02Ubuntu 20.04使用Livox mid 360 测试 FAST_LIO03【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总04聊聊 Python 中的同步原语，为什么有了 GIL 还需要同步原语05全面解析：构建基于深度学习的安全帽检测系统（UI界面+YOLO代码+数据集）06组基轨迹建模 GBTM的介绍与实现（Stata 或 R）07好数（蓝桥杯）08文件或文件夹名称中有空格如何批量去除09基于YOLOv10深度学习的CT扫描图像肾结石智能检测系统【python源码+Pyqt5界面+数据集+训练代码】深度学习实战、目标检测10Unity中PICO实现 隔空取物 和 接触抓取物体