community.general.gitlab_runners inventory – GitLab Runner 的 Ansible 动态 Inventory 插件。
注意
此 Inventory 插件是 community.general 集合 (版本 10.1.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此 Inventory 插件，有关详细信息，请参见 要求。
要在 playbook 中使用它，请指定：community.general.gitlab_runners。
概要
从 GitLab API 读取清单。
使用 YAML 配置文件 gitlab_runners.[yml|yaml]。
要求
以下要求在执行此清单的本地控制器节点上是必需的。
python-gitlab > 1.8.0
参数
参数 |
注释 |
|---|---|
从 jinja2 表达式创建变量。 默认值： |
|
从 GitLab API 过滤 Runner 选项
配置
|
|
基于 Jinja2 条件将主机添加到组。 默认值： |
|
基于变量的值将主机添加到组。 默认值： |
|
主机变量的值为空字符串时的默认值。 此选项与 |
|
用于生成组的输入字典中的键。 |
|
键控组的父组。 |
|
键控组名称将以此前缀开头。 默认值： |
|
用于构建键控组名称的分隔符。 默认值： |
|
将此选项设置为 此选项与 选项
|
|
与 默认情况下，未提供前缀或分隔符的键控组的名称将以下划线开头。 这是因为默认前缀为 如果未给出前缀，则将此选项设置为 如果组名来自映射，则分隔符仍用于连接项目。 要根本不使用组名中的分隔符，请将键控组的分隔符设置为空字符串。 选项
|
|
此插件的名称，对于此插件将其识别为自身，应始终设置为“gitlab_runners”。 选项
|
|
如果为 由于表达式中可以使用facts，因此它们可能并不总是可用，我们默认忽略这些错误。 选项
|
|
将额外的变量合并到可用于组合的变量中（最高优先级）。 选项
配置
|
|
切换是否包含所有可用的节点元数据 选项
|
示例
# gitlab_runners.yml
plugin: community.general.gitlab_runners
host: https://gitlab.com
# Example using constructed features to create groups and set ansible_host
plugin: community.general.gitlab_runners
host: https://gitlab.com
strict: false
keyed_groups:
# add e.g. amd64 hosts to an arch_amd64 group
- prefix: arch
key: 'architecture'
# add e.g. linux hosts to an os_linux group
- prefix: os
key: 'platform'
# create a group per runner tag
# e.g. a runner tagged w/ "production" ends up in group "label_production"
# hint: labels containing special characters will be converted to safe names
- key: 'tag_list'
prefix: tag