gcp_iam_role – Создаёт GCP-роль
Новая версия с 2.8.
Описание
- Роль в API управления доступом и идентификацией.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description - | Описание роли, понятное человеку. | |
| included_permissions - | Названия разрешений, предоставляемых этой ролью при привязке к политике IAM. | |
| name - / обязательно | Имя роли. | |
| project строка | Проект Google Cloud Platform, который будет использоваться. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла service account json (валидный JSON) | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount. | |
| stage - |
| Текущий этап запуска роли. |
| state - |
| Требуется ли наличие данного объекта в GCP |
| title - | Название роли, понятное человеку. Обычно ограничивается 100 байтами UTF-8. |
Примечания
Примечание
- Для проверки подлинности можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для проверки подлинности можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для проверки подлинности можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для проверки подлинности можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для проверки подлинности можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a role
gcp_iam_role:
name: myCustomRole2
title: My Custom Role
description: My custom role description
included_permissions:
- iam.roles.list
- iam.roles.create
- iam.roles.delete
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| deleted булево | успех | Текущее состояние удаления роли. |
| description строка | успех | Описание роли, понятное человеку. |
| includedPermissions список | успех | Названия разрешений, предоставляемых этой ролью при привязке к политике IAM. |
| name строка | успех | Имя роли. |
| stage строка | успех | Текущий этап запуска роли. |
| title строка | успех | Название роли, понятное человеку. Обычно ограничивается 100 байтами UTF-8. |
Статус
- Гарантируется, что интерфейс этого модуля будет совместим с предыдущими версиями. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_iam_role_module.html