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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string добавлен в community.general 4.2.0	Токен задания GitLab CI для входа в систему.
api_oauth_token string добавлен в community.general 4.2.0	Токен OAuth GitLab для входа в систему.
api_password string	Пароль для аутентификации в API.
api_token string	Токен доступа GitLab с разрешениями для API.
api_url string	Доступная конечная точка API.
api_username string	Имя пользователя для аутентификации в API.
ca_path string добавлен в community.general 8.1.0	Путь к пакету сертификатов CA для проверки сертификата сервера GitLab.
can_push boolean	Может ли этот ключ отправлять изменения в проект. Варианты: `false` ← (по умолчанию) `true`
key string / обязательный	Ключ развертывания.
project string / обязательный	ID или полный путь проекта в формате group/name.
state string	Если указано `present`, ключ развертывания добавляется в проект, если он еще не существует. Если указано `absent`, ключ удаляется из проекта, если он существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
title string / обязательный	Название ключа развертывания.
validate_certs boolean	Проверять ли SSL-сертификаты при указании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

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

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

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

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

Авторы

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

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

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