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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.gitlab_runner.

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

Обзор

Регистрация, обновление и удаление исполнителей с помощью 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.5.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_level строка	Варианты: ref_protected ← not_protected	Определяет, может ли исполнитель получать задачи из защищенных ветвей.
active логическое	Варианты: нет да ←	Определяет, будет ли исполнитель сразу активен после создания.
api_password строка		Пароль для аутентификации с API.
api_token строка		Ваш закрытый токен для взаимодействия с API GitLab.
api_url строка		Резолвимый адрес конечной точки API.
api_username строка		Имя пользователя для аутентификации с API.
description строка / обязательно		Уникальное имя исполнителя. псевдонимы: имя
locked логическое	Варианты: нет ← да	Определяет, заблокирован ли исполнитель.
maximum_timeout целое число	Значение по умолчанию: 3600	Максимальное время ожидания, которое исполнитель должен иметь для получения конкретной задачи.
owned логическое добавлен в 2.0.0 community.general	Варианты: нет ← да	Ищет только исполнителей, доступных пользователю, при поиске существующих. Если значение ложь, требуется токен администратора.
registration_token строка / обязательно		Токен регистрации используется для регистрации новых исполнителей.
run_untagged логическое	Варианты: нет да ←	Выполнять задачи без тегов или нет.
state строка	Варианты: present ← absent	Убедиться, что исполнитель с таким же именем существует с той же конфигурацией или удалить исполнителя с таким же именем.
tag_list список / элементы=строка	Значение по умолчанию: []	Теги, относящиеся к исполнителю.
validate_certs логическое	Варианты: нет да ←	Требовать проверку SSL-сертификатов при указании https-адреса конечной точки.

Примечания

Примечание

Для создания нового исполнителя необходимо указать как минимум параметры api_token, description и api_url.
Исполнители должны иметь уникальные описания.

Примеры

- 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

- name: Delete an owned runner as a non-admin
  community.general.gitlab_runner:
    api_url: https://gitlab.example.com/
    api_token: "{{ access_token }}"
    description: Docker Machine t1
    owned: yes
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
error строка	неудачно	Сообщение об ошибке, возвращенное API GitLab. Пример: 400: путь уже используется
msg строка	всегда	Сообщение об успехе или неудаче. Пример: Успешно
result словарь	всегда	Обработанный с помощью json ответ от сервера.
runner словарь	всегда	Объект API.

Авторы

Samy Coenen (@SamyCoenen)
Guillaume Martinez (@Lunik)

© 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_runner_module.html