ansible 深入介绍之 主机清单与playbook

目录​​​​​​​

一   inventory 主机清单

1，主机清单 是什么

2，主机清单 定义方式

2.1 自定义主机端口

2.2 定义 范围ip 地址

2.3  定义  拥有相似的主机名

3， inventory 中的变量

3.1 常见 变量

3.2  主机变量

3.3 组变量

3.4  组嵌套

二      Ansible 的脚本 --- playbook 剧本

1，playbook 是什么

2，playbooks 组成

3， 深入理解 Handlers 与notify

4，yaml 语言   写法示例

5， 运行playbook 指令介绍

5.1 补充参数

5.2 检查机制

5.3  指定从某个task开始运行

三     playbook 示例

1，  playbook 安装httpd

2  playbook定义、引用变量

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

4  when条件判断

4. 1 when 应用场景

4.2  演示

 5   迭代

5.1 示例1 创建多个文件或目录

5.2  示例2  创建多个账号

6    Templates 模块

7.1  Templates 模块 工作原理

7.2  为什么用 Templates 模块  而不是直接用vars

7.3   演示 修改远程主机的httpd配置文件​​​​​​​

8，   tags 模块

8.1 tags 模块 介绍

8.2 tags 模块 演示

9    Roles 模块

9.1  Roles 是什么

9.2 roles 内各目录含义解释

9.3  角色的用途

9.4  角色的优势

9.5  在一个 playbook 中使用 roles 的步骤

9.6   role 模块 演示 安装lamp(yum版)

十    总结

---

一   inventory 主机清单

1，主机清单 是什么

用于存储需要管理的 远程主机的相关信息

Inventory支持对主机进行分组，每个组内可以定义多个主机，每个主机都可以定义在任何一个或多个主机组内。
 

2，主机清单 定义方式

vim /etc/ansible/hosts

2.1 自定义主机端口

[webservers]                    # 组名 自己设置
192.168.10.14:2222        #冒号后定义远程连接端口，默认是 ssh 的 22 端口

2.2 定义 范围ip 地址

[webservers]

192.168.10.1[2:5]

这条记录实际上代表了以下四个IP地址：

• 192.168.10.12
• 192.168.10.13
• 192.168.10.14
• 192.168.10.15

这样的写法可以让Ansible能够便捷地管理一个IP地址段内的多台主机，而无需逐一列出它们

2.3  定义  拥有相似的主机名

[dbservers]
db-[a:f].example.org	#支持匹配 a~f

[dbservers] 是一个主机组的名称，表示属于这个组的所有主机都是数据库服务器

将会匹配所有主机名形如 db-a.example.org, db-b.example.org, ..., db-f.example.org 的数据库服务器，即任何以 "db-" 开头，紧接着是 a 到 f 之间任意字符，最后以 ".example.org" 结尾的主机

3， inventory 中的变量

3.1 常见 变量

Inventory变量名	含义
ansible_host	ansible连接节点时的IP地址
ansible_port	连接对方的端口号，ssh连接时默认为22
ansible_user	连接对方主机时使用的主机名。不指定时，将使用执行ansible或ansible-playbook命令的用户
ansible_password	连接时的用户的ssh密码，仅在未使用密钥对验证的情况下有效
ansible_ssh_private_key_file	指定密钥认证ssh连接时的私钥文件
ansible_ssh_common_args	提供给ssh、sftp、scp命令的额外参数
ansible_become	允许进行权限提升
ansible_become_method	指定提升权限的方式，例如可使用sudo/su/runas等方式
ansible_become_user	提升为哪个用户的权限，默认提升为root
ansible_become_password	提升为指定用户权限时的密码

3.2  主机变量

代码展示

[webservers]
192.168.10.14 ansible_port=22 ansible_user=root ansible_password=abc1234

具体演示：

3.3 组变量

代码展示：

[webservers:vars]			#表示为 webservers 组内所有主机定义变量
ansible_user=root
ansible_password=abc1234

[all:vars]					#表示为所有组内的所有主机定义变量
ansible_port=22

具体演示：

3.4  组嵌套

代码展示

[nginx]
192.168.10.20
192.168.10.21
192.168.10.22

[apache]
192.168.10.3[0:3]

[webs:children]		#表示为 webs 主机组中包含了 nginx 组和 apache 组内的所有主机
nginx
apache

具体演示

二      Ansible 的脚本 --- playbook 剧本

1，playbook 是什么

就是ansible 的配置文件 yml 语言

你想要做的所有的对远程主机的 操作 放到其中

2，playbooks 组成

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

3， 深入理解 Handlers 与notify

notify 的概念

notify 可以理解为一个信号或触发器。当你在一个任务（task）中使用 notify，你实际上是告诉Ansible：“如果这个任务导致某些事情发生了改变，请记住在所有常规任务执行完毕后，执行我指定的处理程序（handler）”。

handlers 的概念

handlers 类似于常规任务（tasks），但它们默认不会自动执行，而是等待被 notify 从其他任务触发。你可以把 handlers 看作是“按需执行”的特殊任务列表，通常用于执行诸如服务重启、日志旋转等操作，这些操作通常不需要频繁执行，只在某些条件满足时才

