community.general.gitlab_runners – Подключаемый модуль динамического инвентаря Ansible для GitLab runners.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.gitlab_runners.
Описание
- Считывает инвентаризацию из API GitLab.
- Использует файл конфигурации YAML gitlab_runners.[yml|yaml].
Требования
Ниже приведены требования к локальному контроллеру, на котором выполняется этот инвентарь.
- python >= 2.7
- python-gitlab > 1.8.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| api_token строка | env:GITLAB_API_TOKEN добавлен в 1.0.0 community.general | Токен GitLab для входа. Псевдонимы: private_token, access_token | |
| compose словарь | По умолчанию: {} | Создавать переменные из выражений Jinja2. | |
| filter строка |
| env:GITLAB_FILTER добавлен в 1.0.0 community.general | Фильтр runners из API GitLab |
| groups словарь | По умолчанию: {} | Добавлять узлы в группу на основе условных выражений Jinja2. | |
| keyed_groups список / элементы=строка | По умолчанию: [] | Добавлять узлы в группу на основе значений переменной. | |
| leading_separator логическое значение добавлен в 2.11 ansible.builtin |
| Использовать в сочетании с keyed_groups. По умолчанию, ключевая группа, у которой нет префикса или разделителя, будет иметь имя, начинающееся с подчеркивания. Это потому, что по умолчанию префикс — "" и разделитель — "_". Установите этот параметр в значение False, чтобы опустить ведущее подчеркивание (или другой разделитель), если префикс не указан. Если имя группы получено из отображения, разделитель все равно используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для ключевой группы в пустую строку. | |
| plugin строка / обязательно |
| Имя этого плагина, оно должно всегда устанавливаться в 'gitlab_runners', чтобы этот плагин его распознал, как свой. | |
| server_url строка / обязательно | По умолчанию: "https://gitlab.com" | env:GITLAB_SERVER_URL добавлен в 1.0.0 community.general | URL сервера GitLab с протоколом (например, http или https). |
| strict логическое значение |
| Если yes, сделать некорректные записи фатальной ошибкой, иначе пропустить и продолжить.Поскольку в выражениях можно использовать факты, они могут быть не всегда доступны, и мы по умолчанию игнорируем эти ошибки. | |
| use_extra_vars логическое значение добавлен в 2.11 ansible.builtin |
| записи ini: [inventory_plugins] env:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Объединить дополнительные переменные с доступными переменными для композиции (самый высокий приоритет). |
| verbose_output логическое значение |
| Включить (или выключить) отображение всех метаданных доступных узлов |
Примеры
# 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) <stefan.heitmueller@gmx.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gitlab_runners_inventory.html
