community.general.heroku_collaborator – Добавить или удалить коллабораторов приложения на Heroku
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в playbook, укажите: community.general.heroku_collaborator.
Обзор
- Управляет коллабораторами приложений Heroku.
- Если установлено
present, и пользователь heroku уже является коллаборатором, то ничего не происходит. - Если установлено
present, и пользователь heroku не является коллаборатором, то пользователь добавляется в приложение. - Если установлено
absent, и пользователь heroku является коллаборатором, то пользователь удаляется из приложения.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- heroku3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key строка | Ключ API Heroku | |
| apps список / элементы=строка / обязательно | Список имен приложений Heroku | |
| state строка |
| Создать или удалить коллаборатора heroku |
| suppress_invitation логическое значение |
| Запретить приглашение по электронной почте при создании коллаборатора |
| user строка / обязательно | Идентификатор пользователя или адрес электронной почты |
Примечания
Примечание
-
HEROKU_API_KEYиTF_VAR_HEROKU_API_KEYпеременные окружения могут быть использованы вместо установкиapi_key. - Если вы используете –check, вы также можете передать флаг -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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/heroku_collaborator_module.html