Модуль community.general.heroku_collaborator – Добавление или удаление коллабораторов приложения на Heroku

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.general.heroku_collaborator.

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

Обзор

Управление коллабораторами приложений Heroku.
Если установлено значение present и пользователь heroku уже является коллаборатором, то ничего не делается.
Если установлено значение present и пользователь heroku не является коллаборатором, то пользователь добавляется в приложение.
Если установлено значение absent и пользователь heroku является коллаборатором, то пользователь удаляется из приложения.

Требования

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

heroku3

Параметры

Параметр	Комментарии
api_key строка	Ключ API Heroku
apps список / элементы=строка / обязательный	Список имен приложений Heroku
state строка	Создание или удаление коллаборатора heroku Варианты: `"present"` ← (по умолчанию) `"absent"`
suppress_invitation логическое	Отклонить приглашение по электронной почте при создании коллаборатора Варианты: `false` ← (по умолчанию) `true`
user строка / обязательный	Идентификатор пользователя или электронная почта

Атрибуты

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

Примечания

Примечание

Переменные окружения HEROKU_API_KEY и TF_VAR_HEROKU_API_KEY могут быть использованы вместо установки api_key.
Если вы используете check_mode, вы также можете передать флаг -v для отображения затронутых приложений в msg, например [“heroku-example-app”].

Примеры

- name: Create a heroku collaborator
  community.general.heroku_collaborator:
    api_key: YOUR_API_KEY
    user: max.mustermann@example.com
    apps: heroku-example-app
    state: present

- name: An example of using the module in loop
  community.general.heroku_collaborator:
    api_key: YOUR_API_KEY
    user: '{{ item.user }}'
    apps: '{{ item.apps | default(apps) }}'
    suppress_invitation: '{{ item.suppress_invitation | default(suppress_invitation) }}'
    state: '{{ item.state | default("present") }}'
  with_items:
    - { user: 'a.b@example.com' }
    - { state: 'absent', user: 'b.c@example.com', suppress_invitation: false }
    - { user: 'x.y@example.com', apps: ["heroku-example-app"] }

Авторы

Marcel Arns (@marns93)

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

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