REST Resource: projects.locations.clusters

リソース: Cluster

Google Distributed Cloud Edge Kubernetes クラスタ。

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "fleet": {
    object (Fleet)
  },
  "networking": {
    object (ClusterNetworking)
  },
  "authorization": {
    object (Authorization)
  },
  "defaultMaxPodsPerNode": integer,
  "endpoint": string,
  "port": integer,
  "clusterCaCertificate": string,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "controlPlaneVersion": string,
  "nodeVersion": string,
  "controlPlane": {
    object (ControlPlane)
  },
  "systemAddonsConfig": {
    object (SystemAddonsConfig)
  },
  "externalLoadBalancerIpv4AddressPools": [
    string
  ],
  "controlPlaneEncryption": {
    object (ControlPlaneEncryption)
  },
  "status": enum (Status),
  "maintenanceEvents": [
    {
      object (MaintenanceEvent)
    }
  ],
  "targetVersion": string,
  "releaseChannel": enum (ReleaseChannel),
  "survivabilityConfig": {
    object (SurvivabilityConfig)
  },
  "externalLoadBalancerIpv6AddressPools": [
    string
  ],
  "connectionState": {
    object (ConnectionState)
  },
  "externalLoadBalancerAddressPools": [
    {
      object (ExternalLoadBalancerPool)
    }
  ],
  "zoneStorageEncryption": {
    object (ZoneStorageEncryption)
  }
}
フィールド
name

string

必須。クラスタのリソース名。
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"。
labels

map (key: string, value: string)

このリソースに関連付けられたラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
fleet

object (Fleet)

必須。フリート構成。
networking

object (ClusterNetworking)

必須。クラスタ全体のネットワーキング構成。
authorization

object (Authorization)

必須。変更不可。GEC によって適用および管理される RBAC ポリシー。
defaultMaxPodsPerNode

integer

省略可。このクラスタ内のノードプールに最大値が明示的に指定されていない場合に使用される、ノードあたりのデフォルトの最大 Pod 数。これが指定されていない場合は、Kubernetes のデフォルト値が使用されます。
endpoint

string

出力専用。Kubernetes API サーバーの IP アドレス。
port

integer

出力専用。Kubernetes API サーバーのポート番号。
clusterCaCertificate

string

出力専用。クラスタの CA の PEM でエンコードされた公開証明書。
maintenancePolicy

object (MaintenancePolicy)

省略可。クラスタ全体のメンテナンス ポリシーの構成。
controlPlaneVersion

string

出力専用。コントロール プレーンのリリース バージョン
nodeVersion

string

出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。クラスタにワーカーノードがない場合、このフィールドは空にできます。
controlPlane

object (ControlPlane)

省略可。クラスタ コントロール プレーンの構成。
systemAddonsConfig

object (SystemAddonsConfig)

省略可。システム アドオンの構成。
externalLoadBalancerIpv4AddressPools[]

string

省略可。クラスタ データプレーンの外部ロード バランシング用の IPv4 アドレスプール。
controlPlaneEncryption

object (ControlPlaneEncryption)

省略可。リモート コントロール プレーンのディスク暗号化オプション。このフィールドは、CMEK サポートを有効にする場合にのみ使用されます。
status

enum (Status)

出力専用。クラスタの現在のステータス。
maintenanceEvents[]

object (MaintenanceEvent)

出力専用。クラスタにスケジュールされているすべてのメンテナンス イベント（進行中のイベント、今後予定されているイベント、過去に実施されたイベント（最大 90 日前まで）を含む）。
targetVersion

string

省略可。ターゲット クラスタのバージョン。例: 「1.5.0」。
releaseChannel

enum (ReleaseChannel)

省略可。クラスタが登録されているリリース チャンネル。
survivabilityConfig

object (SurvivabilityConfig)

省略可。クラスタのサバイバビリティの構成（ネットワーク接続が失われた場合など）。注: これは、ローカル コントロール プレーン クラスタにのみ適用されます。
externalLoadBalancerIpv6AddressPools[]

string

