gitlab_runner – Создание, изменение и удаление GitLab Runners

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Регистрация, обновление и удаление исполнителей с помощью GitLab API.
Все операции выполняются с помощью GitLab API 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 python module <= 1.12.1

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_level строка	Варианты: ref_protected ← not_protected	Определяет, может ли исполнитель получать задачи из защищенных ветвей.
active булево	Варианты: no yes ←	Определяет, будет ли исполнитель сразу активным после создания.
api_password строка		Пароль для аутентификации на API.
api_token строка / обязательно		Ваш частный токен для взаимодействия с API GitLab. псевдонимы: private_token
api_url строка		Доступный конечный пункт API.
api_username строка		Имя пользователя для аутентификации на API.
description строка / обязательно		Уникальное имя исполнителя. псевдонимы: name
locked булево	Варианты: no ← yes	Определяет, заблокирован ли исполнитель.
maximum_timeout целое число	Значение по умолчанию: 3600	Максимальное время ожидания, которое исполнитель имеет для получения конкретной задачи.
registration_token строка / обязательно		Токен регистрации используется для регистрации новых исполнителей.
run_untagged булево	Варианты: no yes ←	Выполнять незамеченные задачи или нет.
state строка	Варианты: present ← absent	Убедитесь, что исполнитель с тем же именем существует с той же конфигурацией или удалите исполнителя с тем же именем.
tag_list список	Значение по умолчанию: []	Теги, которые применяются к исполнителю.
url строка		URL сервера GitLab с протоколом (например, http или https).
validate_certs булево	Варианты: no yes ←	Подтверждать ли сертификаты 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 строка	failed	сообщение об ошибке, возвращенное API Gitlab Пример: 400: путь уже используется
msg строка	всегда	сообщение об успехе или об ошибке Пример: Успех
result словарь	всегда	обработанный json ответ от сервера
runner словарь	всегда	объект API

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.8/modules/gitlab_runner_module.html