gitlab_deploy_key – Управление ключами развертывания GitLab проектов
Новое в версии 2.6.
Обзор
- Добавляет, обновляет и удаляет ключи развертывания проектов
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- модуль python-gitlab python <= 1.12.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль для аутентификации с API | |
| api_token строка добавлен в 2.8 | Токен GitLab для входа. алиасы: private_token, access_token | |
| 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"
gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ access_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"
gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
title: "Jenkins CI"
state: present
can_push: yes
- name: "Remove the previous deploy key from the project"
gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
state: absent
key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| deploy_key словарь | всегда | Объект API |
| error строка | при ошибке | Сообщение об ошибке, возвращаемое API GitLab Пример: 400: ключ уже используется |
| msg строка | всегда | Сообщение об успехе или неудаче Пример: Успех |
| result словарь | всегда | Обработанный json ответ от сервера |
Статус
- Этот модуль не гарантирует обратной совместимости. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/gitlab_deploy_key_module.html
