REST Resource: projects.locations.clusters.nodePools

Resource: NodePool

A set of Kubernetes nodes in a cluster with common configuration and specification.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "nodeLocation": string,
  "nodeCount": integer,
  "machineFilter": string,
  "localDiskEncryption": {
    object (LocalDiskEncryption)
  }
}
Fields
name

string

Required. The resource name of the node pool.

createTime

string (Timestamp format)

Output only. The time when the node pool was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The time when the node pool was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels associated with this resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

nodeLocation

string

Name of the Google Distributed Cloud Edge zone where this node pool will be created. For example: us-central1-edge-customer-a.

nodeCount

integer

Required. The number of nodes in the pool.

machineFilter

string

Only machines matching this filter will be allowed to join the node pool. The filtering language accepts strings like "name=", and is documented in more detail in AIP-160.

localDiskEncryption

object (LocalDiskEncryption)

Optional. Local disk encryption options. This field is only used when enabling CMEK support.

LocalDiskEncryption

Configuration for CMEK support for edge machine local disk encryption.

JSON representation
{
  "kmsKey": string,
  "kmsKeyActiveVersion": string,
  "kmsKeyState": enum (KmsKeyState),
  "kmsStatus": {
    object (Status)
  }
}
Fields
kmsKey

string

Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting node local disks. If not specified, a Google-managed key will be used instead.

kmsKeyActiveVersion

string

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting node local disks. Only applicable if kmsKey is set.

kmsKeyState

enum (KmsKeyState)

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

kmsStatus

object (Status)

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kmsKeyState is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

KmsKeyState

Represents the accessibility state of a customer-managed KMS key used for CMEK integration.

Enums
KMS_KEY_STATE_UNSPECIFIED Unspecified.
KMS_KEY_STATE_KEY_AVAILABLE The key is available for use, and dependent resources should be accessible.
KMS_KEY_STATE_KEY_UNAVAILABLE The key is unavailable for an unspecified reason. Dependent resources may be inaccessible.

Methods

create

Creates a new NodePool in a given project and location.

delete

Deletes a single NodePool.

get

Gets details of a single NodePool.

list

Lists NodePools in a given project and location.

patch

Updates the parameters of a single NodePool.