执行流程:

Ansible首先执行所有的常规任务。

如果任何任务通过 notify 触发了handler，Ansible会记录下来但不立即执行。

所有任务执行完毕后，Ansible检查是否有handler被通知执行，如果有，则按照它们在 handlers 部分定义的顺序依次执行。

意义：

这样，即使有多个任务影响到服务需要重启，服务也只会被重启一次，且是在所有相关配置变更都完成之后，提高了效率并减少了不必要的服务中断次数。这就是 notify 和 handlers 最直观且常用的一个场景

4，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，从而避免多次重启。

注意 如果 开启 这个    gather_facts: false  会加快速度，但是也 会导致识别不了 变量

5， 运行playbook 指令介绍

ansible-playbook test1.yaml

5.1 补充参数

-k（–ask-pass）：用来交互输入ssh密码
-K（-ask-become-pass）：用来交互输入sudo密码
-u：指定用户

5.2 检查机制

 ansible-playbook test1.yaml --syntax-check    #检查yaml文件的语法是否正确
ansible-playbook test1.yaml --list-task       #检查tasks任务
ansible-playbook test1.yaml --list-hosts      #检查生效的主机

5.3  指定从某个task开始运行

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

三     playbook 示例

1，  playbook 安装httpd

vim /opt/test1.yaml

---
- name: install httpd
  gather_facts: false
  hosts: zong
  remote_user: root
  tasks:
    - name: connect ceshi
      ping:
    - name: install httpd
      yum: name=httpd state=latest
    - name: file
      copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf
      notify: "restart httpd"
    - name: start httpd
      service: enabled=true name=httpd state=started
  handlers:
    - name: restart httpd
      service: name=httpd state=restarted

将配置文件拖入

检查 playbook 是否有错

检查task 任务

检查生效的主机

执行playbook

2  playbook定义、引用变量

vim  /opt/test2.yaml

---
- name: second play
  hosts: zong
  remote_user: root
  vars:
    - groupname: mysql
    - username: nginx
  tasks:
    - name: create group
      group: name={{groupname}} system=yes gid=306
    - name: create user
      user: name={{username}} uid=306 group={{groupname}}
    - name: copy file
      copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt

执行剧本

注意！ansible-playbook test1.yaml -e "username=nginx"  如果在命令行里  定义变量   该优先级高

查看剧本结果   创建账号 并分组

查看剧本结果   远程机有文件  放ip 信息

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

vim test3.yaml

---
- hosts: wyq01
  remote_user: wyq
  become: yes                    #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_user: root              #指定sudo用户为root

执行剧本

注意此处  是让远程主机上   wyq的账户提权  拥有root的权限   即sudo

不是su   不是切换用户

4  when条件判断

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

4. 1 when 应用场景

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

4.2  演示

vim test4.yaml

---
- hosts: all
  remote_user: root
  tasks:
   - name: shutdown host
     command: /sbin/shutdown -r now
     when: ansible_default_ipv4.address == "192.168.217.66"      #when指令中的变量名不>需要手动加上 {{}}
或 
     when: inventory_hostname == "<主机名>"

执行 剧本

 5   迭代

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

5.1 示例1 创建多个文件或目录

vim test5.yaml

---
- name:
  hosts: wyq01
  gather_facts: false
  tasks:
    - name: create directories 
      file:
        path: "{{item}}"
        state: directory
      with_items:          #等同于 loop:
        - /tmp/test1
        - /tmp/test2

执行 剧本

查看效果

剧本 改成 state=touch 展示

---
- name: qq
  hosts: wyq01
  gather_facts: false
  tasks:
    - name: create directories
      file:
        path: "{{item}}"
        state: touch
      with_items:          #等同于 loop:
        - /tmp/www.txt
        - /tmp/ww.txt

查看效果

5.2  示例2  创建多个账号

vim test5 .yaml

---
- name: qq
  hosts: wyq01
  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

执行剧本

查看剧本结果

6    Templates 模块

7.1  Templates 模块 工作原理

你可以简单理解为   首先在.j2 的文件（应用配置文件的复制）中定义变量         然后你再去 主机清单或者role中给这些变量赋值，  然后再在   远程主机上生成对应的配置文件。

最后能达到的效果是：  可以非常快速方便的自定义所有远程主机的配置文件

1. 模板文件: 首先，你需要有一个模板文件，这个文件通常位于Ansible的templates目录下，并使用Jinja2模板语言编写。模板文件中可以包含变量、控制结构（如循环、条件语句）和其他Jinja2特性，这些将在运行时被替换或处理。

2. 变量注入: Ansible在运行时会根据当前上下文（包括Playbook中定义的变量、inventory文件中的变量、主机变量、角色变量等）注入变量值到模板中。这意味着模板中的变量标记（如{{ variable_name }}）会被相应的值替换。

3. 渲染过程: 当Playbook执行到使用template模块的任务时，Ansible会读取模板文件，并使用Jinja2引擎在内存中渲染该模板。渲染过程中，所有模板表达式会被计算，生成最终的静态文本内容。

