community.general.gitlab_deploy_key – Управляет ключами развертывания проекта GitLab.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для установки используйте: 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 булево |
| Может ли этот ключ выполнять push в проект. |
| key строка / обязательно | Ключ развертывания | |
| project строка / обязательно | Идентификатор или полный путь проекта в формате группа/имя. | |
| state строка |
| Когда present, ключ развертывания добавляется в проект, если он не существует.Когда absent, он будет удален из проекта, если существует. |
| title строка / обязательно | Заголовок ключа развертывания. | |
| validate_certs булево |
| Требовать проверку 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gitlab_deploy_key_module.html
