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)
  },
  "securityPostureConfig": {
    object (SecurityPostureConfig)
  },
  "tags": {
    string: string,
    ...
  },
  "systemComponentsConfig": {
    object (SystemComponentsConfig)
  }
}
欄位
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

僅供輸出。叢集的全域專屬 ID。
reconciling

boolean

僅供輸出。如果已設定，叢集目前有變更正在進行中。
createTime

string (Timestamp format)

僅供輸出。這個叢集的註冊時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

僅供輸出。這個叢集上次更新的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
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)

(選用步驟) 這個叢集的記錄設定。
errors[]

object (AttachedClusterError)

僅供輸出。叢集中發現的一組錯誤。
authorization

object (AttachedClustersAuthorization)

(選用步驟) 與叢集 RBAC 設定相關的設定。
monitoringConfig

object (MonitoringConfig)

(選用步驟) 這個叢集的監控設定。
proxyConfig

object (AttachedProxyConfig)

(選用步驟) 用於輸出 HTTP(S) 流量的 Proxy 設定。
binaryAuthorization

object (BinaryAuthorization)

(選用步驟) 這個叢集的二進位授權設定。
securityPostureConfig

object (SecurityPostureConfig)

(選用步驟) 這個叢集的安全防護機制設定。
tags

map (key: string, value: string)

(選用步驟) 僅限輸入。直接繫結至這個資源的標記鍵和值。

標記鍵的格式必須為 <tag namespace>/<tag key name>,，其中標記命名空間是標記鍵定義所在的機構 ID 或專案名稱。標記鍵或值的簡短名稱長度上限為 256 個字元。短名稱允許的字元集包括 UTF-8 編碼的 Unicode 字元，但單引號 (')、雙引號 (")、反斜線 (\) 和正斜線 (/) 除外。

如要進一步瞭解 Google Cloud Platform 標記，請參閱「標記」。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
systemComponentsConfig

object (SystemComponentsConfig)

(選用步驟) 叢集上自動安裝元件的 Kubernetes 設定。

AttachedOidcConfig

目標叢集的 OIDC 探索資訊。

Kubernetes 服務帳戶 (KSA) 權杖是由叢集 API 伺服器簽署的 JWT 權杖。這個欄位表示 Google Cloud Platform 服務如何驗證 KSA 權杖，以允許系統工作負載 (例如 GKE Connect 和遙測代理程式) 回傳驗證至 Google Cloud Platform。

公開和私有簽發者網址的叢集都支援這項功能。如果是使用公開簽發者的叢集，只需要指定 issuerUrl 欄位；如果是使用私人簽發者的叢集，則需要提供 issuerUrl 和 oidc_jwks。

JSON 表示法 
{
  "issuerUrl": string,
  "jwks": string
}
欄位
issuerUrl

string

JSON Web Token (JWT) 簽發者 URI。issuer 必須以 https:// 開頭。
jwks

string (bytes format)

(選用步驟) JWKS 格式 (RFC 7517) 的 OIDC 驗證金鑰。其中列出可用於驗證 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 授予使用者。最多可提供十位管理員使用者。

如要進一步瞭解 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

附加叢集群組類型主體的 ID。

JSON 表示法 
{
  "group": string
}
欄位
group

string

這是必要旗標，群組名稱，例如 my-group@domain.com。

AttachedProxyConfig

Proxy 設定的詳細資料。

JSON 表示法 
{
  "kubernetesSecret": {
    object (KubernetesSecret)
  }
}
欄位
kubernetesSecret

object (KubernetesSecret)

包含 HTTP(S) Proxy 設定的 Kubernetes Secret 資源。密碼必須是 JSON 編碼的 Proxy 設定，如 EKS 叢集的 https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/eks/how-to/use-a-proxy#configure-proxy-support 和 AKS 叢集的 https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/aks/how-to/use-a-proxy#configure-proxy-support 所述。

KubernetesSecret

Kubernetes Secret 的相關資訊

JSON 表示法 
{
  "name": string,
  "namespace": string
}
欄位
name

string

Kubernetes Secret 名稱。
namespace

string

儲存 Kubernetes Secret 的命名空間。

SecurityPostureConfig

SecurityPostureConfig 會定義啟用/停用 Security Posture API 功能所需的旗標。

JSON 表示法 
{
  "vulnerabilityMode": enum (VulnerabilityMode)
}
欄位
vulnerabilityMode

enum (VulnerabilityMode)

設定要用於安全漏洞掃描的模式。

VulnerabilityMode

VulnerabilityMode 會定義安全漏洞掃描的啟用模式。

列舉
VULNERABILITY_MODE_UNSPECIFIED 未指定預設值。
VULNERABILITY_DISABLED 停用叢集的安全漏洞掃描功能。
VULNERABILITY_ENTERPRISE 在叢集 Enterprise 級別功能上套用安全防護機制的安全漏洞。

SystemComponentsConfig

SystemComponentsConfig 會定義欄位，用於自訂自動安裝元件的設定。

JSON 表示法 
{
  "tolerations": [
    {
      object (Toleration)
    }
  ],
  "labels": [
    {
      object (Label)
    }
  ]
}
欄位
tolerations[]

object (Toleration)

為自動安裝的元件所建立的 Pod 設定自訂容許度。
labels[]

object (Label)

為自動安裝的元件所建立的 Pod 設定自訂標籤。

容許條件

容許度會定義自動安裝元件所建立 Pod 的容許度欄位。

JSON 表示法 
{
  "key": string,
  "value": string,
  "keyOperator": enum (KeyOperator),
  "effect": enum (Effect)
}
欄位
key

string

Key 是容許事項適用的污點鍵。
value

string

Value 是容許事項套用的污點值。
keyOperator

enum (KeyOperator)

KeyOperator 代表鍵與值的關係，例如「Exist」。
effect

enum (Effect)

效果表示要比對的汙染效果，例如「NoSchedule」

KeyOperator

KeyOperator 代表鍵與值的關係，例如「Equal」。

列舉
KEY_OPERATOR_UNSPECIFIED 未指定運算子。
KEY_OPERATOR_EQUAL 運算子會對應至「等於」。
KEY_OPERATOR_EXISTS 運算子會對應至「Exists」。

效果

效果表示要比對的汙染效果，例如「NoSchedule」。

列舉
EFFECT_UNSPECIFIED 未指定效果。
EFFECT_NO_SCHEDULE 效果會對應至「NoSchedule」。
EFFECT_PREFER_NO_SCHEDULE 效果會對應至「PreferNoSchedule」。
EFFECT_NO_EXECUTE 效果會對應至「NoExecute」。

標籤

標籤會為自動安裝元件建立的 Pod 定義標籤的其他欄位。

JSON 表示法 
{
  "key": string,
  "value": string
}
欄位
key

string

這是標籤的鍵。
value

string

這是標籤的值。

方法

create

 在指定的 Google Cloud Platform 專案和區域中建立新的 AttachedCluster 資源。

delete

 刪除特定 AttachedCluster 資源。

generateAttachedClusterAgentToken

 為叢集代理程式產生存取權杖。

get

 說明特定 AttachedCluster 資源。

import

 匯入作業會匯入現有機群成員資格資源，藉此建立新的 AttachedCluster 資源。

list

 列出指定 Google Cloud 專案和區域中的所有 AttachedCluster 資源。

patch

 更新 AttachedCluster。