省略可。クラスタ データプレーンの外部ロード バランシング用の IPv6 アドレスプール。
connectionState

object (ConnectionState)

出力専用。クラスタの現在の接続状態。
externalLoadBalancerAddressPools[]

object (ExternalLoadBalancerPool)

省略可。クラスタの外部ロードバランサ プール。
zoneStorageEncryption

object (ZoneStorageEncryption)

省略可。ゾーン ストレージの暗号化構成

フリート

フリート関連の構成。

フリートとは、複数のクラスタを論理的に編成するための Google Cloud のコンセプトです。フリートを使用することによって、マルチクラスタ機能の使用と管理、複数のシステム間での一貫したポリシーの適用が可能になります。

JSON 表現 
{
  "project": string,
  "membership": string
}
フィールド
project

string

必須。このクラスタが登録されるフリート ホスト プロジェクトの名前。

プロジェクト名の形式は projects/<project-number> です。
membership

string

出力専用。このクラスタに関連付けられているマネージド Hub メンバーシップ リソースの名前。

メンバーシップ名の形式は projects/<project-number>/locations/global/membership/<cluster-id> です。

ClusterNetworking

クラスタ全体のネットワーキング構成。

JSON 表現 
{
  "clusterIpv4CidrBlocks": [
    string
  ],
  "servicesIpv4CidrBlocks": [
    string
  ]
}
フィールド
clusterIpv4CidrBlocks[]

string

必須。クラスタ内のすべての Pod には、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。サポートされるブロックは 1 つのみです。作成後にこのフィールドを変更することはできません。
servicesIpv4CidrBlocks[]

string

必須。クラスタ内のすべてのサービスには、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。サポートされるブロックは 1 つのみです。作成後にこのフィールドを変更することはできません。

承認

GEC によって適用および管理される RBAC ポリシー。

JSON 表現 
{
  "adminUsers": {
    object (ClusterUser)
  }
}
フィールド
adminUsers

object (ClusterUser)

必須。クラスタへの完全アクセス権をもつクラスタ管理者ロールが付与されるユーザー。現在、これは単一のフィールドですが、今後は複数の管理者を許可するように拡張される予定です。

ClusterUser

RBAC ポリシーのユーザー プリンシパル。

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

string

必須。有効な Google ユーザー名。

MaintenancePolicy

メンテナンス ポリシーの構成。

JSON 表現 
{
  "window": {
    object (MaintenanceWindow)
  },
  "maintenanceExclusions": [
    {
      object (MaintenanceExclusionWindow)
    }
  ]
}
フィールド
window

object (MaintenanceWindow)

メンテナンスが実行されるメンテナンスの時間枠を指定します。
maintenanceExclusions[]

object (MaintenanceExclusionWindow)

省略可。自動メンテナンスの除外。緊急以外のメンテナンスは、この時間枠内に行われません。各除外には一意の名前があり、有効または期限切れになることがあります。一度に許可されるメンテナンスの除外の最大数は 3 です。

MaintenanceWindow

メンテナンスの時間枠の構成

JSON 表現 
{
  "recurringWindow": {
    object (RecurringTimeWindow)
  }
}
フィールド
recurringWindow

object (RecurringTimeWindow)

定期メンテナンスの時間枠の構成。

RecurringTimeWindow

繰り返される任意の時間枠を表します。

JSON 表現 
{
  "window": {
    object (TimeWindow)
  },
  "recurrence": string
}
フィールド
window

object (TimeWindow)

最初の繰り返しの時間枠。
recurrence

string

この時間枠の繰り返し方法の RRULE（https://tools.ietf.org/html/rfc5545#section-3.8.5.3）。開始時刻から終了時刻までの期間にわたって継続します。

TimeWindow

任意の時間枠を表します。

JSON 表現 
{
  "startTime": string,
  "endTime": string
}
フィールド
startTime

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"。
endTime

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"。

MaintenanceExclusionWindow

メンテナンス除外時間枠を表します。

JSON 表現 
{
  "window": {
    object (TimeWindow)
  },
  "id": string
}
フィールド
window

