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

出力専用。クラスタのグローバルな固有識別子。
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) トラフィックのプロキシ構成。
binaryAuthorization

object (BinaryAuthorization)

省略可。このクラスタの Binary Authorization 構成。
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 Service Account（KSA）トークンは、クラスタ API サーバーが署名した JWT トークンです。このフィールドは、システム ワークロード（GKE Connect やテレメトリー エージェントなど）が Google Cloud Platform に対して認証を行えるようにするために Google Cloud Platform サービスが KSA トークンを検証する仕組みを示します。

公開の発行者 URL と限定公開の発行者 URL を持つクラスタの両方がサポートされます。公開の発行者を持つクラスタでは issuerUrl フィールドを指定するだけで、限定公開の発行者を持つクラスタは issuerUrl と oidc_jwks の両方を指定する必要があります。

JSON 表現 
{
  "issuerUrl": string,
  "jwks": string
}
フィールド
issuerUrl

string

JSON Web Token（JWT）の発行者 URI。issuer は https:// で始まる必要があります。
jwks

string (bytes format)

省略可。OIDC 検証鍵（JWKS 形式）（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)

省略可。クラスタ管理者としてオペレーションを実行できるユーザーユーザーに cluster-admin ClusterRole を付与するために、管理対象の ClusterRoleBinding が作成されます。最大 10 人の管理者ユーザーを指定できます。

RBAC の詳細については、https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles をご覧ください。
adminGroups[]

object (AttachedClusterGroup)

省略可。クラスタ管理者としてオペレーションを実行できるユーザーのグループ。グループに cluster-admin ClusterRole を付与するために、管理対象の ClusterRoleBinding が作成されます。最大 10 個の管理者グループを指定できます。

RBAC の詳細については、https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles をご覧ください。

AttachedClusterUser

接続されたクラスタのユーザータイプのサブジェクトの ID。

JSON 表現 
{
  "username": string
}
フィールド
username

string

必須。ユーザーの名前（例: my-gcp-id@gmail.com）。

AttachedClusterGroup

接続クラスタのグループタイプのサブジェクトの ID。

JSON 表現 
{
  "group": string
}
フィールド
group

string

必須。グループの名前（例: my-group@domain.com）。

AttachedProxyConfig

プロキシ構成の詳細。

JSON 表現 
{
  "kubernetesSecret": {
    object (KubernetesSecret)
  }
}
フィールド
kubernetesSecret

object (KubernetesSecret)

HTTP(S) プロキシ構成を含む Kubernetes Secret リソース。シークレットは、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 で説明されている JSON エンコード プロキシ構成である必要があります。

KubernetesSecret

Kubernetes Secret に関する情報

JSON 表現 
{
  "name": string,
  "namespace": string
}
フィールド
name

string

Kubernetes Secret の名前。
namespace

string

Kubernetes Secret が保存されている Namespace。

SecurityPostureConfig

SecurityPostureConfig は、Security Posture API の機能を有効または無効にするために必要なフラグを定義します。

JSON 表現 
{
  "vulnerabilityMode": enum (VulnerabilityMode)
}
フィールド
vulnerabilityMode

enum (VulnerabilityMode)

脆弱性スキャンに使用するモードを設定します。

VulnerabilityMode

VulnerabilityMode は、脆弱性スキャンの有効化モードを定義します。

列挙型
VULNERABILITY_MODE_UNSPECIFIED デフォルト値が指定されていません。
VULNERABILITY_DISABLED クラスタでの脆弱性スキャンを無効にします。
VULNERABILITY_ENTERPRISE エンタープライズ レベルのクラスタ機能にセキュリティ ポスチャーの脆弱性を適用します。

SystemComponentsConfig

SystemComponentsConfig は、自動インストールされるコンポーネントの構成をカスタマイズするためのフィールドを定義します。

JSON 表現 
{
  "tolerations": [
    {
      object (Toleration)
    }
  ],
  "labels": [
    {
      object (Label)
    }
  ]
}
フィールド
tolerations[]

object (Toleration)

自動インストールされたコンポーネントによって作成された Pod のカスタム許容値を設定します。
labels[]

object (Label)

自動インストールされたコンポーネントによって作成された Pod のカスタムラベルを設定します。

toleration

Toleration は、自動インストールされたコンポーネントによって作成された Pod の Toleration のフィールドを定義します。

JSON 表現 
{
  "key": string,
  "value": string,
  "keyOperator": enum (KeyOperator),
  "effect": enum (Effect)
}
フィールド
key

string

key は、toleration が適用される taint キーです。
value

string

value は、toleration が適用される taint 値です。
keyOperator

enum (KeyOperator)

KeyOperator は、値に対するキーの関係（「Exist」など）を表します。
effect

enum (Effect)

Effect は、一致する taint 効果（例: 'NoSchedule'）を示します。

KeyOperator

KeyOperator は、値に対するキーの関係（「等しい」など）を表します。

列挙型
KEY_OPERATOR_UNSPECIFIED 演算子が指定されていません。
KEY_OPERATOR_EQUAL 演算子は「等しい」にマッピングされます。
KEY_OPERATOR_EXISTS 演算子は「Exists」にマッピングされます。

効果

Effect は、一致する taint 効果（「NoSchedule」など）を示します。

列挙型
EFFECT_UNSPECIFIED 効果が指定されていません。
EFFECT_NO_SCHEDULE 効果は NoSchedule にマッピングされます。
EFFECT_PREFER_NO_SCHEDULE 効果は PreferNoSchedule にマッピングされます。
EFFECT_NO_EXECUTE 効果は NoExecute にマッピングされます。

ラベル

Label は、自動インストールされたコンポーネントによって作成された 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 を更新します。