ClusterUpdate

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,
  "desiredDatabaseEncryption": {
    object (DatabaseEncryption)
  },
  "desiredWorkloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "desiredShieldedNodes": {
    object (ShieldedNodes)
  },
  "desiredNodePoolAutoscaling": {
    object (NodePoolAutoscaling)
  },
  "desiredLocations": [
    string
  ],
  "desiredMasterAuthorizedNetworksConfig": {
    object (MasterAuthorizedNetworksConfig)
  },
  "desiredClusterAutoscaling": {
    object (ClusterAutoscaling)
  },
  "desiredBinaryAuthorization": {
    object (BinaryAuthorization)
  },
  "desiredLoggingService": string,
  "desiredResourceUsageExportConfig": {
    object (ResourceUsageExportConfig)
  },
  "desiredVerticalPodAutoscaling": {
    object (VerticalPodAutoscaling)
  },
  "desiredPrivateClusterConfig": {
    object (PrivateClusterConfig)
  },
  "desiredIntraNodeVisibilityConfig": {
    object (IntraNodeVisibilityConfig)
  },
  "desiredDefaultSnatStatus": {
    object (DefaultSnatStatus)
  },
  "desiredReleaseChannel": {
    object (ReleaseChannel)
  },
  "desiredPrivateIpv6GoogleAccess": enum (PrivateIPv6GoogleAccess),
  "desiredNotificationConfig": {
    object (NotificationConfig)
  },
  "desiredMasterVersion": string
}
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" or "desiredNodePoolAutoscaling" 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.
desiredDatabaseEncryption

object (DatabaseEncryption)

Configuration of etcd encryption.
desiredWorkloadIdentityConfig

object (WorkloadIdentityConfig)

Configuration for Workload Identity.
desiredShieldedNodes

object (ShieldedNodes)

Configuration for Shielded Nodes.
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.
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.
desiredReleaseChannel

object (ReleaseChannel)

The desired release channel configuration.
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.

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

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.