Galaxy 用户指南

Ansible Galaxy 指的是 Galaxy 网站，这是一个用于查找、下载和共享社区开发的集合（collections）和角色（roles）的免费站点。

使用 Galaxy，您可以利用 Ansible 社区提供的优质内容来启动您的自动化项目。Galaxy 提供了预打包的工作单元，例如 角色 (roles) 和 集合 (collections)。集合格式提供了一个全面的自动化包，其中可能包含多个 Playbook、角色、模块和插件。有关 Galaxy 的完整详细信息，请参阅 Galaxy 文档。

在 Galaxy 上查找集合

要在 Galaxy 上查找集合

  1. 点击左侧导航栏中的 Collections > Collections。

  2. 输入您的搜索词。您可以按关键词、标签和命名空间进行过滤。

Galaxy 会显示符合您搜索条件的集合列表。

有关安装和使用集合的完整详细信息，请参阅 使用 Ansible 集合。

在 Galaxy 上查找角色

要查找独立角色（即不属于集合的角色）

  1. 点击左侧导航栏中的 Roles > Roles。

  2. 输入您的搜索词。您可以按关键词、标签和命名空间进行过滤。

Galaxy 会显示符合您搜索条件的角色列表。

您也可以选择使用 ansible-galaxy CLI 命令，按标签、平台、作者和多个关键词搜索 Galaxy 数据库。

$ ansible-galaxy role search elasticsearch --author geerlingguy

搜索命令将返回匹配您搜索的前 1000 个结果列表。 

Found 6 roles matching your search:

 Name                             Description
 ----                             -----------
geerlingguy.elasticsearch         Elasticsearch for Linux.
geerlingguy.elasticsearch-curator Elasticsearch curator for Linux.
geerlingguy.filebeat              Filebeat for Linux.
geerlingguy.fluentd               Fluentd for Linux.
geerlingguy.kibana                Kibana for Linux.

获取有关角色的更多信息

使用 info 命令查看有关特定角色的更多详细信息

$ ansible-galaxy role info username.role_name

这将返回在 Galaxy 中为该角色找到的所有信息 

Role: username.role_name
    description: Installs and configures a thing, a distributed, highly available NoSQL thing.
    active: True
    commit: c01947b7bc89ebc0b8a2e298b87ab416aed9dd57
    commit_message: Adding travis
    commit_url: https://github.com/username/repo_name/commit/c01947b7bc89ebc0b8a2e298b87ab
    company: My Company, Inc.
    created: 2015-12-08T14:17:52.773Z
    download_count: 1
    forks_count: 0
    github_branch: main
    github_repo: repo_name
    github_user: username
    id: 6381
    is_valid: True
    issue_tracker_url:
    license: Apache
    min_ansible_version: 2.15
    modified: YYYY-MM-DDTHH:MM:SS.000Z
    namespace: username
    open_issues_count: 0
    path: /Users/username/projects/roles
    role_type: ANS
    stargazers_count: 0
    travis_status_url: https://travis-ci.org/username/repo_name.svg?branch=main

从 Galaxy 安装角色

ansible-galaxy 命令随 Ansible 一起捆绑，您可以使用它从 Galaxy 或直接从基于 Git 的 SCM 安装角色。您还可以使用它创建新角色、删除角色或在 Galaxy 网站上执行任务。

默认情况下，命令行工具使用服务器地址 https://galaxy.ansible.com 与 Galaxy 网站 API 通信。如果您运行自己的内部 Galaxy 服务器并希望使用它而不是默认服务器，请传递 --server 选项，后跟该 Galaxy 服务器的地址。您可以通过在 ansible.cfg 文件中设置 Galaxy 服务器值来永久设置此选项。有关在 ansible.cfg 中设置值的详细信息，请参阅 GALAXY_SERVER。

安装角色

使用 ansible-galaxy 命令从 Galaxy 网站 下载角色

$ ansible-galaxy role install namespace.role_name

设置角色安装位置

默认情况下，Ansible 将角色下载到默认路径列表中的第一个可写目录 ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles。这会将角色安装在运行 ansible-galaxy 的用户的主目录中。

