google.cloud.gcp_storage_bucket_access_control – Создаёт GCP BucketAccessControl
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_storage_bucket_access_control.
Обзор
- Ресурс BucketAccessControls представляет собой списки управления доступом (ACL) для ведер в Google Cloud Storage. ACL позволяют указать, кто имеет доступ к вашим данным и в какой степени.
- Существует три роли, которые могут быть назначены субъекту: READERы могут получить ведро, хотя свойство acl не будет возвращено, и перечислить объекты ведра. WRITERы — это READERы, и они могут вставлять объекты в ведро и удалять объекты ведра. OWNERы — это WRITERы, и они могут получить свойство 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. | |
| env_type строка | Указывает, в какой среде Ansible выполняется данный модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| role строка | Право доступа для субъекта. Некоторые допустимые значения: "OWNER", "READER", "WRITER" | |
| scopes список / элементы=строка | Массив используемых областей | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо в строке JSON, представляющей его. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | |
| state строка |
| Должен ли данный объект существовать в GCP |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls
- Официальная документация: https://cloud.google.com/storage/docs/access-control/lists
- для аутентификации можно установить service_account_file, используя переменную среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a bucket
google.cloud.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
google.cloud.gcp_storage_bucket_access_control:
bucket: "{{ bucket }}"
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 строка | успех | Право доступа для субъекта. | |
Авторы
- 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.10/collections/google/cloud/gcp_storage_bucket_access_control_module.html
