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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Значение по умолчанию, если значение переменной узла — `None` или пустая строка. Этот параметр нельзя использовать одновременно с `keyed_groups[].trailing_separator`.
key строка	Ключ входного словаря, используемый для создания групп.
parent_group строка	Родительская группа для группы, заданной по ключу.
prefix строка	Имя группы, заданной по ключу, будет начинаться с этого префикса. По умолчанию: `""`
separator строка	Разделитель, используемый для формирования имени группы, заданной по ключу. По умолчанию: `"_"`
trailing_separator логическое значение добавлено в ansible-core 2.12	Установите этот параметр в `false`, чтобы не добавлять `keyed_groups[].separator` после переменной узла, если её значение равно `None` или является пустой строкой. Этот параметр нельзя использовать одновременно с `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`
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` ← (по умолчанию)

Примечание

Перечисленные выше записи конфигурации для каждого типа записей (переменная Ansible, переменная окружения и т. д.) упорядочены от низкого к высокому приоритету. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

На этом этапе инвентарные данные еще не окончательно сформированы, поэтому автоматически заполненные группы all и ungrouped будут содержать только то, что в них явно добавили предыдущие источники инвентаризации.
Во время построения инвентарных данных недоступны динамические «магические переменные». Например, groups и hostvars еще не существуют.

Примеры

---
# 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/gitlab_runners_inventory.html