Ansible_描述角色结构
一、利用角色构造ansible playbook
1、What's 角色
1️⃣:Ansible角色提供了一种方法,让用户能以通用的方式更加轻松地重复利用Ansible代码。
我们可以在标准化目录结构中打包所有任务、变量、文件、模板,以及调配基础架构或部署应用所需的其他资源
只需通过复制相关的目录,将角色从一个项目复制到另一个项目。然后,只需从一个play调用该角色就能执行它
3️⃣:借助编写良好的角色,可以从playbook中向角色传递调整其行为的变量,设置所有站点相关的主机名、IP地址、用户名,或其他在本地需要的具体详细信息
3️⃣:Ansible具备的优点:
- 角色可以分组内容,从而与他人轻松共享代码
- 可以编写角色来定义系统类型的基本要素:Web服务器、数据库服务器、Git存储库,或满足其他用途
- 角色使得较大型项目更容易管理
- 角色可以由不同的管理员并行开发
4️⃣:除了自行编写、使用、重用和共享角色外,还可以从其他来源获取角色。一些角色已包含在rhel-system-roles软件包中,用户也可以从Ansible Galaxy网站获取由社区提供支持的许多角色
- 使用rhel-system-roles软件包使用角色
//在控制节点上查看本地的角色
[root@localhost ~]# ls /usr/share/ansible/roles/ //安装rhel-system-roles
[root@localhost ~]# yum list | grep rhel-system-roles
rhel-system-roles.noarch 1.0-9.el8 appstream
[root@localhost ~]# yum install -y rhel-system-roles //在次查看本地的角色
[root@localhost ~]# ls /usr/share/ansible/roles/
linux-system-roles.kdump linux-system-roles.postfix linux-system-roles.storage rhel-system-roles.kdump rhel-system-roles.postfix rhel-system-roles.storage
linux-system-roles.network linux-system-roles.selinux linux-system-roles.timesync rhel-system-roles.network rhel-system-roles.selinux rhel-system-roles.timesync
- 从Ansible Galaxy网站获取由社区提供支持的许多角色,请戳:https://galaxy.ansible.com/
二、Ansible角色结构
1、结果说明
1️⃣:Ansible角色由子目录和文件的标准化结构定义
2️⃣:顶级目录定义角色本身的名称。
3️⃣:文件整理到子目录中,子目录按照各个文件在角色中的用途进行命名,如tasks和handlers。files和templates子目录中包含由其他YAML文件中的任务引用的文件
- 实例:
head.yml
main.yml
roles/
common/
tasks/
handlers/
files/
templates/
vars/
defaults/
meta/
webservers/
tasks/
defaults/
meta/
2、Ansible角色子目录
子目录 | 功能 |
---|---|
defaults | 此目录中的main.yml文件包含角色变量的默认值,使用角色时可以覆盖这些默认值。 这些变量的优先级较低,应该在play中更改和自定义。 |
files | 此目录包含由角色任务引用的静态文件。 |
handlers | 此目录中的main.yml文件包含角色的处理程序定义。 |
meta | 此目录中的main.yml文件包含与角色相关的信息,如作者、许可证、平台和可选的角色依赖项。 |
tasks | 此目录中的main.yml文件包含角色的任务定义。 |
templates | 此目录包含由角色任务引用的Jinja2模板。 |
tests | 此目录可以包含清单和名为test.yml的playbook,可用于测试角色。 |
vars | 此目录中的main.yml文件定义角色的变量值。这些变量通常用于角色内部用途。 这些变量的优先级较高,在playbook中使用时不应更改。 |
- 注意:并非每个角色都拥有所有这些目录。
三、定义变量和默认值
1、定义变量
1️⃣:角色变量通过在角色目录层次结构中创建含有键值对的vars/main.yml文件来定义(键值对:key = value)
2️⃣:这些角色变量在角色YAML文件中引用:{{ VAR_NAME }},这些变量具有较高的优先级,无法被清单变量覆盖
2、定义默认值
1️⃣:默认变量允许为可在play中使用的变量设置默认值,以配置角色或自定义其行为
2️⃣:它们通过在角色目录层次结构中创建含有键值对的defaults/main.yml文件来定义
3️⃣:默认变量具有任何可用变量中最低的优先级。它们很容易被包括清单变量在内的任何其他变量覆盖
4️⃣:这些变量旨在让用户在编写使用该角色的play时可以准确地自定义或控制它将要执行的操作。它们可用于向角色提供所需的信息,以正确地配置或部署某些对象
5️⃣:在vars/main.yml或defaults/main.yml中定义具体的变量,但不要在两者中都定义,有意要覆盖变量的值时,应使用默认变量
3、注意
- 角色不应该包含特定于站点的数据。它们绝对不应包含任何机密,如密码或私钥
- 这是因为角色应该是通用的,可以重复利用并自由共享。特定于站点的详细信息不应硬编码到角色中
- 机密应当通过其他途径提供给角色。这是用户可能要在调用角色时设置角色变量的一个原因
- play中设置的角色变量可以提供机密,或指向含有该机密的Ansible Vault加密文件。
四、在palybook中使用ansbible角色
1、在playbook中简单调用Ansible角色
[root@localhost project]# cat main.yaml
---
- host: all
roles:
- role_one
- role_two
- role_three
2、角色调用
1️⃣:对于每个指定的角色,角色任务、角色处理程序、角色变量和角色依赖项将按照顺序导入到playbook中
2️⃣:角色中的任何copy、script、template或include_tasks/import_tasks任务都可引用角色中相关的文件、模板或任务文件,且无需相对或绝对路径名称
3️⃣:Ansible将分别在角色的files、templates或tasks子目录中寻找它们
//示例一:
[root@localhost project]# cat main.yaml
---
- hosts: all
gather_facts: no
roles:
- role: roles/role_one
- role: roles/role_two
4️⃣:重要:
- 内嵌设置的角色变量(角色参数)具有非常高的优先级。它们将覆盖大多数其他变量
- 务必要谨慎,不要重复使用内嵌设置在play中任何其他位置的任何角色变量的名称,因为角色变量的值将覆盖清单变量和任何play中的vars
五、控制执行顺序
1、顺序控制
1️⃣:对于playbook中的每个play,任务按照任务列表中的顺序来执行。执行完所有任务后,将执行任务通知的处理程序。
2️⃣:将角色添加到play中,角色任务将添加到任务列表的开头。如果play中包含第二个角色任务,其任务列表添加到第一个角色之后
3️⃣:角色处理程序添加到play中的方式与角色任务添加到play中相同,每个play定义一个处理程序列表;角色处理程序先添加到处理程序列表,后跟play的handlers部分中的任何处理程序
4️⃣:在某些情形中,可能需要在角色之前执行一些play任务。若要支持这样的情形,可以为play配置pre_tasks部分,列在此部分中的所有任务将在执行任何角色之前执行
- 如果这些任务中有任何一个通知了处理程序,则这些处理程序任务也在角色或普通任务之前执行
5️⃣:play也支持post_tasks关键字。这些任务在play的普通任务和它们通知的任何处理程序运行之后执行
- 简单演示实例一:
//查看playbook
[root@localhost project]# cat playbook.yaml
---
- hosts: all
gather_facts: no
pre_tasks:
- debug:
msg: "This is one test" tasks:
- name: This is two test
debug:
msg: 'This is two test' post_tasks:
- debug:
msg: "This is three test" //执行play
[root@localhost project]# ansible-playbook playbook.yaml PLAY [all] **************************************************************************************************************************************************************** TASK [debug] **************************************************************************************************************************************************************
ok: [192.168.121.81] => {
"msg": "This is one test"
} TASK [This is two test] ***************************************************************************************************************************************************
ok: [192.168.121.81] => {
"msg": "This is two test"
} TASK [debug] **************************************************************************************************************************************************************
ok: [192.168.121.81] => {
"msg": "This is three test"
} PLAY RECAP ****************************************************************************************************************************************************************
192.168.121.81 : ok=3 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
- 演示实例二:
//查看playbook
[root@localhost project]# cat playbook.yaml
---
- hosts: all
gather_facts: no
tasks:
- name: This is one test
debug:
msg: "This is one test"
notify: one test
changed_when: yes post_tasks:
- name: This is two test
debug:
msg: "This is two test"
notify: two test
changed_when: yes pre_tasks:
- name: Thsi is three test
debug:
msg: "This is three test"
notify: three test
changed_when: yes handlers:
- name: one test
debug:
msg: "print the one test" - name: two test
debug:
msg: "print the two test" - name: three test
debug:
msg: "print the three test" //执行play
[root@localhost project]# ansible-playbook playbook.yaml PLAY [all] **************************************************************************************************************************************************************** TASK [Thsi is three test] *************************************************************************************************************************************************
changed: [192.168.121.81] => {
"msg": "This is three test"
} RUNNING HANDLER [three test] **********************************************************************************************************************************************
ok: [192.168.121.81] => {
"msg": "print the three test"
} TASK [This is one test] ***************************************************************************************************************************************************
changed: [192.168.121.81] => {
"msg": "This is one test"
} RUNNING HANDLER [one test] ************************************************************************************************************************************************
ok: [192.168.121.81] => {
"msg": "print the one test"
} TASK [This is two test] ***************************************************************************************************************************************************
changed: [192.168.121.81] => {
"msg": "This is two test"
} RUNNING HANDLER [two test] ************************************************************************************************************************************************
ok: [192.168.121.81] => {
"msg": "print the two test"
} PLAY RECAP ****************************************************************************************************************************************************************
192.168.121.81 : ok=6 changed=3 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
6️⃣:在上例中,每个部分中都执行debug任务来通知my handler处理程序。my handler任务执行了三次
- 在执行了所有pre_tasks任务后
- 在执行了所有角色任务和tasks部分中的任务后
- 在执行了所有post_tasks后
7️⃣:除了将角色包含在play的roles部分中外,也可以使用普通任务将角色添加到play中。
- 使用include_role模块可以动态包含角色,使用import_role模块则可静态导入角色。
- .注意:
- include_role模块是在Ansible 2.3中新增的,而import_role模块则是在Ansible 2.4中新增的
最新文章
- iis 使用 LocalDB 报错:provider: SQL Network Interfaces, error: 50
- 如何用JS判断推广链接所属的客服
- 安装包制作工具 SetupFactory使用2 API清单
- 【Windows】如何判断当前鼠标是否按下左键或右键
- poj 1147 Binary codes
- FPGA开发板
- 一步一步深入spring(5)--使用基于注解的spring实现 AOP
- 基于OWIN+DotNetOpenOAuth实现OAuth2.0
- Python进程-实现
- Win7下安装composer, 并使用其安装smarty
- sql server 多行数据合并成一列
- sorted
- vue实战记录(三)- vue实现购物车功能之渲染商品列表
- MongoDB学习笔记(转)
- vue学习之生命周期和钩子函数
- Learning-MySQL【2】:MySQL存储引擎及数据库的操作管理
- centos 6 下KVM 安装学习之旅
- (转)Db2 数据库性能优化中,十个共性问题及难点的处理经验
- JDBC异常
- HDFS文件系统基础
热门文章
- 【Azure Developer】Azure Graph SDK获取用户列表的问题: SDK中GraphServiceClient如何指向中国区的Endpoint:https://microsoftgraph.chinacloudapi.cn/v1.0
- OO第四单元——基于UML的UML解析器总结&;OO课程总结
- 实战 Java 16 值类型 Record - 2. Record 的基本用法
- 【笔记】《Redis设计与实现》chapter10 RDB持久化
- (十六)VMware Harbor 复制镜像
- 【pytest官方文档】解读fixtures - 3. fixtures调用别的fixtures、以及fixture的复用性
- .Net Core 集成 Kafka
- 05.ElementUI源码学习:项目发布配置(github pages&;npm package)
- 03- HTML基本结构
- Python编写基于socket的非阻塞多人聊天室程序(单线程&多线程)