ansible基础-roles

ansible基础-roles

作者/魏萌 图片/来源于网络

目录结构

一 简介

注:本文demo使用ansible2.7稳定版

在我看来,role是task文件、变量文件、handlers文件的集合体,这个集合体的显著特点是:可移植性和可重复执行性。

实践中,通常我们以部署某个服务为单元作为一个role ,然后将这些服务单元(role)放在一个roles目录下。主playbook文件通过调用roles目录下的role,来实现各种灵活多变的部署需求。

本节主要为大家介绍下roles的目录结构、引用方法及其他特性。

二 创建与目录结构

2.1 创建roles

通常创建一个role的方法有两种:

命令mkdir和touch行手动创建

使用ansible-galaxy自动初始化一个role

命令行手动创建方式就无需多说了,即需要哪个目录和文件就用「mkdir」和「touch」命令创建出来。

我个人比较喜欢使用「ansible-galaxy」命令创建,创建完后再删除我不需要的目录,这样可以避免因手误创建出错的问题。

例如,我想使用「ansible-galaxy init」命令创建一个名字为role_A 的role,可以这样写:

创建后的目录结构如下:

使用「ansible-galaxy」命令自动创建的role是最全的目录结构,根据需求,可以删除不用的目录文件。

2.2 目录结构

我们以上面创建的「role_A」为例,介绍下各目录文件的作用:

tasks : 用于存放role_A的主要任务,也可以添加其他task文件,供main.yaml调用,从而实现更加复杂的部署功能。

handlers : 用于存放触发执行( hanlders )的任务。

defaults : 用于存放默认变量,优先级最低,变量优先级可参考《

ansible基础-变量

》。

vars : 用于存放变量文件,role_A中任务和模版里用到的变量可以在这里定义。

files :用于存放需要拷贝到目的主机的文件,例如,作为「copy」模块src参数的默认根目录。

template : 用于存放模版文件,格式为.j2,文件内容要符合Jinja2语法规则,通常使用「template」模块部署服务的配置文件。

meta : 用于存放role依赖列表,这个知识点后面会详细阐述。

tests : 用于存放测试role本身功能的playbook和主机定义文件,在开发测试阶段比较常用。

role中各个目录下的main.yaml文件很重要,这是ansible默认加载的YAML文件。

三 role的引用与执行

3.1 roles语句引用

比较常用的方法,我们可以使用「roles:」语句引用role :

或者

或者

或者使用绝对路径:

引入的同时添加变量参数:

引入的同时添加tag参数:

根据需求,我们在playbook中引用不同的role,引用后的效果也很好理解:ansible会把role所包含的任务、变量、handlers、依赖等加载到playbook中,顺次执行。

检索路径

上面介绍了使用「roles」语句的引用方法,那么ansible去哪找这些role呢?

在不使用绝对路径的情况下,ansible检索role的默认路径有:

执行ansible-playbook命令时所在的当前目录

playbook文件所在的目录及playbook文件所在目录的roles目录

当前系统用户下的~/.ansible/roles目录

/usr/share/ansible/roles目录

ansible.cfg 中「roles_path」指定的目录,默认值为/etc/ansible/roles目录

注:上面的检索路径是在centos操作系统下测试出来的结果。

3.2 include和import引用

在后来版本(ansible>=2.4)中,ansible引入了「import_role」(静态)和「include_role」(动态)方法:

比较于「roles」语句,「import_role」和「include_role」的优点如下:

可以在task之间穿插导入某些role,这点是「roles」没有的特性。

更加灵活,可以使用「when」语句等判断是否导入。

关于include_role(动态)和import_role(静态)的区别,可以参考笔者之前的文章《ansible中include_tasks和import_tasks》。

也正是因为「include_task」是动态导入,当我们给「include_role」导入的role打tag时,实际并不会执行该role的task。

举个,当我们使用include导入role_A,使用import导入role_B时:

role_A内容如下:

执行结果显示,role_A虽然被引用,但里面的task并没有执行:

3.3 重复引用

不添加其他变量、tag等的情况下,一个playbook中对同一个role引入多次时,实际ansible只会执行一次。

例如:

当然,我们也可以让其运行多次,方法如下:

引用role的同时定义不同的变量

在meta/main.yaml中添加「allow_duplicates: true」(这个特性笔者实测未生效……)

两种情况示例分别如下:

3.4 执行顺序

笔者之前的文章《ansible基础-playbooks》「5.执行顺序」中提到,如果playbook中只有「tasks」和「roles」,ansible总是会先执行「roles」语句部分。此时可以使用「per_tasks」和「post_tasks」来规范执行顺序。

在使用「per_tasks」+「roles」+「tasks」+「post_tasks」结构下,task的执行顺序为:

per_task包含的play

per_task中handlers任务

roles语句中role列表依次执行,每个role优先执行依赖的play及任务

tasks语句中的所有play

前两步所触发的handlers

post_tasks包含的play

post_tasks触发的handlers

四 role的依赖

role的依赖指role_A可以引入其他的role,例如role_B。

roles的依赖知识点总结如下:

配置的路径在role_A的meta/main.yaml

引入role列表的方式只能使用类似「roles」语句的方法,只需将「roles」换为「dependencies」语句,不能用新版本的include和import语句

在meta/main.yaml文件内可以引入多个role,且必须以列表的形式引入

在引入role的同时,可以添加变量,方法同「roles」语句

多层依赖

被引入的role总是优先执行,即便是同一个 role 被引入了多次(遵循3.3重复引用规则)。

举个:

role「car」引入了role「wheel」:

同时,role「wheel」引入了role「tire」和「brake」:

最终的执行结果为:

其中,关于dependencies变量的作用域请参考《ansible基础-变量》「4.2.2 dependencies变量」章节。

五 插件和模块

我们可以为一个role自定义模块和插件,这部分属于高级特性,在以后的「ansible进阶」系列文章中会详细阐述,这里只简单介绍下。

模块

给某个role自定义模块,需要在这个role的目录下创建「library」目录,然后将自定义模块放在该目录下。

创建自定义模块目录结构示例:

引用的时候在「my_custom_modules」后被引用的role也可以使用该自定义模块:

插件

自定义插件的方法与模块类似,需要创建的目录为「filter_plugins」。

创建自定义插件目录结构示例:

与模块一样,自定义插件可以在本身role的task和模版内使用,也可以在 role「my_custom_filter」之后被引用的role内使用。

六 Ansible Galaxy

Ansible Galaxy是一个免费的roles仓库,里面有很多社区里现成稳定的role,在生产中的部署项目中,可以直接下载下来使用。

Ansible Galaxy客户端是「ansible-galaxy」,「ansible-galaxy」命令行可以用来初始化一个role(本文2.1 创建roles有提),也可以用来从Ansible Galaxy下载role。

关于Ansible Galaxy的详细介绍,因篇幅原因,这里不再扩展,有兴趣的同学可以去官网加深学习下。

七 本节应该掌握的技能

掌握role的目录结构及其含义

掌握引用role的方法

掌握role的依赖及执行顺序

了解自定义模版和插件

了解Ansible Galaxy

八 参考链接

https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html

- END -

没点关注的童鞋点一波关注

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181121G0UHET00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。

同媒体快讯

扫码关注云+社区

领取腾讯云代金券