Ansible 创建角色 Galax在线角色的使用

Ansible 创建角色 Galax在线角色的使用

1.创建角色

角色创建流程
在Ansible中创建角色不需要特别的开发工具。创建和使用角色包含三个步骤：

1. 创建角色目录结构
2. 定义角色内容
3. 在playbook中使用角色

1.1创建角色目录结构

默认情况下，Ansible在Ansible Playbook所在目录的roles子目录中查找角色。这样，用户可以利用playbook和其他支持文件存储角色。

如果Ansible无法在该位置找到角色，它会按照顺序在Ansible配置设置roles_path所指定的目录中查找。此变量包含要搜索的目录的冒号分隔列表。此变量的默认值为：

~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles

这允许用户将角色安装到由多个项目共享的系统上。例如，用户可能将自己的角色安装在自己的主目录下的~/.ansible/roles子目录中，而系统可能将所有用户的角色安装在/usr/share/ansible/roles目录中。

每个角色具有自己的目录，采用标准化的目录结构。例如，以下目录结构包含了定义motd角色的文件。

[root@localhost ~]# tree roles/
roles/
└── motd├── defaults│   └── main.yml├── files├── handlers├── meta│   └── main.yml├── tasks│   └── main.yml└── templates└── motd.j2

README.md提供人类可读的基本角色描述、有关如何使用该角色的文档和示例，以及其发挥作用所需要满足的任何非Ansible要求。

meta子目录包含一个main.yml文件，该文件指定有关模块的作者、许可证、兼容性和依赖项的信息。

files子目录包含固定内容的文件，而templates子目录则包含使用时可由角色部署的模板。

其他子目录中可以包含main.yml文件，它们定义默认的变量值、处理程序、任务、角色元数据或变量，具体取决于所处的子目录。

如果某一子目录存在但为空，如本例中的handlers，它将被忽略。如果某一角色不使用功能，则其子目录可以完全省略。例如，本例中的vars子目录已被省略。

1.2创建角色框架

可以使用标准Linux命令创建新角色所需的所有子目录和文件。此外，也可以通过命令行实用程序来自动执行新角色创建过程。

ansible-galaxy命令行工具可用于管理Ansible角色，包括新角色的创建。用户可以运行ansible-galaxy init来创建新角色的目录结构。指定角色的名称作为命令的参数，该命令在当前工作目录中为新角色创建子目录。

[root@master roles]# ansible-galaxy init httpd
- Role httpd was created successfully
[root@master roles]# ls
httpd
[root@master roles]# tree httpd/
httpd/
├── defaults
│   └── main.yml
├── files
├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── README.md
├── tasks
│   └── main.yml
├── templates
├── tests
│   ├── inventory
│   └── test.yml
└── vars└── main.yml8 directories, 8 files
[root@master roles]# 

1.3定义角色内容

创建目录结构后，用户必须编写角色的内容。ROLENAME/tasks/main.yml任务文件是一个不错的起点，它是由角色运行的主要任务列表。

下列tasks/main.yml文件管理受管主机上的/etc/motd文件。它使用template模块将名为motd.j2的模板部署到受管主机上。因为template模块是在角色任务而非playbook任务内配置的，所以从角色的templates子目录检索motd.j2模板。

[root@master httpd]# cat tasks/main.yml 
---
# tasks file for httpd
- name: install httpdyum:name: httpdstate: present- name: config httpdtemplate:src: config httpddest: /etc/httpd/conf/httpd.confnotifg:- restart httpd- name: service httpdservice:name: httpdstate: started//defaults编写变量
[root@master httpd]# cat defaults/main.yml 
---
# defaults file for httpd
port: 80//编写handlers
[root@master httpd]# cat handlers/main.yml 
---
# handlers file for httpd
- name: restart httpdservice:name: httpdstate: restarted//测试任务
[root@master opt]# cat tasks.yml 
---
- hosts: 192.168.72.137remote_user: rootroles:- httpd//执行
[root@master opt]# ansible-playbook tasks.yml 
[WARNING]: Found variable using reserved name: portPLAY [192.168.72.137] ******************************************************************************************************************TASK [Gathering Facts] *****************************************************************************************************************
ok: [192.168.72.137]TASK [install httpd] *******************************************************************************************************************
ok: [192.168.72.137]TASK [config httpd] ********************************************************************************************************************
changed: [192.168.72.137]TASK [service httpd] *******************************************************************************************************************
ok: [192.168.72.137]RUNNING HANDLER [restart httpd] ********************************************************************************************************
changed: [192.168.72.137]PLAY RECAP *****************************************************************************************************************************
192.168.72.137             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   [root@master opt]# 

