community.general.gitlab_runner – Создание, изменение и удаление GitLab Runners.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.gitlab_runner.
Описание
- Регистрация, обновление и удаление runners с помощью GitLab API.
- Все операции выполняются с помощью GitLab API v4.
- Подробную информацию смотрите в полной документации API по адресу https://docs.gitlab.com/ee/api/runners.html.
- Для всех операций требуется действительный приватный API-токен. Вы можете создать любое количество токенов с помощью веб-интерфейса GitLab по адресу https://$GITLAB_URL/profile/personal_access_tokens.
- Для регистрации нового runner требуется действительный токен регистрации. Для создания общих runners вам необходимо попросить администратора предоставить вам этот токен. Его можно найти по адресу https://$GITLAB_URL/admin/runners/.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.
- python >= 2.7
- python-gitlab >= 1.5.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access_level строка |
| Определяет, может ли runner получать задания из защищенных ветвей. |
| active логическое |
| Определяет, будет ли runner сразу активным после создания. |
| api_password строка | Пароль для аутентификации на API. | |
| api_token строка | Ваш приватный токен для взаимодействия с GitLab API. | |
| api_url строка | Адрес API. | |
| api_username строка | Имя пользователя для аутентификации на API. | |
| description строка / обязательно | Уникальное имя runner. псевдонимы: имя | |
| locked логическое |
| Определяет, заблокирован ли runner. |
| maximum_timeout целое число | По умолчанию: 3600 | Максимальное время ожидания, которое runner имеет для получения определенного задания. |
| registration_token строка / обязательно | Токен регистрации используется для регистрации новых runners. | |
| run_untagged логическое |
| Выполнять задания без тегов или нет. |
| state строка |
| Убедиться, что runner с тем же именем существует с такой же конфигурацией или удалить runner с таким же именем. |
| tag_list список / элементы=строка | По умолчанию: [] | Теги, применимые к runner. |
| validate_certs логическое |
| Подтверждать ли SSL-сертификаты при предоставлении https-адреса. |
Примечания
Примечание
- Для создания нового runner, как минимум, требуются параметры
api_token,descriptionиapi_url. - Runners должны иметь уникальные описания.
Примеры
- name: "Register runner"
community.general.gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
registration_token: 4gfdsg345
description: Docker Machine t1
state: present
active: True
tag_list: ['docker']
run_untagged: False
locked: False
- name: "Delete runner"
community.general.gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
description: Docker Machine t1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| error строка | неудачно | сообщение об ошибке, возвращенное GitLab API Пример: 400: путь уже используется |
| msg строка | всегда | сообщение об успехе или неудаче Пример: Успешно |
| result словарь | всегда | ответ от сервера в формате JSON |
| runner словарь | всегда | объект API |
Авторы
- Samy Coenen (@SamyCoenen)
- Guillaume Martinez (@Lunik)
© 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_runner_module.html
