community.general.gitlab_runners инвентаризация – плагин динамической инвентаризации Ansible для GitLab runners.

Примечание

Этот плагин инвентаризации входит в коллекцию community.general (версия 9.5.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого плагина инвентаризации требуются дополнительные зависимости, см. Требования для подробностей.

Чтобы использовать его в книге задач, укажите: community.general.gitlab_runners.

Обзор
Требования
Параметры
Примеры

Обзор

Считывает инвентаризацию из API GitLab.
Использует 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 строка	фильтр агентов из API GitLab Возможные значения: `"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 строка	родительская группа для группировки по ключу
prefix строка	Имя группы по ключу будет начинаться с этого префикса По умолчанию: `""`
separator строка	Разделитель, используемый для построения имени группы по ключу По умолчанию: `"_"`
trailing_separator логическое добавлено в ansible-core 2.12	Установите этот параметр в `False`, чтобы исключить `keyed_groups[].separator` после переменной хоста, когда значение пустая строка. Этот параметр несовместим с `keyed_groups[].default_value`. Возможные значения: `false` `true` ← (по умолчанию)
leading_separator логическое добавлено в ansible-core 2.11	Используется совместно с keyed_groups. По умолчанию, группа по ключу, у которой нет префикса или разделителя, будет иметь имя, начинающееся с нижнего подчеркивания. Это происходит потому, что префикс по умолчанию — «», а разделитель по умолчанию — «_». Установите этот параметр в False, чтобы исключить ведущее подчеркивание (или другой разделитель), если префикс не задан. Если имя группы получено из отображения, разделитель по-прежнему используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для группы по ключу в пустую строку. Возможные значения: `false` `true` ← (по умолчанию)
plugin строка / обязательно	Имя этого плагина, его всегда следует устанавливать в ‘gitlab_runners’, чтобы этот плагин распознал его как собственный. Возможные значения: `"gitlab_runners"` `"community.general.gitlab_runners"`
server_url строка / обязательно	URL сервера GitLab с протоколом (например, http или https). Настройка: Переменная окружения: `GITLAB_SERVER_URL` добавлено в community.general 1.0.0
strict логическое	Если `yes` считать недопустимые записи ошибкой, иначе пропустить и продолжить. Поскольку в выражениях можно использовать факты, они могут не всегда быть доступны, и мы по умолчанию игнорируем эти ошибки. Возможные значения: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

use_extra_vars

boolean

added in ansible-core 2.11

Объединить дополнительные переменные в доступные переменные для композиции (высший приоритет).

Варианты:

false ← (по умолчанию)
true

Настройка:

Запись INI:

[inventory_plugins]
use_extra_vars = false

Переменная среды: ANSIBLE_INVENTORY_USE_EXTRA_VARS

verbose_output

boolean

Включить (или нет) все доступные метаданные узлов.

Варианты:

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)

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_runners_inventory.html