google.cloud.gcp_runtimeconfig_config 模块 – 创建 GCP 配置

注意

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

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

要安装它,请使用:ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:google.cloud.gcp_runtimeconfig_config

注意

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

概要

  • RuntimeConfig 资源是 Cloud RuntimeConfig 服务中的主要资源。

  • RuntimeConfig 资源由元数据和变量的层次结构组成。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

字符串

与运行时配置关联的描述。

env_type

字符串

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

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

这只会更改任何 API 请求的 User Agent 字符串。

name

字符串 / 必需

运行时配置的名称。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

示例

- name: create a config
  google.cloud.gcp_runtimeconfig_config:
    name: test_object
    description: My config
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

描述

description

字符串

与运行时配置关联的描述。

返回: 成功

name

字符串

运行时配置的名称。

返回: 成功

作者

  • Google Inc. (@googlecloudplatform)