1.4角色内容开发的推荐做法

角色允许以模块化方式编写playbook。为了最大限度地提高新开发角色的效率，请考虑在角色开发中采用以下推荐做法：

在角色自己的版本控制存储库中维护每个角色。Ansible很适合使用基于git的存储库。
角色存储库中不应存储敏感信息，如密码或SSH密钥。敏感值应以变量的形式进行参数化，其默认值应不敏感。使用角色的playbook负责通过Ansible Vault变量文件、环境变量或其他ansible-playbook选项定义敏感变量。
使用ansible-galaxy init启动角色，然后删除不需要的任何目录和文件。
创建并维护README.md和meta/main.yml文件，以记录用户的角色的用途、作者和用法。
让角色侧重于特定的用途或功能。可以编写多个角色，而不是让一个角色承担许多任务。
经常重用和重构角色。避免为边缘配置创建新的角色。如果现有角色能够完成大部分的所需配置，请重构现有角色以集成新的配置方案。使用集成和回归测试技术来确保角色提供所需的新功能，并且不对现有的playbook造成问题。

1.5定义角色依赖项

角色依赖项使得角色可以将其他角色作为依赖项包含在内。例如，一个定义文档服务器的角色可能依赖于另一个安装和配置web服务器的角色。依赖关系在角色目录层次结构中的meta/main.yml文件内定义。

以下是一个示例meta/main.yml文件。

dependencies:- role: apacheport: 8080- role: postgresdbname: serverlistadmin_user: felix

默认情况下，角色仅作为依赖项添加到playbook中一次。若有其他角色也将它作为依赖项列出，它不会再次运行。此行为可以被覆盖，将meta/main.yml文件中的allow_duplicates变量设置为yes即可。

1.6在playbook中使用角色

要访问角色，可在play的roles:部分引用它。下列playbook引用了motd角色。由于没有指定变量，因此将使用默认变量值应用该角色。

root@server ansible]# cat run.yml 
---
- hosts: 192.168.200.145roles: - role: httpd

2.使用ansible galaxy部署角色

2.1介绍ansible galaxy

Ansible Galaxy https://galaxy.ansible.com是一个Ansible内容公共资源库，这些内容由许许多多Ansible管理员和用户编写。它包含数千个Ansible角色，具有可搜索的数据库，可帮助Ansible用户确定或许有助于他们完成管理任务的角色。Ansible Galaxy含有面向新的Ansible用户和角色开发人员的文档和视频链接。

此外，用于从Ansible Galaxy获取和管理角色的ansible-galaxy命令也可用于为您的项目获取和管理自有的git存储库中的角色。

2.2获取Ansible Galaxy帮助

通过Ansible Galaxy网站主页上的Documenttaion标签，可以进入描述如何使用Ansible Galaxy的页面。其中包含了介绍如何从Ansible Galaxy下载和使用角色的内容。该页面也提供关于如何开发角色并上传到Ansible Galaxy的说明。

2.3浏览Ansible Galaxy中的角色

通过Ansible Galaxy网站主页上左侧的Search标签，用户可以访问关于Ansible Galaxy上发布的角色的信息。用户可以使用标记通过角色的名称或通过其他角色属性来搜索Ansible角色。结果按照Best Match分数降序排列，此分数依据角色质量、角色受欢迎程度和搜索条件计算而得。

2.4Ansible Galaxy命令行工具

