community.general.gitlab_deploy_key – Управляет ключами развертывания проектов GitLab.

Примечание

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

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

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

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

Описание

Добавляет, обновляет и удаляет ключи развертывания проекта

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
модуль python-gitlab

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_password строка		Пароль для аутентификации по API
api_token строка		Токен GitLab для входа.
api_url строка		Адрес API
api_username строка		Имя пользователя для аутентификации по API
can_push логическое	Варианты: no ← yes	Разрешено ли использовать этот ключ для отправки изменений в проект.
key строка / обязательно		Ключ развертывания
project строка / обязательно		Идентификатор или полный путь к проекту в формате группа/имя.
state строка	Варианты: present ← absent	При значении `present` ключ развертывания добавляется в проект, если он не существует. При значении `absent` ключ удаляется из проекта, если он существует.
title строка / обязательно		Название ключа развертывания.
validate_certs логическое	Варианты: no yes ←	Требовать проверку SSL-сертификатов при использовании https-адреса.

Примеры

- name: "Adding a project deploy key"
  community.general.gitlab_deploy_key:
    api_url: https://gitlab.example.com/
    api_token: "{{ api_token }}"
    project: "my_group/my_project"
    title: "Jenkins CI"
    state: present
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."

- name: "Update the above deploy key to add push access"
  community.general.gitlab_deploy_key:
    api_url: https://gitlab.example.com/
    api_token: "{{ api_token }}"
    project: "my_group/my_project"
    title: "Jenkins CI"
    state: present
    can_push: yes

- name: "Remove the previous deploy key from the project"
  community.general.gitlab_deploy_key:
    api_url: https://gitlab.example.com/
    api_token: "{{ api_token }}"
    project: "my_group/my_project"
    state: absent
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."

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

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

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

Авторы

Marcus Watkins (@marwatk)
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_deploy_key_module.html