REST Resource: projects.locations.attachedClusters

资源:AttachedCluster

在客户自己的基础架构上运行的 Anthos 集群。

JSON 表示法
{
  "name": string,
  "description": string,
  "oidcConfig": {
    object (AttachedOidcConfig)
  },
  "platformVersion": string,
  "distribution": string,
  "clusterRegion": string,
  "fleet": {
    object (Fleet)
  },
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "kubernetesVersion": string,
  "annotations": {
    string: string,
    ...
  },
  "workloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "errors": [
    {
      object (AttachedClusterError)
    }
  ],
  "authorization": {
    object (AttachedClustersAuthorization)
  },
  "monitoringConfig": {
    object (MonitoringConfig)
  },
  "proxyConfig": {
    object (AttachedProxyConfig)
  },
  "binaryAuthorization": {
    object (BinaryAuthorization)
  }
}
字段
name

string

此资源的名称。

集群名称的格式为 projects/<project-number>/locations/<region>/attachedClusters/<cluster-id>

如需详细了解 Google Cloud Platform 资源名称,请参阅资源名称

description

string

可选。此集群的人类可读说明。长度不能超过 255 个 UTF-8 编码字节。

oidcConfig

object (AttachedOidcConfig)

必需。集群的 OpenID Connect (OIDC) 配置。

platformVersion

string

必需。集群的平台版本(例如 1.19.0-gke.1000)。

您可以通过调用 locations.getAttachedServerConfig 来列出给定 Google Cloud 区域中所有受支持的版本。

distribution

string

必需。底层关联集群的 Kubernetes 分布。

支持的值:[“eks”“aks”“generic”]。

clusterRegion

string

仅限输出。此集群运行所在的区域。

对于 EKS 集群,这是 AWS 区域。对于 AKS 集群,这是 Azure 区域。

fleet

object (Fleet)

必需。舰队配置。

state

enum (State)

仅限输出。集群的当前状态。

uid

string

仅限输出。集群的全局唯一标识符。

reconciling

boolean

仅限输出。如果设置了此字段,则当前正在对集群进行更改。

createTime

string (Timestamp format)

仅限输出。注册此集群的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。上次更新此集群的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

etag

string

允许客户端通过乐观并发控制执行一致的“读取-修改-写入”操作。

可在更新和删除请求中发送,以确保客户端在继续操作之前具有最新值。

kubernetesVersion

string

仅限输出。集群的 Kubernetes 版本。

annotations

map (key: string, value: string)

可选。集群上的注解。

此字段的限制与 Kubernetes 注解相同。所有键和值的总大小不得超过 256k。键可以包含 2 个部分:前缀(可选)和名称(必需),以斜杠 (/) 分隔。前缀必须是 DNS 子网域。名称不得超过 63 个字符,以字母数字字符开头和结尾,中间可以使用短划线 (-)、下划线 (_)、点 (.) 和字母数字字符。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

workloadIdentityConfig

object (WorkloadIdentityConfig)

仅限输出。Workload Identity 设置。

loggingConfig

object (LoggingConfig)

可选。此集群的 Logging 配置。

errors[]

object (AttachedClusterError)

仅限输出。在集群中发现的一组错误。

authorization

object (AttachedClustersAuthorization)

可选。与集群 RBAC 设置相关的配置。

monitoringConfig

object (MonitoringConfig)

可选。此集群的 Monitoring 配置。

proxyConfig

object (AttachedProxyConfig)

可选。出站 HTTP(S) 流量的代理配置。

binaryAuthorization

object (BinaryAuthorization)

可选。此集群的 Binary Authorization 配置。

AttachedOidcConfig

目标集群的 OIDC 发现信息。

Kubernetes 服务账号 (KSA) 令牌是由集群 API 服务器签名的 JWT 令牌。此字段指示 Google Cloud Platform 服务如何验证 KSA 令牌,以便允许系统工作负载(例如 GKE Connect 和遥测代理)向 Google Cloud Platform 进行身份验证。

