google.cloud.gcp_compute_backend_bucket 模块 – 创建 GCP 后端存储桶

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_backend_bucket。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中删除。该集合存在 未解决的完整性测试失败。有关更多信息，请参阅 讨论主题。

概要

  • 后端存储桶允许您将 Google Cloud Storage 存储桶与 HTTP(S) 负载平衡一起使用。

  • HTTP(S) 负载平衡器可以将流量定向到后端存储桶（而不是后端服务）的指定 URL。它可以将静态内容的请求发送到 Cloud Storage 存储桶，并将动态内容的请求发送到虚拟机实例。

要求

执行此模块的主机需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

bucket_name

字符串 / 必需

Cloud Storage 存储桶名称。

cdn_policy

字典

此后端存储桶的 Cloud CDN 配置。

cache_mode

字符串

指定此后端所有响应的缓存设置。

可能的值为：USE_ORIGIN_HEADERS、FORCE_CACHE_ALL 和 CACHE_ALL_STATIC。

一些有效选项包括：“USE_ORIGIN_HEADERS”、“FORCE_CACHE_ALL”、“CACHE_ALL_STATIC”

client_ttl

整数

指定此来源提供的缓存内容的最大允许 TTL。

default_ttl

整数

为没有现有有效 TTL（max-age 或 s-max-age）的响应指定此来源提供的缓存内容的默认 TTL。

max_ttl

整数

指定此来源提供的缓存内容的最大允许 TTL。

negative_caching

布尔值

负缓存允许设置每个状态码 TTL，以便为常见的错误或重定向应用细粒度的缓存。

选项

  • false

  • true

negative_caching_policy

列表 / 元素=字典

为指定的 HTTP 状态码设置缓存 TTL。必须启用 negativeCaching 才能配置 negativeCachingPolicy。

省略策略并启用 negativeCaching 将使用 Cloud CDN 的默认缓存 TTL。

code

整数

要针对其定义 TTL 的 HTTP 状态码。只能将 HTTP 状态码 300、301、308、404、405、410、421、451 和 501 指定为值，并且您不能多次指定状态码。

ttl

整数

缓存具有相应状态码的响应的 TTL（以秒为单位）。最大允许值为 1800 秒（30 分钟），请注意，不经常访问的对象可能会在定义的 TTL 之前从缓存中清除。

serve_while_stale

整数

在使用来源重新验证内容时，或在刷新缓存时遇到错误时，提供来自缓存的现有内容（如果可用）。

signed_url_cache_max_age_sec

整数

对签名 URL 请求的响应将被视为新鲜的最大秒数。在此时间段后，将在提供响应之前重新验证响应。

在提供对签名 URL 请求的响应时，Cloud CDN 将在内部表现得好像来自此后端的全部响应都具有“Cache-Control: public, max-age=[TTL]”标头，而不管任何现有的 Cache-Control 标头如何。响应中提供的实际标头不会更改。

custom_response_headers

列表 / 元素=字符串

HTTP/S 负载平衡器应添加到代理响应的标头。

description

字符串

资源的可选文本描述；在创建资源时由客户端提供。

enable_cdn

布尔值

如果为 true，则为此后端存储桶启用 Cloud CDN。

选项

  • false

  • true

env_type

字符串

指定您在此模块中运行的 Ansible 环境。

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

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

name

字符串 / 必需

资源名称。在创建资源时由客户端提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短横线、小写字母或数字，但最后一个字符不能是短横线。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组。

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

path

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

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

注释

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/v1/backendBuckets

  • 使用 Cloud Storage 存储桶作为负载均衡器后端：https://cloud.google.com/compute/docs/load-balancing/http/backend-bucket

  • 对于身份验证，您可以使用 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: bucket-backendbucket
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: bucket

- name: create a backend bucket
  google.cloud.gcp_compute_backend_bucket:
    name: test_object
    bucket_name: "{{ bucket.name }}"
    description: A BackendBucket to connect LNB w/ Storage Bucket
    enable_cdn: 'true'
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段：

键

描述

bucketName

字符串

Cloud Storage 存储桶名称。

返回值：成功

cdnPolicy

complex

此后端存储桶的 Cloud CDN 配置。

返回值：成功

cacheMode

字符串

指定此后端所有响应的缓存设置。

可能的值为：USE_ORIGIN_HEADERS、FORCE_CACHE_ALL 和 CACHE_ALL_STATIC。

返回值：成功

clientTtl

整数

指定此来源提供的缓存内容的最大允许 TTL。

返回值：成功

defaultTtl

整数

为没有现有有效 TTL（max-age 或 s-max-age）的响应指定此来源提供的缓存内容的默认 TTL。

返回值：成功

maxTtl

整数

指定此来源提供的缓存内容的最大允许 TTL。

返回值：成功

negativeCaching

布尔值

负缓存允许设置每个状态码 TTL，以便为常见的错误或重定向应用细粒度的缓存。

返回值：成功

negativeCachingPolicy

complex

为指定的 HTTP 状态码设置缓存 TTL。必须启用 negativeCaching 才能配置 negativeCachingPolicy。

省略策略并启用 negativeCaching 将使用 Cloud CDN 的默认缓存 TTL。

返回值：成功

code

整数

要针对其定义 TTL 的 HTTP 状态码。只能将 HTTP 状态码 300、301、308、404、405、410、421、451 和 501 指定为值，并且您不能多次指定状态码。

返回值：成功

ttl

整数

缓存具有相应状态码的响应的 TTL（以秒为单位）。最大允许值为 1800 秒（30 分钟），请注意，不经常访问的对象可能会在定义的 TTL 之前从缓存中清除。

返回值：成功

serveWhileStale

整数

在使用来源重新验证内容时，或在刷新缓存时遇到错误时，提供来自缓存的现有内容（如果可用）。

返回值：成功

signedUrlCacheMaxAgeSec

整数

对签名 URL 请求的响应将被视为新鲜的最大秒数。在此时间段后，将在提供响应之前重新验证响应。

在提供对签名 URL 请求的响应时，Cloud CDN 将在内部表现得好像来自此后端的全部响应都具有“Cache-Control: public, max-age=[TTL]”标头，而不管任何现有的 Cache-Control 标头如何。响应中提供的实际标头不会更改。

返回值：成功

creationTimestamp

字符串

RFC3339 文本格式的创建时间戳。

返回值：成功

customResponseHeaders

列表 / 元素=字符串

HTTP/S 负载平衡器应添加到代理响应的标头。

返回值：成功

description

字符串

资源的可选文本描述；在创建资源时由客户端提供。

返回值：成功

enableCdn

布尔值

如果为 true，则为此后端存储桶启用 Cloud CDN。

返回值：成功

id

整数

资源的唯一标识符。

返回值：成功

name

字符串

资源名称。在创建资源时由客户端提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短横线、小写字母或数字，但最后一个字符不能是短横线。

返回值：成功

作者

  • Google Inc. (@googlecloudplatform)