gcp_storage_bucket_access_control - Создаёт GCP BucketAccessControl
Новая версия с 2.6.
Описание
- Ресурс 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. | ||
| 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 для бизнеса example.com, сущность будет domain-example.com. | ||
| entity_id | Идентификатор сущности. | ||
| project | Проект Google Cloud Platform, который будет использоваться. | ||
| project_team | Группа проекта, связанная с сущностью. | ||
| project_number | Группа проекта, связанная с сущностью. | ||
| team |
| Группа. | |
| role |
| Разрешение доступа для сущности. | |
| scopes обязательно | Массив используемых областей. | ||
| 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. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a bucket
gcp_storage_bucket:
name: 'bucket-bac'
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
scopes:
- https://www.googleapis.com/auth/devstorage.full_control
state: present
register: bucket
- name: create a bucket access control
gcp_storage_bucket_access_control:
bucket: "{{ bucket }}"
entity: 'user-alexstephen@google.com'
role: 'WRITER'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/devstorage.full_control
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| bucket dict | успех | Ссылка на ресурс Bucket. | |
| domain str | успех | Домен, связанный с сущностью. | |
| email str | успех | Адрес электронной почты, связанный с сущностью. | |
| entity str | успех | Сущность, владеющая правом доступа, в одном из следующих форматов: 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 для бизнеса example.com, сущность будет domain-example.com. | |
| entity_id str | успех | Идентификатор сущности. | |
| id str | успех | Идентификатор записи управления доступом. | |
| project_team сложный тип | успех | Группа проекта, связанная с сущностью. | |
| project_number str | успех | Группа проекта, связанная с сущностью. | |
| team str | успех | Группа. | |
| role str | успех | Разрешение доступа для сущности. | |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщественный, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/gcp_storage_bucket_access_control_module.html