Модуль community.general.gitlab_deploy_key — Управляет ключами развертывания проекта GitLab

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробной информации.

Чтобы использовать его в плейбуке, укажите: community.general.gitlab_deploy_key.

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

Описание

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

Требования

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

Модуль python-gitlab
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
api_job_token строка добавлено в community.general 4.2.0	Токен задания GitLab CI для входа.
api_oauth_token строка добавлено в community.general 4.2.0	Токен GitLab OAuth для входа.
api_password строка	Пароль для аутентификации по API.
api_token строка	Токен доступа GitLab с правами API.
api_url строка	Резолвимый конечный пункт API.
api_username строка	Имя пользователя для аутентификации по API.
ca_path строка добавлено в community.general 8.1.0	Файл с сертификатами CA для проверки сертификата сервера GitLab.
can_push булево	Может ли ключ выполнять push в проект. Варианты: `false` ← (по умолчанию) `true`
key строка / обязательно	Ключ развертывания
project строка / обязательно	Идентификатор или полный путь к проекту в формате группа/имя.
state строка	При значении `present`, ключ развертывания будет добавлен в проект, если он не существует. При значении `absent`, он будет удалён из проекта, если существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
title строка / обязательно	Название ключа развертывания.
validate_certs булево	Подтверждать ли SSL-сертификаты при использовании HTTPS-адреса. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме проверки и возвращать прогноз изменений состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	Возвращает подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`), при использовании режима diff.

Примеры

- 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: true

- 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..."

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
deploy_key словарь	Объект API Возвращается: всегда
error строка	сообщение об ошибке, возвращенное API GitLab Возвращается: при ошибке Пример: `"400: key is already in use"`
msg строка	Сообщение об успехе или неудаче Возвращается: всегда Пример: `"Success"`
result словарь	разбор JSON ответа сервера Возвращается: всегда

Авторы

Marcus Watkins (@marwatk)
Guillaume Martinez (@Lunik)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_deploy_key_module.html