Модуль community.general.heroku_collaborator — добавление или удаление участников приложений на Heroku

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string	Ключ API Heroku.
apps list / elements=string / обязательный	Список названий приложений Heroku.
state string	Создать или удалить участника Heroku. Варианты: `"present"` ← (по умолчанию) `"absent"`
suppress_invitation boolean	Не отправлять приглашение по электронной почте при добавлении участника. Варианты: `false` ← (по умолчанию) `true`
user string / обязательный	ID пользователя или адрес электронной почты.

Атрибуты

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

Примечания

Примечание

Вместо задания api_key можно использовать переменные окружения HEROKU_API_KEY и TF_VAR_HEROKU_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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/heroku_collaborator_module.html