ansible-galaxy search子命令在Ansible Galaxy中搜索角色。如果以参数形式指定了字符串，则可用于按照关键字在Ansible Galaxy中搜索角色。用户可以使用–author、–platforms和–galaxy-tags选项来缩小搜索结果的范围。搜索到的都是可以用的。

命令ansible-galaxy search --author geerlingguy将显示由用户geerlingguy提交的所有角色。

[root@master opt]# ansible-galaxy search --author geerlingguyFound 100 roles matching your search:Name                              Description----                              -----------geerlingguy.adminer               Installs Adminer for Database management.geerlingguy.ansible               Ansible for RedHat/CentOS/Debian/Ubuntu.geerlingguy.apache                Apache 2.x for Linux.geerlingguy.apache-php-fpm        Apache 2.4+ PHP-FPM support for Linux.geerlingguy.aws-inspector         AWS Inspector installation for Linux.geerlingguy.awx                   Installs and configures AWX (Ansible Tower's open source version).geerlingguy.awx-container         Ansible AWX container for Docker.geerlingguy.backup                Backup for Simple Servers.geerlingguy.bad_judgement         DO NOT USE THIS ROLE! It is for demonstration purposes.geerlingguy.blackfire             Blackfire installation for Linuxgeerlingguy.certbot               Installs and configures Certbot (for Let's Encrypt).geerlingguy.clamav                ClamAV installation and configuration.geerlingguy.collectd-signalfx     SignalFx Collectd installation for Linux.geerlingguy.composer              Composer PHP Dependency Manager

下例显示了包含redis并且适用于企业Linux(EL)平台的角色的名称

[root@master opt]# ansible-galaxy search 'redis' --platforms ELFound 234 roles matching your search:Name                                            Description----                                            -----------0x0i.consul                                     Consul - a service discovery, mesh and configuration control plane and networking tool0x0i.grafana                                    Grafana - an analytics and monitoring observability platform0x5a17ed.ansible_role_netbox                    Installs and configures NetBox, a DCIM suite, in a production setting.1it.sudo                                        Ansible role for managing sudoersadfinis-sygroup.redis                           Ansible role for RedisAerisCloud.librato                              Install and configure the Librato AgentAerisCloud.redis                                Installs redis on a serverAlbanAndrieu.java                               Manage Java installationalikins.php_pecl                                PHP PECL extension installation.alikins.php_redis                               PhpRedis support for Linuxalikins.redis                                   Redis for Linuxandrewrothstein.redis                           builds Redis from src and installsanjia0532.ansible_beats                         Beats for Linuxantoniobarbaro.nextcloud                        install or upgrade nextcloud
:

ansible-galaxy info子命令显示与角色相关的更多详细信息。Ansible Galaxy从多个位置获取这一信息，包括角色的meta/main.yml文件及其GigHub存储库。

[root@master opt]# ansible-galaxy info geerlingguy.redisRole: geerlingguy.redisdescription: Redis for Linuxactive: Truecommit: 3bb101101e29aa3da55baa8ae5d9bf56e00e0aafcommit_message: Merge pull request #51 from agrrh/masterFix #39: Redis won't start with ipv6 disabledcommit_url: https://api.github.com/repos/geerlingguy/ansible-role-redis/git/commits/3bb101101e29aa3da55baa8ae5d9bf56e00e0aafcompany: Midwestern Mac, LLCcreated: 2014-03-06T16:48:12.451903Zdownload_count: 573419forks_count: 137github_branch: mastergithub_repo: ansible-role-redisgithub_user: geerlingguyid: 468imported: 2020-11-17T14:20:46.640658-05:00is_valid: True
:

2.5从Ansible Galaxy安装角色

[root@master ~]# ansible-galaxy install geerlingguy.redis
- downloading role 'redis', owned by geerlingguy
- downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.7.0.tar.gz
- extracting geerlingguy.redis to /root/.ansible/roles/geerlingguy.redis
- geerlingguy.redis (1.7.0) was installed successfully
[root@master ~]# ls .ansible/roles/
geerlingguy.redis
[root@master ~]# 

2.6使用要求文件安装角色

