google.cloud.gcp_storage_bucket_access_control 模块 – 创建 GCP BucketAccessControl

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 Playbook 中使用它，请指定：google.cloud.gcp_storage_bucket_access_control。

注意

由于违反 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关详细信息，请参阅 讨论主题。

概要

  • BucketAccessControls 资源表示 Google Cloud Storage 中存储桶的访问控制列表 (ACL)。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

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

bucket

字典 / 必需

存储桶的名称。

此字段表示指向 GCP 中存储桶资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“name”，值为您的资源的名称。或者，您可以将 `register: name-of-resource` 添加到 gcp_storage_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 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

project

字符串

要使用的 Google Cloud Platform 项目。

role

字符串

实体的访问权限。

一些有效的选项包括：“OWNER”、“READER”、“WRITER”

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式或表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

state

字符串

给定对象是否应存在于 GCP 中

选项

  • "present" ←（默认）

  • "absent"

说明

注意

  • API 参考：https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls

  • 官方文档：https://cloud.google.com/storage/docs/access-control/lists

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 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 bucket access control
  google.cloud.gcp_storage_bucket_access_control:
    bucket: "{{ bucket }}"
    entity: [email protected]
    role: WRITER
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

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 for Business 域 example.com 的所有成员，实体将是 domain-example.com。

已返回: 成功

entityId

字符串

实体的 ID。

已返回: 成功

id

字符串

访问控制条目的 ID。

已返回: 成功

projectTeam

复杂

与实体关联的项目团队。

已返回: 成功

projectNumber

字符串

与实体关联的项目团队。

已返回: 成功

团队

字符串

团队。

已返回: 成功

role

字符串

实体的访问权限。

已返回: 成功

作者

  • Google Inc. (@googlecloudplatform)