ClusterUpdate

Stay organized with collections Save and categorize content based on your preferences.

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

JSON representation 
{
  "desiredNodeVersion": string,
  "desiredMonitoringService": string,
  "desiredAddonsConfig": {
    object (AddonsConfig)
  },
  "desiredNodePoolId": string,
  "desiredImageType": string,
  "desiredNodePoolAutoscaling": {
    object (NodePoolAutoscaling)
  },
  "desiredLocations": [
    string
  ],
  "desiredMasterAuthorizedNetworksConfig": {
    object (MasterAuthorizedNetworksConfig)
  },
  "desiredPodSecurityPolicyConfig": {
    object (PodSecurityPolicyConfig)
  },
  "desiredClusterAutoscaling": {
    object (ClusterAutoscaling)
  },
  "desiredBinaryAuthorization": {
    object (BinaryAuthorization)
  },
  "desiredLoggingService": string,
  "desiredResourceUsageExportConfig": {
    object (ResourceUsageExportConfig)
  },
  "desiredVerticalPodAutoscaling": {
    object (VerticalPodAutoscaling)
  },
  "desiredPrivateClusterConfig": {
    object (PrivateClusterConfig)
  },
  "desiredIntraNodeVisibilityConfig": {
    object (IntraNodeVisibilityConfig)
  },
  "desiredDefaultSnatStatus": {
    object (DefaultSnatStatus)
  },
  "desiredClusterTelemetry": {
    object (ClusterTelemetry)
  },
  "desiredReleaseChannel": {
    object (ReleaseChannel)
  },
  "desiredTpuConfig": {
    object (TpuConfig)
  },
  "desiredL4ilbSubsettingConfig": {
    object (ILBSubsettingConfig)
  },
  "desiredDatapathProvider": enum (DatapathProvider),
  "desiredPrivateIpv6GoogleAccess": enum (PrivateIPv6GoogleAccess),
  "desiredNotificationConfig": {
    object (NotificationConfig)
  },
  "desiredMasterVersion": string,
  "desiredGcfsConfig": {
    object (GcfsConfig)
  },
  "desiredDatabaseEncryption": {
    object (DatabaseEncryption)
  },
  "desiredWorkloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "desiredWorkloadCertificates": {
    object (WorkloadCertificates)
  },
  "desiredMeshCertificates": {
    object (MeshCertificates)
  },
  "desiredWorkloadAltsConfig": {
    object (WorkloadALTSConfig)
  },
  "desiredShieldedNodes": {
    object (ShieldedNodes)
  },
  "desiredCostManagementConfig": {
    object (CostManagementConfig)
  },
  "desiredMaster": {
    object (Master)
  },
  "desiredDnsConfig": {
    object (DNSConfig)
  },
  "desiredServiceExternalIpsConfig": {
    object (ServiceExternalIPsConfig)
  },
  "desiredAuthenticatorGroupsConfig": {
    object (AuthenticatorGroupsConfig)
  },
  "desiredLoggingConfig": {
    object (LoggingConfig)
  },
  "desiredMonitoringConfig": {
    object (MonitoringConfig)
  },
  "desiredIdentityServiceConfig": {
    object (IdentityServiceConfig)
  },
  "desiredNodePoolAutoConfigNetworkTags": {
    object (NetworkTags)
  },
  "desiredGatewayApiConfig": {
    object (GatewayAPIConfig)
  },
  "etag": string,
  "desiredNodePoolLoggingConfig": {
    object (NodePoolLoggingConfig)
  },
  "desiredStackType": enum (StackType),
  "desiredEnablePrivateEndpoint": boolean,
  "desiredProtectConfig": {
    object (ProtectConfig)
  }
}
Fields
desiredNodeVersion

string

The Kubernetes version to change the nodes to (typically an upgrade).

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the Kubernetes master version
desiredMonitoringService

string

The monitoring service the cluster should use to write metrics. Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster.

If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.
desiredAddonsConfig

object (AddonsConfig)

Configurations for the various addons available to run in the cluster.
desiredNodePoolId

string

The node pool to be upgraded. This field is mandatory if "desiredNodeVersion", "desired_image_family", "desiredNodePoolAutoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster.
desiredImageType

string

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
desiredNodePoolAutoscaling

object (NodePoolAutoscaling)

Autoscaler configuration for the node pool specified in desiredNodePoolId. If there is only one pool in the cluster and desiredNodePoolId is not provided then the change applies to that single node pool.
desiredLocations[]

string

The desired list of Google Compute Engine zones in which the cluster's nodes should be located.

This list must always include the cluster's primary zone.

Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
desiredMasterAuthorizedNetworksConfig

object (MasterAuthorizedNetworksConfig)

