Method: projects.locations.memberships.generateConnectManifest

生成用于部署 GKE Connect Agent 的清单。

此方法供 Google 提供的库内部使用。大多数客户端不需要直接调用此方法。

HTTP 请求

GET https://gkehub.googleapis.com/v1beta1/{name=projects/*/locations/*/memberships/*}:generateConnectManifest

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。Agent 要关联的成员资格资源的名称,格式为 projects/*/locations/*/memberships/*

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • gkehub.memberships.generateConnectManifest

查询参数

参数
connectAgent

object (ConnectAgent)

可选。要为其生成清单的连接代理。

version

string

可选。要使用的 Connect Agent 版本。默认为最新版本。

isUpgrade

boolean

可选。如果设为 true,则只会生成用于升级的资源,某些专为安装而生成的资源(例如 Secret)将被排除在外。

registry

string

可选。要从中提取 Connect Agent 映像的注册表。默认为 gcr.io/gkeconnect。

imagePullSecretContent

string (bytes format)

可选。注册表的映像拉取 Secret 内容(如果非公开)。

使用 base64 编码的字符串。

请求正文

请求正文必须为空。

响应正文

GenerateConnectManifestResponse 包含用于安装/升级 Connect Agent 的清单信息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "manifest": [
    {
      object (ConnectAgentResource)
    }
  ]
}
字段
manifest[]

object (ConnectAgentResource)

需要应用于集群以安装/升级 GKE Connect Agent 的 Kubernetes 资源的有序列表。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

ConnectAgent

最终用户使用 GKE Connect 所需的信息。

JSON 表示法
{
  "name": string,
  "proxy": string,
  "namespace": string
}
字段
name
(deprecated)

string

切勿设置。

proxy

string (bytes format)

可选。代理的 URI(如果从 Agent 连接到 gkeconnect.googleapis.com 需要使用代理);必须采用 http(s)://{proxy_address} 格式,具体取决于代理支持的网络协议(HTTP 或 HTTPS)。设置后,系统会通过 HTTP(S) 代理定向 Connect Agent 的出站流量。

使用 base64 编码的字符串。

namespace

string

可选。GKE Connect Agent 资源的命名空间。默认值为 gke-connect

Connect Agent 在默认命名空间中运行时会自动获得授权;否则,必须通过额外的 IAM 绑定进行明确授权。

ConnectAgentResource

ConnectAgentResource 表示 Connect Agent 部署的 Kubernetes 资源清单。

JSON 表示法
{
  "type": {
    object (TypeMeta)
  },
  "manifest": string
}
字段
type

object (TypeMeta)

资源的 Kubernetes 类型。

manifest

string

资源的 YAML 清单。

TypeMeta

TypeMeta 是对清单中的 Kubernetes 资源进行内容解组所需的类型信息。

JSON 表示法
{
  "kind": string,
  "apiVersion": string
}
字段
kind

string

资源的种类(例如部署)。

apiVersion

string

资源的 APIVersion(例如 v1)。