Модуль community.general.bitbucket_pipeline_key_pair – управление парой ключей SSH конвейера Bitbucket

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

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

Краткое описание
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

Управляет парой ключей SSH конвейера Bitbucket.

Параметры

Параметр	Комментарии
client_id string	Ключ потребителя OAuth. Если не задан, используется переменная окружения `BITBUCKET_CLIENT_ID`.
client_secret string	Секрет потребителя OAuth. Если не задан, используется переменная окружения `BITBUCKET_CLIENT_SECRET`.
password string добавлено в community.general 4.0.0	Пароль приложения. Если не задан, используется переменная окружения `BITBUCKET_PASSWORD`.
private_key string	Закрытый ключ.
public_key string	Открытый ключ.
repository string / обязательный	Имя репозитория.
state string / обязательный	Указывает требуемое состояние пары ключей. Допустимые значения: `"absent"` `"present"`
user псевдонимы: username string добавлено в community.general 4.0.0	Имя пользователя. Если не задано, используется переменная окружения `BITBUCKET_USERNAME`. `username` является псевдонимом `user` начиная с community.general 6.0.0. Ранее оно было псевдонимом `workspace`.
workspace string / обязательный	Владелец репозитория. Примечание: `username` ранее был псевдонимом этого параметра. Начиная с community.general 6.0.0 он является псевдонимом `user`.

Атрибуты

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

Примечания

Примечание

Поддерживается режим проверки.
Ключ и секрет потребителя OAuth Bitbucket можно получить в профиле Bitbucket: Settings -> Access Management -> OAuth.
Пароль приложения Bitbucket можно создать в профиле Bitbucket: Personal Settings -> App passwords.
Если указаны учётные данные OAuth и Basic Auth, приоритет имеют учётные данные OAuth.

Примеры

- name: Create or update SSH key pair
  community.general.bitbucket_pipeline_key_pair:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    public_key: '{{lookup("file", "bitbucket.pub") }}'
    private_key: '{{lookup("file", "bitbucket") }}'
    state: present

- name: Remove SSH key pair
  community.general.bitbucket_pipeline_key_pair:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    state: absent

Авторы

Evgeniy Krysanov (@catcombo)

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

© 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/bitbucket_pipeline_key_pair_module.html