Ansible--使用ansible galaxy部署角色

    科技2022-07-10  128

    使用ansible galaxy部署角色

    1.介绍ansible galaxy

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

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

    1.1 获取Ansible Galaxy帮助

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

    1.2 浏览Ansible Galaxy中的角色

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

    2 . Ansible Galaxy命令行工具

    2.1 从命令行搜索角色

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

    命令ansible-galaxy search --author geerlingguy将显示由用户geerlingguy提交的所有角色。 [root@ansible ~]# ansible-galaxy search --author geerlingguy Found 99 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> geerlingguy.awx-container Ansible AWX container for Docker. geerlingguy.backup Backup for Simple Servers. 略...

    结果按照字母顺序显示,而不是Best Match分数降序排列。

    下例显示了包含redis并且适用于企业Linux(EL)平台的角色的名称。 [root@ansible ~]# ansible-galaxy search 'redis' --platforms EL Found 221 roles matching your search: Name Description ---- ----------- 0x0i.consul Consul - a service discovery> 0x0i.grafana Grafana - an analytics and m> 0x5a17ed.ansible_role_netbox Installs and configures NetB> 1it.sudo Ansible role for managing su> adfinis-sygroup.redis Ansible role for Redis AerisCloud.librato Install and configure the Li> AerisCloud.redis Installs redis on a server AlbanAndrieu.java Manage Java installation 略...

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

    以下命令显示了Ansible Galaxy提供的geerlingguy.redis角色的相关信息。 [root@ansible ~]# ansible-galaxy info geerlingguy.redis Role: geerlingguy.redis 平台说明 description: Redis for Linux 是否能用 active: True 特征码 commit: 4f6fbdff6b566a596b2eaac168f88be820d4bbc5 忽略 commit_message: Ignore the tyranny of ansible-lint rule 106. 提交的url commit_url: https://api.github.com/repos/geerlingguy/ansible-role-red> 所属公司 company: Midwestern Mac, LLC 创建时间 created: 2014-03-06T16:48:12.451903Z 下载次数 download_count: 378170 转载次数 forks_count: 131 放置位置 github_branch: master github_repo: ansible-role-redis github_user: geerlingguy id: 468 进口 imported: 2020-09-18T15:06:33.499261-04:00 is_valid: True issue_tracker_url: https://github.com/geerlingguy/ansible-role-redis/> 许可 license: license (BSD, MIT) min_ansible_version: 2.4 modified: 2020-09-18T19:06:33.507214Z open_issues_count: 6 路径 path: ('/root/.ansible/roles', '/usr/share/ansible/roles', '/etc/ansi> role_type: ANS stargazers_count: 161 travis_status_url: https://travis-ci.org/geerlingguy/ansible-role-red> (END)
    2.2 从Ansible Galaxy安装角色

    ansible-galaxy install子命令从Ansible Galaxy下载角色,并将它安装到控制节点本地。

    默认情况下,角色安装到用户的roles_path下的第一个可写目录中。根据为Ansible设置的默认roles_path,角色通常将安装到用户的~/.ansible/roles目录。默认的roles_path可能会被用户当前Ansible配置文件或环境变量ANSIBLE_ROLES_PATH覆盖,这将影响ansible-galaxy的行为。

    安装角色geerlingguy.redis [root@ansible ~]# ansible-galaxy install geerlingguy.redis - downloading role 'redis', owned by geerlingguy - downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz - extracting geerlingguy.redis to /root/.ansible/roles/geerlingguy.redis - geerlingguy.redis (1.6.0) was installed successfully 查看安装位置,在当前目录的ansible/roles/里 [root@ansible ~]# ls .ansible/roles/ geerlingguy.redis

    用户可以通过使用-p 选项,指定具体的目录来安装角色。

    在下例中,ansible-galaxy将geerlingguy.redis角色安装到playbook项目的roles目录中。命令的当前工作目录是/project

    [root@ansible project]# ls playbook.yml roles [root@ansible project]# ansible-galaxy install geerlingguy.redis -p roles/ - downloading role 'redis', owned by geerlingguy - downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz - extracting geerlingguy.redis to /project/roles/geerlingguy.redis - geerlingguy.redis (1.6.0) was installed successfully [root@ansible project]# ls roles/ geerlingguy.redis httpd [root@ansible project]# pwd /project

    3.使用要求文件安装角色

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

    src属性指定角色的来源,本例中为来自Ansible Galaxy的geerlingguy.redis角色。version属性是可选的,指定要安装的角色版本,本例中为1.5.0。例如,一个用于安装geerlingguy.redis的简单requirements.yml可能类似于如下:

    [root@ansible roles]# ls geerlingguy.redis httpd [root@ansible roles]# rm -rf geerlingguy.redis/ //先删掉刚下载的角色 [root@ansible roles]# ls httpd [root@ansible roles]# cat requirements.yml //写个文件添加要下载的角色 - src: geerlingguy.redis - src: robertdebock.httpd -r指定要安装文件的内容,-p指定安装位置 [root@ansible project]# ansible-galaxy install -r roles/requirements.yml -p roles/ - downloading role 'redis', owned by geerlingguy - downloading role from https://github.com/geerlingguy/ansible-role-redis/archive/1.6.0.tar.gz - extracting geerlingguy.redis to /project/roles/geerlingguy.redis - geerlingguy.redis (1.6.0) was installed successfully - downloading role 'httpd', owned by robertdebock - downloading role from https://github.com/robertdebock/ansible-role-httpd/archive/5.3.0.tar.gz - extracting robertdebock.httpd to /project/roles/robertdebock.httpd - robertdebock.httpd (5.3.0) was installed successfully - src: geerlingguy.redis version: "1.5.0" [root@ansible project]# ls roles/ //查看,成功安装角色 geerlingguy.redis httpd requirements.yml robertdebock.httpd

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

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

    [root@localhost project]# 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.redis version: "1.5.0" name: redis_prod # from any Git-based repository, using HTTPS - src: https://gitlab.com/guardianproject-ops/ansible-nginx-acme.git scm: git version: 56e00a54 name: nginx-acme # from any Git-based repository, using SSH - src: git@gitlab.com:guardianproject-ops/ansible-nginx-acme.git scm: git version: master name: nginx-acme-ssh # from a role tar ball, given a URL # supports 'http', 'https', or 'file' protocols - src: file:///opt/local/roles/myrole.tar name: 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.4 管理下载的角色

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

    [root@ansible project]# ansible-galaxy list # /root/.ansible/roles - geerlingguy.redis, 1.6.0 # /usr/share/ansible/roles - linux-system-roles.kdump, (unknown version) - linux-system-roles.network, (unknown version) - linux-system-roles.postfix, (unknown version) - linux-system-roles.selinux, (unknown version) - linux-system-roles.storage, (unknown version) - linux-system-roles.timesync, (unknown version) - rhel-system-roles.kdump, (unknown version) - rhel-system-roles.network, (unknown version) - rhel-system-roles.postfix, (unknown version) - rhel-system-roles.selinux, (unknown version) - rhel-system-roles.storage, (unknown version) - rhel-system-roles.timesync, (unknown version) # /etc/ansible/roles [root@ansible project]# mv roles/* /etc/ansible/roles/ //把所有角色移动到能搜索到的角色目录下 [root@ansible project]# ansible-galaxy list # /root/.ansible/roles - geerlingguy.redis, 1.6.0 # /usr/share/ansible/roles - linux-system-roles.kdump, (unknown version) - linux-system-roles.network, (unknown version) - linux-system-roles.postfix, (unknown version) - linux-system-roles.selinux, (unknown version) - linux-system-roles.storage, (unknown version) - linux-system-roles.timesync, (unknown version) - rhel-system-roles.kdump, (unknown version) - rhel-system-roles.network, (unknown version) - rhel-system-roles.postfix, (unknown version) - rhel-system-roles.selinux, (unknown version) - rhel-system-roles.storage, (unknown version) - rhel-system-roles.timesync, (unknown version) # /etc/ansible/roles //搜的刚下载的两个角色 - geerlingguy.redis, 1.6.0 - httpd, (unknown version) - robertdebock.httpd, 5.3.0

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

    [root@ansible roles]# ansible-galaxy remove geerlingguy.redis [root@ansible roles]# ansible-galaxy list

    在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 machines hosts: redis_prod_servers remote_user: devops become: True roles: - redis_prod - name: use geerlingguy.redis for Dev machines hosts: redis_dev_servers remote_user: devops become: True roles: - geerlingguy.redis

    此playbook使不同版本的geerlingguy.redis角色应用到生产和开发服务器。借助这种方式可以对角色更改进行系统化测试和集成,然后再部署到生产服务器上。如果角色的近期更改造成了问题,则借助版本控制来开发角色,就能回滚到过去某一个稳定的角色版本。

    Processed: 0.008, SQL: 8