具有公共和私有颁发者网址的集群均受支持。具有公开颁发者的集群只需要指定 issuerUrl 字段,而具有专用颁发者的集群需要同时提供 issuerUrloidc_jwks

JSON 表示法
{
  "issuerUrl": string,
  "jwks": string
}
字段
issuerUrl

string

JSON Web 令牌 (JWT) 的颁发者 URI。issuer 必须以 https:// 开头。

jwks

string (bytes format)

可选。JWKS 格式的 OIDC 验证密钥 (RFC 7517)。 它包含可用于验证 OIDC JWT 的 OIDC 验证密钥列表。

对于没有公开可用发现端点的集群,此字段是必需的。提供后,它将直接用于验证 IDP 声明的 OIDC JWT。

使用 base64 编码的字符串。

状态

集群的生命周期状态。

枚举
STATE_UNSPECIFIED 未设置。
PROVISIONING PROVISIONING 状态表示集群正在进行注册。
RUNNING RUNNING 状态表示集群已注册并且完全可用。
RECONCILING RECONCILING 状态表示集群上正在进行某些工作,例如升级软件组件。
STOPPING STOPPING 状态表示集群正在取消注册。
ERROR ERROR 状态表示集群处于不可恢复的损坏状态。
DEGRADED DEGRADED 状态表示集群需要用户执行操作才能恢复全部功能。

AttachedClusterError

AttachedClusterError 描述在关联集群上发现的错误。

JSON 表示法
{
  "message": string
}
字段
message

string

直观易懂的错误说明。

AttachedClustersAuthorization

与集群 RBAC 设置相关的配置。

JSON 表示法
{
  "adminUsers": [
    {
      object (AttachedClusterUser)
    }
  ],
  "adminGroups": [
    {
      object (AttachedClusterGroup)
    }
  ]
}
字段
adminUsers[]

object (AttachedClusterUser)

可选。能够以集群管理员身份执行操作的用户。将创建托管式 ClusterRoleBinding 以向用户授予 cluster-admin ClusterRole。最多可以提供 10 个管理员用户。

如需详细了解 RBAC,请参阅 https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

adminGroups[]

object (AttachedClusterGroup)

可选。能够以集群管理员身份执行操作的用户群组。将创建托管式 ClusterRoleBinding 以向群组授予 cluster-admin ClusterRole。最多可以提供 10 个管理员群组。

如需详细了解 RBAC,请参阅 https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

AttachedClusterUser

关联集群的用户类型主体的身份。

JSON 表示法
{
  "username": string
}
字段
username

string

必需。用户的名称,例如 my-gcp-id@gmail.com

AttachedClusterGroup

关联集群的群组类型主体的身份。

JSON 表示法
{
  "group": string
}
字段
group

string

必需。群组的名称,例如 my-group@domain.com

AttachedProxyConfig

代理配置的详细信息。

JSON 表示法
{
  "kubernetesSecret": {
    object (KubernetesSecret)
  }
}
字段
kubernetesSecret

object (KubernetesSecret)

包含 HTTP(S) 代理配置的 Kubernetes Secret 资源。Secret 必须是 JSON 编码的代理配置,如以下内容所述:

KubernetesSecret

有关 Kubernetes Secret 的信息

JSON 表示法
{
  "name": string,
  "namespace": string
}
字段
name

string

kubernetes Secret 的名称。

namespace

string

存储 kubernetes Secret 的命名空间。

方法

create

在给定的 Google Cloud Platform 项目和区域中创建新的 AttachedCluster 资源。

delete

删除特定的 AttachedCluster 资源。

generateAttachedClusterAgentToken

为集群代理生成访问令牌。

get

描述特定的 AttachedCluster 资源。

import

通过导入现有舰队成员资格资源来创建新的 AttachedCluster 资源。

list

列出给定 Google Cloud 项目和区域中的所有 AttachedCluster 资源。

patch

更新 AttachedCluster