您可以使用以下选项之一覆盖此设置

  • 在您的会话中设置环境变量 ANSIBLE_ROLES_PATH。

  • 对 ansible-galaxy 命令使用 --roles-path 选项。

  • 在 ansible.cfg 文件中定义 roles_path。

以下示例演示了如何使用 --roles-path 将角色安装到当前工作目录

$ ansible-galaxy role install --roles-path . geerlingguy.apache

另请参阅

配置 Ansible

关于配置文件的所有内容

安装特定版本的角色

当 Galaxy 服务器导入角色时，它会将任何符合 语义版本控制 (Semantic Version) 格式的 Git 标签作为版本导入。因此，您可以通过指定导入的标签之一来下载特定版本的角色。

要查看角色的可用版本

  1. 在 Galaxy 搜索页面上找到该角色。

  2. 点击名称查看更多详细信息，包括可用版本。

要从 Galaxy 安装特定版本的角色，请附加逗号和 GitHub 发行版标签的值。例如

$ ansible-galaxy role install geerlingguy.apache,3.2.0

也可以直接指向 Git 存储库并指定分支名称或提交哈希作为版本。例如，以下命令将安装特定提交

$ ansible-galaxy role install git+https://github.com/geerlingguy/ansible-role-apache.git,0b7cd353c0250e87a26e0499e59e7fd265cc2f25

从文件安装多个角色

您可以通过将角色包含在 requirements.yml 文件中来安装多个角色。该文件的格式为 YAML，文件扩展名必须是 .yml 或 .yaml。

使用以下命令安装 requirements.yml 中包含的角色：

$ ansible-galaxy install -r requirements.yml

同样，扩展名很重要。如果省略 .yml 扩展名，ansible-galaxy CLI 会假定该文件使用旧的、现已弃用的“基本”格式。

文件中的每个角色都将具有以下一个或多个属性

src

角色的来源。如果从 Galaxy 下载，请使用 namespace.role_name 格式；否则，请提供指向基于 Git 的 SCM 中存储库的 URL。请参阅下面的示例。这是一个必需属性。

scm

指定 SCM。截至撰写本文时，仅允许使用 git 或 hg。请参阅下面的示例。默认为 git。

version

要下载的角色版本。提供发行版标签值、提交哈希或分支名称。默认为存储库中设置为默认的分支，否则默认为 master。

name

将角色下载为特定名称。从 Galaxy 下载时默认为 Galaxy 名称，否则默认为存储库名称。

使用以下示例作为在 requirements.yml 中指定角色的指南 

# from galaxy
- name: yatesr.timezone

# from locally cloned Git repository (git+file:// requires full paths)
- src: git+file:///home/bennojoy/nginx

# from GitHub
- src: https://github.com/bennojoy/nginx

# from GitHub, overriding the name and specifying a specific tag
- name: nginx_role
  src: https://github.com/bennojoy/nginx
  version: main

# from GitHub, specifying a specific commit hash
- src: https://github.com/bennojoy/nginx
  version: "ee8aa41"

# from a webserver, where the role is packaged in a tar.gz
- name: http-role-gz
  src: https://some.webserver.example.com/files/main.tar.gz

# from a webserver, where the role is packaged in a tar.bz2
- name: http-role-bz2
  src: https://some.webserver.example.com/files/main.tar.bz2

# from a webserver, where the role is packaged in a tar.xz (Python 3.x only)
- name: http-role-xz
  src: https://some.webserver.example.com/files/main.tar.xz

# from Bitbucket
- src: git+https://bitbucket.org/willthames/git-ansible-galaxy
  version: v1.4

# from Bitbucket, alternative syntax and caveats
- src: https://bitbucket.org/willthames/hg-ansible-galaxy
  scm: hg

# from GitLab or other git-based scm, using git+ssh
- src: git@gitlab.company.com:mygroup/ansible-core.git
  scm: git
  version: "0.1"  # quoted, so YAML doesn't parse this as a floating-point value

警告

将凭据嵌入到 SCM URL 中是不安全的。出于安全考虑，请确保使用安全的身份验证选项。例如，使用 SSH、netrc 或 Git 配置中的 http.extraHeader/url.<base>.pushInsteadOf，以防止您的凭据在日志中被泄露。

从同一个 requirements.yml 文件安装角色和集合

您可以从同一个 requirements 文件安装角色和集合 

