ansible-galaxy的应用
介绍ansible galaxy
Ansible Galaxy [https://galaxy.ansible.com]是一个Ansible内容公共资源库，这些内容由许许多多Ansible管理员和用户编写。它包含数千个Ansible角色，具有可搜索的数据库，可帮助Ansible用户确定或许有助于他们完成管理任务的角色。Ansible Galaxy含有面向新的Ansible用户和角色开发人员的文档和视频链接。
此外，用于从Ansible Galaxy获取和管理角色的ansible-galaxy命令也可用于为您的项目获取和管理自有的git存储库中的角色。
获取Ansible Galaxy帮助
通过Ansible Galaxy网站主页上的Documenttaion标签，可以进入描述如何使用Ansible Galaxy的页面。其中包含了介绍如何从Ansible Galaxy下载和使用角色的内容。该页面也提供关于如何开发角色并上传到Ansible Galaxy的说明。
浏览Ansible Galaxy中的角色
通过Ansible Galaxy网站主页上左侧的Search标签，用户可以访问关于Ansible Galaxy上发布的角色的信息。用户可以使用标记通过角色的名称或通过其他角色属性来搜索Ansible角色。结果按照Best Match分数降序排列，此分数依据角色质量、角色受欢迎程度和搜索条件计算而得。
Ansible Galaxy命令行工具
从命令行搜索角色
ansible-galaxy search子命令在Ansible Galaxy中搜索角色。如果以参数形式指定了字符串，则可用于按照关键字在Ansible Galaxy中搜索角色。用户可以使用–author、–platforms和–galaxy-tags选项来缩小搜索结果的范围。也可以将这些选项用作主要的搜索键。例如，命令ansible-galaxy search --author geerlingguy将显示由用户geerlingguy提交的所有角色。
// 显示了包含redis并且适用于企业Linux(EL)平台的角色的名称
[root@ansible ansible]# ansible-galaxy search 'redis' --platforms ELFound 235 roles matching your search:Name Description---- -----------0x0i.consul Consul - a service discovery, mesh and co>0x0i.grafana Grafana - an analytics and monitoring obs>0x5a17ed.ansible_role_netbox Installs and configures NetBox, a DCIM su>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 Linux
?......省略
ansible-galaxy info子命令显示与角色相关的更多详细信息。Ansible Galaxy从多个位置获取这一信息，包括角色的meta/main.yml文件及其GigHub存储库。
[root@localhost ansible]# ansible-galaxy role info robertdebock.httpdRole: robertdebock.httpddescription: Install and configure httpd on your system.active: Truecommit: 9fc0e5c1f38873f26c1d896d7db1424b2e07181bcommit_message: 404 is also good.commit_url: https://api.github.com/repos/robertdebock/ansible-role-httpd/git/commi>company: nonecreated: 2017-11-10T16:04:25.981866Zdownload_count: 141065forks_count: 11github_branch: mastergithub_repo: ansible-role-httpdgithub_user: robertdebockid: 21855imported: 2021-08-02T02:10:26.984862-04:00is_valid: Trueissue_tracker_url: https://github.com/robertdebock/ansible-role-httpd/issueslicense: Apache-2.0min_ansible_version: 2.10modified: 2021-08-02T06:10:26.994045Zopen_issues_count: 1path: ('/root/.ansible/roles', '/usr/share/ansible/roles', '/etc/ansible/roles')role_type: ANSstargazers_count: 6travis_status_url:
从Ansible Galaxy安装角色
ansible-galaxy install子命令从Ansible Galaxy下载角色，并将它安装到控制节点本地。
默认情况下，角色安装到用户的roles_path下的第一个可写目录中。根据为Ansible设置的默认roles_path，角色通常将安装到用户的~/.ansible/roles目录。默认的roles_path可能会被用户当前Ansible配置文件或环境变量ANSIBLE_ROLES_PATH覆盖，这将影响ansible-galaxy的行为。
用户可以通过使用-p DIRECTORY选项，指定具体的目录来安装角色
#ansible-galaxy安装角色robertdebock.httpd
#ansible galaxy 默认安装位置
[root@localhost ansible]# ansible-galaxy role install robertdebock.httpd
- downloading role 'httpd', owned by robertdebock
- downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/7.0.0.tar.gz
- extracting robertdebock.httpd to /root/.ansible/roles/robertdebock.httpd
- robertdebock.httpd (7.0.0) was installed successfully
[root@localhost ansible]# cd /root/.ansible/roles/
[root@localhost roles]# ls
robertdebock.httpd// 指定安装位置
[root@ansible ansible]# ansible-galaxy role install robertdebock.httpd -p /etc/ansible/playbook/roles/
- downloading role 'httpd', owned by robertdebock
- downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/7.0.0.tar.gz
- extracting robertdebock.httpd to /etc/ansible/playbook/roles/robertdebock.httpd
- robertdebock.httpd (7.0.0) was installed successfully
[root@ansible ansible]# cd playbook/roles/
[root@ansible roles]# ls
httpd httpd.tar.gz robertdebock.httpd
使用要求文件安装角色
可以使用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。
重要
应当在requirements.yml文件中指定角色版本，特别是生产环境中的playbook。
如果不指定版本，将会获取角色的最新版本。如果作者对角色做出了更改，并与用户的playbook不兼容，这可能会造成自动化失败或其他问题。
// 使用文件安装
[root@ansible roles]# cat robertdebock.yml robertdebock.httpd
- src: robertdebock.httpdversion: "7.0.0"[root@ansible roles]# ansible-galaxy role install -r robertdebock.yml
- downloading role 'httpd', owned by robertdebock
- downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/7.0.0.tar.gz
- extracting robertdebock.httpd to /root/.ansible/roles/robertdebock.httpd
- robertdebock.httpd (7.0.0) was installed successfully[root@ansible roles]# ls
httpd httpd.tar.gz robertdebock.yml
若要使用角色文件来安装角色，可使用-r REQUIREMENTS-FILE选项：
ansible-galaxy install -r roles/requirements.yml -p roles
用户可以使用ansible-galaxy来安装不在Ansible Galaxy中的角色。可以在私有的Git存储库或Web服务器上托管自有的专用或内部角色。下例演示了如何利用各种远程来源配置要求文件。
[root@ansibleproject]# 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关键字可以是与严自角色的软件存储库的分支、标记或提交哈希对应的任何值。
若要安装与playbook项目关联的角色，可执行ansible-galaxy install命令：
ansible-galaxy install -r roles/requirements.yml -p roles
管理下载的角色
ansible-galaxy命令也可管理本地的角色，如位于playbook项目的roles目录中的角色。ansible-galaxy list子命令列出本地找到的角色。
[root@ansible ansible]# ansible-galaxy role list
# /root/.ansible/roles
- robertdebock.httpd, 7.0.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)
- linux-system-roles.logging, (unknown version)
- linux-system-roles.metrics, (unknown version)
- linux-system-roles.nbde_client, (unknown version)
- linux-system-roles.nbde_server, (unknown version)
- linux-system-roles.network, (unknown version)
...... 省略
使用ansible-galaxy remove子命令本地删除角色
[root@ansible ansible]# ansible-galaxy remove robertdebock.httpd
- successfully removed robertdebock.httpd[root@ansible ansible]# ansible-galaxy role list |grep robertdebock.httpd #查看
[root@ansible ansible]#
在playbook中使用下载并安装的角色的方式与任何其他角色都一样。在roles部分中利用其下载的角色名称来加以引用。如果角色不在项目的roles目录中，则将检查roles_path来查看角色是否安装在了其中一个目录中，将使用第一个匹配项。以下use-role.ymlplaybook引用了redis_prod和geerlingguy.redis角色：
[root@ansible 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
此playbook使不同版本的geerlingguy.redis角色应用到生产和开发服务器。借助这种方式可以对角色更改进行系统化测试和集成，然后再部署到生产服务器上。如果角色的近期更改造成了问题，则借助版本控制来开发角色，就能回滚到过去某一个稳定的角色版本。