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

Новая версия с 2.6.

Обзор
Параметры
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_token		Ключ OAuth, предоставленный GitLab. Требуется один из access_token или private_token. См. https://docs.gitlab.com/ee/api/oauth2.html
api_url обязательно		URL API GitLab, например, https://gitlab.example.com/api
can_push bool	Варианты: нет ← да	Указывает, может ли данный ключ осуществлять push в проект.
key обязательно		Ключ развертывания.
private_token		Личный токен доступа. Требуется один из private_token или access_token. См. https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
project обязательно		Числовой идентификатор проекта или имя проекта в формате группа/имя.
state обязательно	Варианты: present ← absent	При значении `present` ключ развертывания добавляется в проект, если он не существует. При значении `absent` ключ удаляется из проекта, если он существует.
title обязательно		Заголовок ключа развертывания.

Примеры

# Example adding a project deploy key
- gitlab_deploy_key:
    api_url: https://gitlab.example.com/api
    access_token: "{{ access_token }}"
    project: "my_group/my_project"
    title: "Jenkins CI"
    state: present
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."

# Update the above deploy key to add push access
- gitlab_deploy_key:
    api_url: https://gitlab.example.com/api
    access_token: "{{ access_token }}"
    project: "my_group/my_project"
    title: "Jenkins CI"
    state: present
    key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
    can_push: yes

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

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

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

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Marcus Watkins (@marwatk)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/gitlab_deploy_key_module.html