---
roles:
  # Install a role from Ansible Galaxy.
  - name: geerlingguy.java
    version: "1.9.6" # note that ranges are not supported for roles

collections:
  # Install a collection from Ansible Galaxy.
  - name: community.general
    version: ">=7.0.0"
    source: https://galaxy.ansible.com

从多个文件安装多个角色

对于大型项目，requirements.yml 文件中的 include 指令提供了将大型文件拆分为多个较小文件的功能。

例如，项目可能有一个 requirements.yml 文件和一个 webserver.yml 文件。

下面是 webserver.yml 文件的内容 

# from github
- src: https://github.com/bennojoy/nginx

# from Bitbucket
- src: git+https://bitbucket.org/willthames/git-ansible-galaxy
  version: v1.4

以下显示了 requirements.yml 文件的内容，该文件现在包含了 webserver.yml 文件 

# from galaxy
- name: yatesr.timezone
- include: <path_to_requirements>/webserver.yml

要从两个文件中安装所有角色，请在命令行上传递根文件（在本例中为 requirements.yml），如下所示 

$ ansible-galaxy role install -r requirements.yml

依赖项

角色也可以依赖于其他角色，当您安装具有依赖项的角色时，这些依赖项将自动安装到 roles_path 中。

定义角色依赖项有两种方法

  • 使用 meta/requirements.yml

  • 使用 meta/main.yml

使用 meta/requirements.yml

2.10 版本新增。

您可以创建 meta/requirements.yml 文件，并以 从文件安装多个角色 部分中描述的用于 requirements.yml 的相同格式定义依赖项。

此后，您可以在任务中导入或包含指定的角色。

使用 meta/main.yml

或者，您可以在 meta/main.yml 文件中指定角色依赖项，方法是在 dependencies 部分下提供角色列表。如果角色的来源是 Galaxy，您可以简单地以 namespace.role_name 格式指定角色。您也可以使用 requirements.yml 中更复杂的格式，从而提供 src、scm、version 和 name。

以这种方式安装的依赖项，取决于下面描述的其他因素，也将在 Play 执行期间此角色执行之前执行。要更好地理解在 Play 执行期间如何处理依赖项，请参阅 角色。

以下显示了一个包含依赖角色的 meta/main.yml 示例文件 

---
dependencies:
  - geerlingguy.java

galaxy_info:
  author: geerlingguy
  description: Elasticsearch for Linux.
  company: "Midwestern Mac, LLC"
  license: "license (BSD, MIT)"
  min_ansible_version: 2.4
  galaxy_tags:
    - web
    - system
    - monitoring
    - logging
    - lucene
    - elk
    - elasticsearch

标签会向下继承到依赖链中。为了将标签应用于角色及其所有依赖项，标签应应用于角色，而不是角色内的所有任务。

列为依赖项的角色受条件语句和标签过滤的影响，并可能根据应用了哪些标签和条件语句而无法完全执行。

如果角色的来源是 Galaxy，请以 namespace.role_name 格式指定角色 

dependencies:
  - geerlingguy.apache
  - geerlingguy.ansible

或者，您可以按照以下方式以 requirements.yml 中使用的复杂形式指定角色依赖项 

dependencies:
  - name: geerlingguy.ansible
  - name: composer
    src: git+https://github.com/geerlingguy/ansible-role-composer.git
    version: 775396299f2da1f519f0d8885022ca2d6ee80ee8

注意

Galaxy 期望所有角色依赖项都存在于 Galaxy 中，因此依赖项需以 namespace.role_name 格式指定。如果您导入了一个具有依赖项的角色，且该依赖项的 src 值为 URL，则导入过程将失败。

列出已安装的角色

使用 list 显示 roles_path 中安装的每个角色的名称和版本。 

$ ansible-galaxy role list
  - namespace-1.foo, v2.7.2
  - namespace2.bar, v2.6.2

删除已安装的角色

使用 remove 从 roles_path 中删除角色 

$ ansible-galaxy role remove namespace.role_name

另请参阅

使用 Ansible 集合

可共享的模块、剧本和角色集合

角色 (Roles)

已知目录结构中的可重用任务、处理程序和其他文件

使用命令行工具

执行其他相关操作