google.cloud.gcp_storage_default_object_acl – Создаёт GCP DefaultObjectACL

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_storage_default_object_acl.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Ресурсы DefaultObjectAccessControls представляют списки управления доступом (ACL), применяемые к новому объекту в ведре Google Cloud Storage, когда для этого объекта не был задан ACL. ACL позволяют указать, кто имеет доступ к содержимому вашего ведра и в какой степени.
Существует две роли, которые могут быть назначены сущности: READERы могут получить объект, хотя свойство acl не будет раскрыто.
OWNERы являются READERами и могут получить свойство acl, обновить объект и вызвать все методы objectAccessControls для объекта. Владелец объекта всегда является OWNERом.
Для получения дополнительной информации см. Управление доступом, с оговоркой, что этот API использует READER и OWNER вместо READ и FULL_CONTROL.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
bucket словарь / обязательно		Название ведра. Это поле представляет собой ссылку на ресурс ведра в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_storage_bucket и затем установить это поле bucket в "{{ name-of-resource }}"
entity строка / обязательно		Сущность, владеющая разрешением, в одном из следующих форматов: * user-{{userId}} * user-{{email}} (например, "user-liz@example.com") * group-{{groupId}} * group-{{email}} (например, "group-example@googlegroups.com") * domain-{{domain}} (например, "domain-example.com") * project-team-{{projectId}} * allUsers * allAuthenticatedUsers .
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Это поле не должно устанавливаться, если вы не знаете, что делаете. Это поле изменяет только строку User Agent для всех запросов API.
object строка		Имя объекта, если применяется к объекту.
project строка		Проект Google Cloud Platform для использования.
role строка / обязательно		Разрешение доступа для сущности. Некоторые допустимые значения включают: "OWNER", "READER"
scopes список / элементы=строка		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state строка	Варианты: present ← absent	Нужно ли заданному объекту существовать в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls
Официальная документация: https://cloud.google.com/storage/docs/access-control/create-manage-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.
Значения переменных среды будут использоваться только если значения в playbook не заданы.
Параметры 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 default object acl
  google.cloud.gcp_storage_default_object_acl:
    bucket: "{{ bucket }}"
    entity: OWNER:user-alexstephen@google.com
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ		Возвращаемое значение	Описание
bucket словарь		успех	Название ведра.
domain строка		успех	Домен, связанный с сущностью.
email строка		успех	Адрес электронной почты, связанный с сущностью.
entity строка		успех	Сущность, владеющая разрешением, в одном из следующих форматов: * user-{{userId}} * user-{{email}} (например, "user-liz@example.com") * group-{{groupId}} * group-{{email}} (например, "group-example@googlegroups.com") * domain-{{domain}} (например, "domain-example.com") * project-team-{{projectId}} * allUsers * allAuthenticatedUsers .
entityId строка		успех	Идентификатор сущности.
generation целое число		успех	Номер версии содержимого объекта, если применён к объекту.
id строка		успех	Идентификатор записи управления доступом.
object строка		успех	Имя объекта, если применяется к объекту.
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_default_object_acl_module.html