The desired configuration options for master authorized networks feature.
desiredPodSecurityPolicyConfig

object (PodSecurityPolicyConfig)

The desired configuration options for the PodSecurityPolicy feature.
desiredClusterAutoscaling

object (ClusterAutoscaling)

Cluster-level autoscaling configuration.
desiredBinaryAuthorization

object (BinaryAuthorization)

The desired configuration options for the Binary Authorization feature.
desiredLoggingService

string

The logging service the cluster should use to write logs. Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
  • none - no logs will be exported from the cluster.

If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
desiredResourceUsageExportConfig

object (ResourceUsageExportConfig)

The desired configuration for exporting resource usage.
desiredVerticalPodAutoscaling

object (VerticalPodAutoscaling)

Cluster-level Vertical Pod Autoscaling configuration.
desiredPrivateClusterConfig

object (PrivateClusterConfig)

The desired private cluster configuration.
desiredIntraNodeVisibilityConfig

object (IntraNodeVisibilityConfig)

The desired config of Intra-node visibility.
desiredDefaultSnatStatus

object (DefaultSnatStatus)

The desired status of whether to disable default sNAT for this cluster.
desiredClusterTelemetry

object (ClusterTelemetry)

The desired telemetry integration for the cluster.
desiredReleaseChannel

object (ReleaseChannel)

The desired release channel configuration.
desiredTpuConfig

object (TpuConfig)

The desired Cloud TPU configuration.
desiredL4ilbSubsettingConfig

object (ILBSubsettingConfig)

The desired L4 Internal Load Balancer Subsetting configuration.
desiredDatapathProvider

enum (DatapathProvider)

The desired datapath provider for the cluster.
desiredPrivateIpv6GoogleAccess

enum (PrivateIPv6GoogleAccess)

The desired state of IPv6 connectivity to Google Services.
desiredNotificationConfig

object (NotificationConfig)

The desired notification configuration.
desiredMasterVersion

string

The Kubernetes version to change the master to. The only valid value is the latest supported version.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the default Kubernetes version
desiredGcfsConfig

object (GcfsConfig)

The desired GCFS config for the cluster.
desiredDatabaseEncryption

object (DatabaseEncryption)

Configuration of etcd encryption.
desiredWorkloadIdentityConfig

object (WorkloadIdentityConfig)

Configuration for Workload Identity.
desiredWorkloadCertificates

object (WorkloadCertificates)

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
desiredMeshCertificates

object (MeshCertificates)

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
desiredWorkloadAltsConfig

object (WorkloadALTSConfig)

Configuration for direct-path (via ALTS) with workload identity.
desiredShieldedNodes

object (ShieldedNodes)

Configuration for Shielded Nodes.
desiredCostManagementConfig

object (CostManagementConfig)

The desired configuration for the fine-grained cost management feature.
desiredMaster

object (Master)

Configuration for master components.
desiredDnsConfig

object (DNSConfig)

DNSConfig contains clusterDNS config for this cluster.
desiredServiceExternalIpsConfig

object (ServiceExternalIPsConfig)

ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
desiredAuthenticatorGroupsConfig

object (AuthenticatorGroupsConfig)

AuthenticatorGroupsConfig specifies the config for the cluster security groups settings.
desiredLoggingConfig

object (LoggingConfig)

The desired logging configuration.
desiredMonitoringConfig

object (MonitoringConfig)

The desired monitoring configuration.
desiredIdentityServiceConfig

object (IdentityServiceConfig)

The desired Identity Service component configuration.
desiredNodePoolAutoConfigNetworkTags

object (NetworkTags)

The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
desiredGatewayApiConfig

object (GatewayAPIConfig)

The desired config of Gateway API on this cluster.
etag

string

The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.
desiredNodePoolLoggingConfig

object (NodePoolLoggingConfig)

The desired node pool logging configuration defaults for the cluster.
desiredStackType

enum (StackType)

The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.
desiredEnablePrivateEndpoint

boolean

Enable/Disable private endpoint for the cluster's master.
desiredProtectConfig

object (ProtectConfig)

Enable/Disable Protect API features for the cluster.

IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.

JSON representation 
{
  "enabled": boolean
}
Fields
enabled

boolean

Enables intra node visibility for this cluster.

ILBSubsettingConfig

ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.

JSON representation 
{
  "enabled": boolean
}
Fields
enabled

boolean

Enables l4 ILB subsetting for this cluster

StackType

Possible values for IP stack type

Enums
STACK_TYPE_UNSPECIFIED By default, the clusters will be IPV4 only
IPV4 The value used if the cluster is a IPV4 only
IPV4_IPV6 The value used if the cluster is a dual stack cluster