object (TimeWindow)

省略可。期間。
id

string

省略可。ウィンドウの一意の ID（クラスタごと）。

ControlPlane

クラスタ コントロール プレーンの構成。

JSON 表現 
{

  // Union field config can be only one of the following:
  "remote": {
    object (Remote)
  },
  "local": {
    object (Local)
  }
  // End of list of possible types for union field config.
}
フィールド

共用体フィールド config。

config は次のいずれかになります。
remote

object (Remote)

リモート コントロール プレーンの構成。
local

object (Local)

ローカル コントロール プレーンの構成。

警告: ローカル コントロール プレーン クラスタは、独自のプロジェクトに作成する必要があります。ローカル コントロール プレーン クラスタは、GDCE 以外のクラスタを含む他のタイプのクラスタと同じプロジェクトに共存できません。ローカル コントロール プレーンの GDCE クラスタを同じプロジェクト内の他のタイプのクラスタと混在させると、データが失われる可能性があります。

リモート

この型にはフィールドがありません。

リモートでホストされているコントロール プレーンを持つクラスタに固有の構成。

ローカル

コントロール プレーンがローカルでホストされているクラスタに固有の構成。

警告: ローカル コントロール プレーン クラスタは、独自のプロジェクトに作成する必要があります。ローカル コントロール プレーン クラスタは、GDCE 以外のクラスタを含む他のタイプのクラスタと同じプロジェクトに共存できません。ローカル コントロール プレーンの GDCE クラスタを同じプロジェクト内の他のタイプのクラスタと混在させると、データが失われる可能性があります。

JSON 表現 
{
  "nodeLocation": string,
  "nodeCount": integer,
  "machineFilter": string,
  "sharedDeploymentPolicy": enum (SharedDeploymentPolicy),
  "controlPlaneNodeStorageSchema": string
}
フィールド
nodeLocation

string

このノードプールが作成される Google Distributed Cloud Edge ゾーンの名前。例: us-central1-edge-customer-a。
nodeCount

integer

コントロール プレーンのレプリカとして機能するノードの数。
machineFilter

string

このフィルタに一致するマシンのみがコントロール プレーン ノードをホストできます。フィルタリング言語は「name=」のような文字列を受け入れます。詳細については AIP-160 をご覧ください。
sharedDeploymentPolicy

enum (SharedDeploymentPolicy)

ユーザー アプリケーションのデプロイ方法に関するポリシー構成。
controlPlaneNodeStorageSchema

string

省略可。コントロール プレーン ノードのストレージ スキーマの名前。

警告: 構成可能なノード ローカル ストレージ スキーマ機能は試験運用版の機能であり、本番環境のクラスタ / ノードプールでの一般的な使用はおすすめしません。

SharedDeploymentPolicy

ユーザー アプリケーションのデプロイ方法に関するポリシー構成を表します。

列挙型
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED 指定なし。
ALLOWED ユーザー アプリケーションは、コントロール プレーンとワーカーノードの両方にデプロイできます。
DISALLOWED ユーザー アプリケーションはコントロール プレーン ノードにデプロイできず、ワーカーノードにのみデプロイできます。

SystemAddonsConfig

お客様が GDCE システム アドオンに定義できる構成。

JSON 表現 
{
  "ingress": {
    object (Ingress)
  },
  "vmServiceConfig": {
    object (VMServiceConfig)
  }
}
フィールド
ingress

object (Ingress)

省略可。Ingress の構成。
vmServiceConfig

object (VMServiceConfig)

省略可。VM サービスの構成。

Ingress

Ingress アドオンの構成。これにより、お客様は Ingress オブジェクトを作成して、クラスタ内のサーバーへの外部アクセスを管理できます。このアドオンは istiod と istio-ingress で構成されています。

JSON 表現 
{
  "disabled": boolean,
  "ipv4Vip": string
}
フィールド
disabled

boolean

省略可。Ingress が無効かどうか。
ipv4Vip

string

省略可。Ingress VIP。

VMServiceConfig

