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

Примечание

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

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

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

Для использования в книге задач укажите: community.general.bitbucket_pipeline_key_pair.

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

Описание

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

Параметры

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

Атрибуты

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

Примечания

Примечание

Поддерживается режим check mode.
Ключ и секрет потребителя OAuth Bitbucket можно получить в профиле Bitbucket —> Настройки —> Управление доступом —> OAuth.
Пароль приложения Bitbucket можно создать в профиле Bitbucket —> Личные настройки —> Пароли приложений.
Если переданы данные и для 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

Авторы

Евгений Крысанов (@catcombo)

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

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