可以使用ansible-galaxy，根据某一文本文件中的定义来安装一个角色列表。例如，如果用户的一个playbook需要安装特定的角色，可以在项目目录中创建一个roles/requirements.yml文件来指定所需的角色。此文件充当playbook项目的依赖项清单，使得playbook的开发和调试能与任何支持角色分开进行。

例如，一个用于安装geerlingguy.redis的简单requirements.yml可能类似于如下：

- src: geerlingguy.redisversion: "1.5.0"

src属性指定角色的来源，本例中为来自Ansible Galaxy的geerlingguy.redis角色。version属性是可选的，指定要安装的角色版本，本例中为1.5.0

ansible-galaxy install -r roles/requirements.yml -p roles

应当在requirements.yml文件中指定角色版本，特别是生产环境中的playbook。
如果不指定版本，将会获取角色的最新版本。如果作者对角色做出了更改，并与用户的playbook不兼容，这可能会造成自动化失败或其他问题。

用户可以使用ansible-galaxy来安装不在Ansible Galaxy中的角色。可以在私有的Git存储库或Web服务器上托管自有的专用或内部角色。下例演示了如何利用各种远程来源配置要求文件。

[root@server ansible]# cat roles/requirements.yml
# from Ansible Galaxy, using the latest version
- src: geerlingguy.redis# from Ansible Galaxy, overriding the name and using a specific version
- src: geerlingguy.redisversion: "1.5.0"name: redis_prod# from any Git-based repository, using HTTPS
- src: https://gitlab.com/guardianproject-ops/ansible-nginx-acme.gitscm: gitversion: 56e00a54name: nginx-acme# from any Git-based repository, using SSH
- src: git@gitlab.com:guardianproject-ops/ansible-nginx-acme.gitscm: gitversion: mastername: nginx-acme-ssh# from a role tar ball, given a URL
# supports 'http', 'https', or 'file' protocols
- src: file:///opt/local/roles/myrole.tarname: myrole

src关键字指定Ansible Galaxy角色名称。如果角色没有托管在Ansible Galaxy中，则src关键字将指明角色的URL。

如果角色托管在来源控制存储库中，则需要使用scm属性。ansible-galaxy命令能够从基于git或mercurial的软件存储库下载和安装角色。基于Git的存储库要求scm值为git，而托管在Mercurial存储库中的角色则要求值为hg。如果角色托管在Ansible Galaxy中，或者以tar存档形式托管在Web服务器上，则省略scm关键字。

name关键字用于覆盖角色的本地名称。version关键字用于指定角色的版本。version关键字可以是与严自角色的软件存储库的分支、标记或提交哈希对应的任何值。

2.7 管理下载的角色

ansible-galaxy命令也可管理本地的角色，如位于playbook项目的roles目录中的角色。ansible-galaxy list子命令列出本地找到的角色

[root@master ansible]# ansible-galaxy list
# /root/.ansible/roles
- geerlingguy.redis, 1.7.0
# /usr/share/ansible/roles
- linux-system-roles.certificate, (unknown version)
- linux-system-roles.crypto_policies, (unknown version)
- linux-system-roles.ha_cluster, (unknown version)
- linux-system-roles.kdump, (unknown version)
- linux-system-roles.kernel_settings, (unknown version)

可以使用ansible-galaxy remove子命令本地删除角色

[root@master ansible]# ansible-galaxy remove geelingguy.redis

在playbook中使用下载并安装的角色的方式与任何其他角色都一样。在roles部分中利用其下载的角色名称来加以引用。如果角色不在项目的roles目录中，则将检查roles_path来查看角色是否安装在了其中一个目录中，将使用第一个匹配项。以下use-role.ymlplaybook引用了redis_prod和geerlingguy.redis角色

[root@localhost project]# cat use-role.yml
---
- name: use redis_prod for prod machineshosts: redis_prod_serversremote_user: devopsbecome: Trueroles:- redis_prod- name: use geerlingguy.redis for Dev machineshosts: redis_dev_serversremote_user: devopsbecome: Trueroles:- geerlingguy.redis