community.general.gitlab_runners — Плагин динамической инвентаризации Ansible для GitLab runners.
Примечание
Этот плагин входит в состав коллекции community.general (версия 1.3.2).
Для его установки используйте: 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 список / элементы=строка |
По умолчанию: [] |
Добавление хостов в группу на основе значений переменной. |
|
| plugin строка / обязательно |
|
Имя этого плагина, оно должно всегда быть установлено в 'gitlab_runners', чтобы плагин мог распознать его как собственный. |
|
| server_url строка / обязательно |
По умолчанию: "https://gitlab.com" |
env:GITLAB_SERVER_URL добавлен в 1.0.0 community.general |
URL сервера GitLab, включая протокол (например, http или https). |
| strict булево |
|
Если yes, то некорректные записи будут считаться ошибкой, иначе они будут пропущены и обработка продолжена.Так как в выражениях могут использоваться факты, они не всегда могут быть доступны, и по умолчанию эти ошибки игнорируются. |
|
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/gitlab_runners_inventory.html