VMServiceConfig は、GDCE VM Service の構成を定義します。

JSON 表現 
{
  "vmmEnabled": boolean
}
フィールド
vmmEnabled

boolean

省略可。VMM が有効かどうか。

ControlPlaneEncryption

コントロール プレーン ノードの顧客管理の KMS 鍵サポートの構成。

JSON 表現 
{
  "kmsKey": string,
  "kmsKeyActiveVersion": string,
  "kmsKeyState": enum (KmsKeyState),
  "kmsStatus": {
    object (Status)
  },
  "resourceState": enum (ResourceState)
}
フィールド
kmsKey

string

省略可。コントロール プレーン ディスクの保護に使用する Cloud KMS CryptoKey（例: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}）。指定しない場合は、Google が管理する鍵が代わりに使用されます。
kmsKeyActiveVersion

string

出力専用。コントロール プレーン ディスクの保護に現在使用されている Cloud KMS CryptoKeyVersion。kmsKey が設定されている場合にのみ適用されます。
kmsKeyState

enum (KmsKeyState)

出力専用。Cloud KMS CryptoKey の可用性。KEY_AVAILABLE でない場合、ノードはローカルデータにアクセスできないため、オフラインになる可能性があります。これは、鍵を使用する権限がない場合や、鍵が無効になっているか削除されている場合に発生することがあります。
kmsStatus

object (Status)

出力専用。この鍵の使用時に Cloud KMS から返されるエラー ステータス。このフィールドは、kmsKeyState が KMS_KEY_STATE_KEY_AVAILABLE でない場合にのみ入力されます。このフィールドに値が入力されている場合、Cloud KMS によって報告されたエラー ステータスが含まれます。
resourceState

enum (ResourceState)

出力専用。CMEK に関連付けられている現在のリソースの状態。

ステータス

クラスタのステータスを示します。

列挙型
STATUS_UNSPECIFIED ステータスが不明です。
PROVISIONING クラスタを作成しています。
RUNNING クラスタが作成され、完全に使用可能。
DELETING クラスタを削除しています。
ERROR このステータスは、クラスタの調整または削除中にエラーが発生したことを示します。
RECONCILING クラスタでバージョン アップグレードなどの作業が進行中です。

MaintenanceEvent

メンテナンス イベントとは、クラスタ ワークロードの一時的な中断を引き起こす可能性のあるオペレーションです。これには、Google 主導またはユーザー主導のクラスタ アップグレード、ノードの再起動を必要とするユーザー主導のクラスタ構成変更などが含まれます。

JSON 表現 
{
  "uuid": string,
  "targetVersion": string,
  "operation": string,
  "type": enum (Type),
  "schedule": enum (Schedule),
  "state": enum (State),
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "updateTime": string
}
フィールド
uuid

string

出力専用。メンテナンス イベントの UUID。
targetVersion

string

出力専用。クラスタのターゲット バージョン。
operation

string

