Модуль community.general.bitbucket_pipeline_variable – Управление переменными конвейера Bitbucket

Примечание

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

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

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

Для использования в playbook, укажите: community.general.bitbucket_pipeline_variable.

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

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

Управляет переменными конвейера Bitbucket.

Параметры

Параметр	Комментарии
client_id string	Ключ потребителя OAuth. Если не задан, будет использоваться переменная окружения `BITBUCKET_CLIENT_ID`.
client_secret string	Секрет потребителя OAuth. Если не задан, будет использоваться переменная окружения `BITBUCKET_CLIENT_SECRET`.
name string / required	Имя переменной конвейера.
password string добавлено в community.general 4.0.0	Пароль приложения. Если не задан, будет использоваться переменная окружения `BITBUCKET_PASSWORD`.
repository string / required	Имя репозитория.
secured boolean	Шифровать ли значение переменной. Варианты: `false` ← (по умолчанию) `true`
state string / required	Указывает желаемое состояние переменной. Варианты: `"absent"` `"present"`
user псевдонимы: username string добавлено в community.general 4.0.0	Имя пользователя. Если не задан, будет использоваться переменная окружения `BITBUCKET_USERNAME`. `username` является псевдонимом `user` начиная с community.general 6.0.0. Раньше это был псевдоним `workspace`.
value string	Значение переменной конвейера.
workspace string / required	Владелец репозитория. Примечание: `username` раньше был псевдонимом этого параметра. Начиная с community.general 6.0.0, это псевдоним `user`.

Атрибуты

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

Примечания

Примечание

Поддерживается режим проверки.
Для защищенных значений возвращаемый параметр changed всегда равен true.
Ключ и секрет потребителя OAuth Bitbucket можно получить в профиле Bitbucket -> Настройки -> Управление доступом -> OAuth.
Пароль приложения Bitbucket можно создать в профиле Bitbucket -> Личные настройки -> Пароли приложений.
Если переданы как учетные данные OAuth, так и базовая аутентификация, приоритет отдается учетным данным OAuth.

Примеры

- name: Create or update pipeline variables from the list
  community.general.bitbucket_pipeline_variable:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    name: '{{ item.name }}'
    value: '{{ item.value }}'
    secured: '{{ item.secured }}'
    state: present
  with_items:
    - { name: AWS_ACCESS_KEY, value: ABCD1234, secured: false }
    - { name: AWS_SECRET, value: qwe789poi123vbn0, secured: true }

- name: Remove pipeline variable
  community.general.bitbucket_pipeline_variable:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    name: AWS_ACCESS_KEY
    state: absent

Авторы

Evgeniy Krysanov (@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_variable_module.html