gcp_storage_bucket_access_control – Создаёт GCP BucketAccessControl
Новая версия с 2.6.
Описание
- Ресурс BucketAccessControls представляет списки управления доступом (ACL) для ведер в Google Cloud Storage. ACL позволяют задать, кому и в какой степени предоставляется доступ к данным.
- Существует три роли, которые могут быть назначены сущности: READERS могут получить ведро, хотя свойство acl возвращено не будет, и перечислить объекты ведра. WRITERS — это READERS, и они могут вставлять объекты в ведро и удалять объекты из ведра. OWNERS — это WRITERS, и они могут получить свойство acl ведра, обновить ведро и вызвать все методы BucketAccessControls для ведра. Для получения дополнительной информации см. Управление доступом, с оговоркой, что этот API использует READER, WRITER и OWNER вместо READ, WRITE и FULL_CONTROL.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| bucket - / обязательно | Имя ведра. Это поле представляет ссылку на ресурс Bucket в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_storage_bucket и затем установить это поле bucket в "{{ name-of-resource }}" | ||
| entity - / обязательно | Сущность, владеющая разрешением, в одном из следующих форматов: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Примеры: Пользователь liz@example.com будет user-liz@example.com. Группа example@googlegroups.com будет group-example@googlegroups.com. Для ссылки на всех членов домена Google Apps for Business example.com, сущность будет domain-example.com. | ||
| entity_id - | Идентификатор сущности. | ||
| project строка | Проект Google Cloud Platform, который следует использовать. | ||
| project_team - | Команда проекта, связанная с сущностью. | ||
| project_number - | Команда проекта, связанная с сущностью. | ||
| team - |
| Команда. | |
| role - |
| Разрешение доступа для сущности. | |
| scopes список | Массив используемых областей. | ||
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Не следует передавать в виде словаря, а в виде строки с точным содержимым файла service account json (валидный JSON) | ||
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если machineaccount выбран, и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если serviceaccount выбран в качестве типа. | ||
| state - |
| Должен ли данный объект существовать в GCP | |
Примечания
Примечание
- Для аутентификации можно установить 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 bucket
gcp_storage_bucket:
name: "{{ resource_name }}"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: bucket
- name: create a bucket access control
gcp_storage_bucket_access_control:
bucket: test_object
entity: user-alexstephen@google.com
role: WRITER
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие значения, возвращаемые модулями, описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание | |
|---|---|---|---|
| bucket словарь | успех | Имя ведра. | |
| domain строка | успех | Домен, связанный с сущностью. | |
| email строка | успех | Адрес электронной почты, связанный с сущностью. | |
| entity строка | успех | Сущность, владеющая разрешением, в одном из следующих форматов: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Примеры: Пользователь liz@example.com будет user-liz@example.com. Группа example@googlegroups.com будет group-example@googlegroups.com. Для ссылки на всех членов домена Google Apps for Business example.com, сущность будет domain-example.com. | |
| entityId строка | успех | Идентификатор сущности. | |
| id строка | успех | Идентификатор записи управления доступом. | |
| projectTeam сложный | успех | Команда проекта, связанная с сущностью. | |
| projectNumber строка | успех | Команда проекта, связанная с сущностью. | |
| team строка | успех | Команда. | |
| role строка | успех | Разрешение доступа для сущности. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_storage_bucket_access_control_module.html