ansible playbooks

一，ansible剧本

Ansible Playbooks 是 Ansible 中用于自动化任务和配置管理的一种脚本文件，采用YAML语法编写。它可以描述一系列要执行的任务，例如安装软件、配置系统、部署应用程序等。通过编写Playbooks，用户可以定义需要执行的步骤，并将其应用到多个主机或环境中，实现自动化和一致性管理。

二，ansible playbooks主要特性

• YAML格式：Playbooks使用YAML文件格式，简单易读，结构清晰，便于编写和维护。
• 任务序列：Playbooks可以定义一系列按顺序执行的任务，每个任务描述一个具体操作（如安装软件、修改配置文件、启动服务等）。
• 声明性：Ansible Playbooks声明了系统应该处于的状态，而不是具体如何达到该状态。它会检查当前状态，并根据需要做出最小的更改。
• 模块化：Playbooks中可以调用Ansible模块，如文件管理、包管理、服务控制等模块，使任务执行更加灵活和强大。
• 跨平台支持：可以同时对多个主机组进行操作，并支持跨平台的任务执行（如Linux、Windows等操作系统）。

三，yaml基本语法规则

1大小写敏感
2使用缩进表示层级关系
3缩进时不允许使用tab键、只允许使用空格
4缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

四，剧本playbooks的组成结构

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

五，yaml编写

1.示例

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

2.运行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.1 运行

ansible-playbook a01.yaml

（1）当被远程机器192.168.88.70 selinux是disabled状态所以报错

（2）忽略报错加这个命令 ignore_errors: True后继续运行

第二条报错提示少http.conf文件

（3）修改httpd.conf文件移到/opt目录下后执行剧本

验证httpd端口改成8080后给192.168.88.70机器，httpd.conf文件覆盖了目的文件

2.2 检查yaml文件的语法是否正确

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

（1）正确的情况

（2）错误的情况

2.3 检查tasks任务

ansible-playbook a01.yaml --list-task       #检查tasks任务

（1）正确的情况

（2）错误的情况少个e

2.3 检查生效的主机

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

2.4 指定从某个task开始运行

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

3.定义、引用变量

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

将用户加入组

总结

定义变量:使用playbook变量进行动态配置,增加任务灵活性和可重用。变量的引用允许代替静态常量值,从而增强playbook的适应性。

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

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

4.1 在dbservers上创建一个zhangsan账号

useradd zhangsan
passwd zhangsan
sudo visudo
zhangsan ALL=(ALL) NOPASSWD: ALL

4.2 在ansible 执行命令

ansible-playbook a02.yaml -K 
123456

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

5.1

5.2

总结

when:使用来进行条件判断的关键字,其作用是只在指定条件下擦灰执行的下面的任务。当任务为真,任务将会被执行,否则任务就会被跳过

6.迭代

Ansible提供了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。
vim test3.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'}

ansible-playbook test3.yaml

6.1

6.2

总结

迭代:通常指持续的playbook 剧本(一种使用YAML编写自动化的任务脚本)进行修改和更新和改进的过程在工作中，需要经常针对一些特定的任务编写并使用 playbook ，而这些任务可能随着动态而变化的迭代提升了自动化的任务的效率和准确性

7.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.10.14 http_port=192.168.10.14:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs

[dbservers]
192.168.10.15 http_port=192.168.0.15:80 server_name=www.benet.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=/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

7.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行，修改

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

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

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

7.3编写 playbook

总结

template:它是一种用来创建配置文件的工具。会有一些数据经常动态改变,如IP地址、主机名(服务名)、用户端口、名等

需要使用变量来表示。template模块就是将这些变量和静态文本结合起来,生成一个最终的配置文件。

8.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"
//分别去两台被管理主机上去查看文件创建情况

总结

tags:在playbook中 tags 是一种标记任务或一系列任务的功能

9.roles模块

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

• 角色允许将复杂的剧本组织成独立的、更小的剧本和文件
• 角色提供了一种从外部文件加载任务、处理程序和变量的方法
• 角色也可关联和引用静态的文件和模板
• 角色可以编写成满足普通用途需求,并且能被重复利用

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

9.1 roles 目录结构

cd /etc/ansible/
tree roles/
roles/
├── web/
│   ├── files/
│   ├── templates/
│   ├── tasks/
│   ├── handlers/
│   ├── vars/
│   ├── defaults/
│   └── meta/
└── db/
    ├── files/
    ├── templates/
    ├── tasks/
    ├── handlers/
    ├── vars/
    ├── defaults/
    └── meta/

9.2 目录用途

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剧本使用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.ym

9.4 用roles模块完成lanmp

创建lnmp目录
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模块
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

创建lnmp目录和main.yml文件

httpd

mysql

php

roles

运行

总结

ansible·角色·(roles)·可以将复杂的任务和逻辑划分成多个独立的单元(目录)

（1）任务(tasks)执行具体的操作的步骤

（2）变量(vars)角色使用中的变量

（3）文件(files)就是需要复制到远程主机的文件

（4）模版(temlates)动态生成的配置文件

（5）处理器(handlers)在任务完成之后触发的操作,比如重启服务

（6）默认变量(defaults)角色中的默认变量

（7）依赖(meta(dependencies))依赖其他的角色

ansible角色的好处

（1）简化剧本的管理：将剧本分解为若干个小的模块,每个角色处理特定功能,使得整理管理更加清晰

（2）模块化和重要性：可以在不同的项目或场景中反复使用,减少重写任务的编写

（3）易于维护和扩展：当某个部分的角色内需要更新时,只需要修改相应的角色。不用修改整个playbook

根据Ansible的官方文档和实践，执行后颜色的含义通常如下：

• 绿色：
  • 代表执行成功，且没有对目标机器做修改。这表示Ansible执行的任务成功完成，且目标机器的状态与预期一致，没有进行任何更改。
• 粉色：
  • 代表警告信息。当Ansible在执行过程中遇到一些非严重错误或需要用户注意的情况时，会输出粉色的警告信息。这些信息通常是建议性的，用户可以根据警告内容决定是否需要进行调整。
• 黄色：
  • 代表执行成功，但目标机器的状态发生了变化。这表示Ansible执行的任务成功完成，且目标机器的状态与预期不一致，Ansible对目标机器进行了相应的修改或更新。
• 红色：
  • 代表执行失败。当Ansible在执行过程中遇到严重错误或无法完成任务时，会输出红色的错误信息。这表示用户需要检查错误原因，并采取相应的措施解决问题。