community.general.gitlab_runners 清单 – 用于 GitLab runners 的 Ansible 动态清单插件。

注意

此清单插件是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此清单插件，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.general.gitlab_runners。

概要 

从 GitLab API 读取清单。
使用 YAML 配置文件 gitlab_runners.[yml|yaml]。

要求 

在执行此清单的本地控制器节点上需要以下要求。

python-gitlab > 1.8.0

参数 

参数	注释
api_token 别名：private_token, access_token 字符串	用于登录的 GitLab 令牌。配置环境变量：`GITLAB_API_TOKEN` 在 community.general 1.0.0 中添加
compose 字典	从 jinja2 表达式创建变量。默认值： `{}`
filter 字符串	从 GitLab API 过滤 runners 选择 `"active"` `"paused"` `"online"` `"specific"` `"shared"` 配置环境变量：`GITLAB_FILTER` 在 community.general 1.0.0 中添加
groups 字典	基于 Jinja2 条件将主机添加到组。默认值： `{}`
keyed_groups 列表 / 元素=字典	基于变量的值将主机添加到组。默认值： `[]`
default_value 字符串在 ansible-core 2.12 中添加	当主机变量的值为空字符串时，默认值。此选项与 `keyed_groups[].trailing_separator` 互斥。
key 字符串	用于生成组的输入字典中的键
parent_group 字符串	keyed group 的父组
prefix 字符串	keyed 组名称将以此前缀开头默认值： `""`
separator 字符串	用于构建 keyed 组名称的分隔符默认值： `"_"`
trailing_separator 布尔值在 ansible-core 2.12 中添加	将此选项设置为 `False` 以在值为空字符串时省略主机变量后的 `keyed_groups[].separator`。此选项与 `keyed_groups[].default_value` 互斥。选择 `false` `true` ← (默认)
leading_separator 布尔值在 ansible-core 2.11 中添加	与 keyed_groups 结合使用。默认情况下，不提供前缀或分隔符的 keyed 组的名称将以下划线开头。这是因为默认前缀是 ""，默认分隔符是 "_"。如果未提供前缀，则将此选项设置为 False 可以省略前导下划线（或其他分隔符）。如果组名称是从映射派生的，则仍会使用分隔符来连接各项。如果完全不想在组名称中使用分隔符，请将键控组的分隔符设置为空字符串。选择 `false` `true` ← (默认)
plugin 字符串 / 必需	此插件的名称，应该始终设置为 'gitlab_runners'，以便此插件将其识别为自身。选择 `"gitlab_runners"` `"community.general.gitlab_runners"`
server_url 字符串 / 必需	GitLab 服务器的 URL，包含协议（例如 http 或 https）。配置环境变量： `GITLAB_SERVER_URL` 在 community.general 1.0.0 中添加
strict 布尔值	如果为 `yes`，则将无效条目视为致命错误；否则跳过并继续。由于可以在表达式中使用 facts，它们可能并非总是可用，默认情况下我们会忽略这些错误。选择 `false` ← (默认) `true`
use_extra_vars 布尔值在 ansible-core 2.11 中添加	将额外的变量合并到可用于组合的变量中（优先级最高）。选择 `false` ← (默认) `true` 配置 INI 条目 [inventory_plugins] use_extra_vars = false 环境变量： `ANSIBLE_INVENTORY_USE_EXTRA_VARS`
verbose_output 布尔值	切换以（不）包含所有可用节点的元数据选择 `false` `true` ← (默认)

示例 

# 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

作者

Stefan Heitmüller (@morph027)

提示

每个条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。