gitlab_runner – Создание, изменение и удаление GitLab Runners
Новая версия с 2.8.
Описание
- Регистрация, обновление и удаление исполнителей с помощью API GitLab.
- Все операции выполняются с использованием API GitLab v4.
- Для получения подробностей обратитесь к полной документации API по адресу https://docs.gitlab.com/ee/api/runners.html.
- Для всех операций требуется действительный частный токен API. Вы можете создать столько токенов, сколько вам нужно, используя веб-интерфейс GitLab по адресу https://$GITLAB_URL/profile/personal_access_tokens.
- Для регистрации нового исполнителя требуется действительный токен регистрации. Для создания общих исполнителей вам необходимо попросить своего администратора предоставить вам этот токен. Он находится по адресу https://$GITLAB_URL/admin/runners/.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- python-gitlab <= 1.12.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access_level строка |
| Определяет, может ли исполнитель забирать задачи из защищенных ветвей. |
| active логическое значение |
| Определите, будет ли исполнитель сразу активным после создания. |
| api_password строка | Пароль для аутентификации по API | |
| api_token строка / обязательно | Ваш личный токен для взаимодействия с API GitLab. псевдонимы: private_token | |
| api_url строка | Адрес конечной точки API | |
| api_username строка | Имя пользователя для аутентификации по API | |
| description строка / обязательно | Уникальное имя исполнителя. псевдонимы: name | |
| locked логическое значение |
| Определяет, заблокирован ли исполнитель. |
| maximum_timeout целое число | Значение по умолчанию: 3600 | Максимальное время ожидания, которое исполнитель имеет для выбора конкретной задачи. |
| registration_token строка / обязательно | Токен регистрации используется для регистрации новых исполнителей. | |
| run_untagged логическое значение |
| Выполнять незамеченные задачи или нет. |
| state строка |
| Убедитесь, что исполнитель с тем же именем существует с той же конфигурацией или удалите исполнителя с тем же именем. |
| tag_list список | Значение по умолчанию: [] | Теги, применимые к исполнителю. |
| url строка | URL сервера GitLab с протоколом (например, http или https). | |
| validate_certs логическое значение |
| Требуется ли проверка SSL-сертификатов при предоставлении конечной точки https. |
Примечания
Примечание
- Для создания нового исполнителя как минимум требуются параметры
api_token,descriptionиurl. - Исполнители должны иметь уникальные описания.
Примеры
- name: "Register runner"
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"
gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
description: Docker Machine t1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| error строка | ошибка | Сообщение об ошибке, возвращенное API GitLab Пример: 400: путь уже используется |
| msg строка | всегда | Сообщение об успехе или об ошибке Пример: Успех |
| result словарь | всегда | Разбор JSON-ответа от сервера |
| runner словарь | всегда | Объект API |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/gitlab_runner_module.html