4. 权限与属性设置: template模块允许你指定渲染后文件的权限（如owner, group, mode）以及目标路径。这样，你可以在将文件复制到远程主机的同时设置所需的权限和所有权。

5. 文件传输: 渲染完成的文件会被安全地通过SSH（Ansible默认的连接方式）或者其他配置的连接方式传输到远程主机上指定的位置。

6. 动态配置: 这个过程使得每个远程主机即使使用同一个模板文件，也可以根据其特定的变量值生成个性化的配置文件，非常适合大规模基础设施的配置管理和自动部署。

7.2  为什么用 Templates 模块  而不是直接用vars

vars  只是定义变量   做不到    改配置文件

如果想做到Templates 模块   的效果

需要   在playbook中 你需要vars 先定义变量 再用sed 改配置文件

而  Templates模块 直接借助 一个 j2 文件 批量改配置文件

7.3   演示 修改远程主机的httpd配置文件

将配置文件 复制成.j2   的jinjia 语言的 模版

vim httpd.conf.j2   定义不同远程主机 的  http的变量

Listen {{http_port}}				#42行，修改
ServerName {{server name}}			#95行，修改
DocumentRoot "{{root dir}}"          #119行，修改
 <Directory "{{root_dir}}">         #124行 修改

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

分别 准备  两个组的主机 的http  各自的主页面

编写 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=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf
      notify:
        - restart httpd
    - name: create root dir
      copy: src=/etc/http/wyq/  dest=/etc/http/wyq/
      when: "'wyq01' in group_names"
    - name: create root dir
      copy: src=/etc/http/www/  dest=/etc/http/www/
      when: "'www02' in group_names"
    - name: start httpd server
      service: name={{service}} enabled=true state=started
  handlers:
    - name: restart httpd
      service: name={{service}} state=restarted

执行剧本

查看剧本效果

并且我们能看到  Templates模块 能修改配置文件  

8，   tags 模块

8.1 tags 模块 介绍

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

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

不同的任务可以使用相同的标签。这种做法有时非常有用，比如当你想要将一系列相关或具有相似功能的任务归类时。

8.2 tags 模块 演示

vim tags.yaml

---
- hosts: wyq01
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags:
        - hosts
    - name: touch file
      file: path=/opt/ccc state=touch
      tags:
        - always

    - name: copy hosts file
      file: path=/opt/bbb state=touch
      tags:
        - hosts

执行剧本

查看剧本结果

只执行hosts 标签   也会执行always 标签的内容

9    Roles 模块

9.1  Roles 是什么

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

角色是一组预定义的Ansible组件，它们共同完成一个特定的配置或部署任务，比如安装和配置Web服务器、数据库服务器等。每个角色通常关注于系统的某一特定方面或功能，通过结构化的目录来组织其内容，包括任务列表、变量、文件模板、处理程序和默认值等。

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

9.3  角色的用途

• 组织结构：角色使得大型Playbook的结构清晰，易于理解和维护。
• 重用代码：一旦创建，角色可以在不同的项目或环境中重复使用，减少重复工作。
• 团队协作：团队成员可以独立开发和维护不同的角色，促进分工合作。
• 版本控制：由于角色是独立的单元，更容易进行版本控制和跟踪变更。

9.4  角色的优势

• 模块化：通过将任务分解为小的、可管理的部分，简化了复杂系统的管理。
• 可重用性：角色可以在不同项目之间共享，减少重复编码。
• 标准化：角色的标准化结构促进了最佳实践的采用，提高代码质量。
• 易于维护：清晰的角色结构和分离的组件使得维护和升级更加简便。
• 提升效率：快速部署和配置新系统，减少部署错误，加快迭代速度。

9.5  在一个 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

 

9.6   role 模块 演示 安装lamp(yum版)

创建角色目录   以及下面的7个 固定目录

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

创建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

编写httpd角色的任务

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

定义 http 角色  的变量

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

定义 http 角色  的变量

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

定义php 角色  的变量

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

十    总结

定义变量

ansible-playbook 一种定义的任务方式，在编写 playbook 时可以使用变量来传数据。

playbook引用变量指的是再playbook中使用变量代理静态常量值，来实现动态的配置过程 通过引用变量 可以使 playbook跟具有灵活性和课重复性

when

用来进行条件判断的关键字 ，其作用只在你指定条件下会执行下面的任务，当条件为真时，任务就会被执行，否则任务将被跳过

迭代  理解为循环

通常指持续地对ansible playbook进行修改、更改 和改进的过程

template

是一种创建配置文件的工具   在配置文件中，会有一些数据动态地改变，如IP地址 主机名 端口用户 页面路径等  需要使用变量来表示

template 模块 就是将 变量和动态文件 结合起来 最终生成一个配置文件(你需要动态改变)

文件配置 使用jinjia2 模版语言来去编写 结尾()一定是 j2(xxx.j2)

tags

是一种标记任务或 一系列的任务的功能，通过任务或一个命名的任务列表上定义标记可以在运行playbook时去选择你需要执行的任务或者列表