出力専用。メンテナンス イベントを実行するオペレーション。projects/*/locations/*/operations/* の形式で指定します。メンテナンス イベントが複数のオペレーションに分割されている場合（メンテナンスの時間枠など）、最新のオペレーションが記録されます。
type

enum (Type)

出力専用。メンテナンス イベントのタイプ。
schedule

enum (Schedule)

出力専用。メンテナンス イベントのスケジュール。
state

enum (State)

出力専用。メンテナンス イベントの状態。
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"。
startTime

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"。
endTime

string (Timestamp format)

出力専用。メンテナンス イベントが終了した時刻（成功したかどうかは問わない）。メンテナンス イベントが複数のメンテナンスの時間枠に分割されている場合、endTime はフロー全体が終了したときにのみ更新されます。

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"。

種類

メンテナンス イベントのタイプを示します。

列挙型
TYPE_UNSPECIFIED 指定なし。
USER_INITIATED_UPGRADE ユーザーがアップグレードを開始した。
GOOGLE_DRIVEN_UPGRADE Google が主導するアップグレード。

スケジュール

メンテナンス イベントを実行するタイミングを示します。

列挙型
SCHEDULE_UNSPECIFIED 指定なし。
IMMEDIATELY リクエストを受け取ったらすぐに応答します。

状態

メンテナンス イベントの状態を示します。

列挙型
STATE_UNSPECIFIED 指定なし。
RECONCILING メンテナンス イベントが進行中です。クラスタが使用できない可能性があります。
SUCCEEDED メンテナンス イベントが成功しました。
FAILED メンテナンス イベントが失敗しました。

ReleaseChannel

クラスタが登録されているリリース チャンネル。

列挙型
RELEASE_CHANNEL_UNSPECIFIED リリース チャンネルが指定されていません。デフォルトは REGULAR チャンネルです。
NONE リリース チャンネルなし。
REGULAR Regular リリース チャンネル。

SurvivabilityConfig

クラスタのサバイバビリティの構成（ネットワーク接続が失われた場合など）。

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

string (Duration format)

省略可。クラスタノードを再起動して、Google へのネットワーク接続なしで機能できるようにする期間。デフォルトの 0 は、許可されていないことを意味します。最長で 7 日です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

ConnectionState

ConnectionState には、クラスタから Google への現在の接続状態が保持されます。

JSON 表現 
{
  "state": enum (State),
  "updateTime": string
}
フィールド
state

enum (State)

出力専用。現在の接続状態。
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"。

状態

接続状態。

列挙型
STATE_UNSPECIFIED 接続状態が不明です。
DISCONNECTED このクラスタは現在、Google から切断されています。
CONNECTED このクラスタは現在 Google に接続されています。
CONNECTED_AND_SYNCING このクラスタは現在 Google に接続されていますが、最近切断された後に再接続された可能性があります。まだ同期中です。

ExternalLoadBalancerPool

名前、手動 / 自動割り当て、重複しない IPv4 アドレス範囲、オプションの IPv6 アドレス範囲などのカスタム構成を持つ外部ロードバランサ プール。

JSON 表現 
{
  "addressPool": string,
  "ipv4Range": [
    string
  ],
  "ipv6Range": [
    string
  ],
  "avoidBuggyIps": boolean,
  "manualAssign": boolean
}
フィールド
addressPool

string

省略可。外部ロードバランサ プールの名前。
ipv4Range[]

string

必須。外部ロードバランサ プールの重複しない IPv4 アドレス範囲。
ipv6Range[]

string

省略可。外部ロードバランサ プールの重複しない IPv6 アドレス範囲。
avoidBuggyIps

boolean

省略可。true の場合、末尾が .0 と .255 の IP アドレスがプールから除外されます。一部のネットワーク ハードウェアは、これらの特別なアドレスへのトラフィックをドロップします。デフォルト値は false です。
manualAssign

boolean

省略可。true の場合、このプール内のアドレスは Kubernetes Service に自動的に割り当てられません。true の場合、このプール内の IP アドレスは、サービスによって明示的に指定された場合にのみ使用されます。デフォルト値は false です。

ZoneStorageEncryption

ゾーン ストレージの CMEK サポートの構成

JSON 表現 
{
  "kmsKey": string,
  "kmsKeyActiveVersion": string,
  "resourceState": enum (ResourceState)
}
フィールド
kmsKey

string

省略可。Cloud KMS 鍵
kmsKeyActiveVersion

string

出力専用。現在暗号化 / 復号に使用されている Cloud KMS CryptoKeyVersion
resourceState

enum (ResourceState)

出力専用。CMEK の現在のリソース状態

メソッド

create

 指定されたプロジェクトとロケーションに新しいクラスタを作成します。

delete

 1 つのクラスタを削除します。

generateAccessToken

 クラスタのアクセス トークンを生成します。

generateOfflineCredential

 クラスタのオフライン認証情報を生成します。

get

 1 つのクラスタの詳細を取得します。

list

 指定されたプロジェクトとロケーションのクラスタを一覧表示します。

patch

 単一のクラスタのパラメータを更新します。

upgrade

 単一のクラスタをアップグレードします。