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,
  "desiredNodePoolAutoscaling": {
    object(NodePoolAutoscaling)
  },
  "desiredLocations": [
    string
  ],
  "desiredMasterAuthorizedNetworksConfig": {
    object(MasterAuthorizedNetworksConfig)
  },
  "desiredPodSecurityPolicyConfig": {
    object(PodSecurityPolicyConfig)
  },
  "desiredClusterAutoscaling": {
    object(ClusterAutoscaling)
  },
  "desiredBinaryAuthorization": {
    object(BinaryAuthorization)
  },
  "desiredLoggingService": string,
  "desiredVerticalPodAutoscaling": {
    object(VerticalPodAutoscaling)
  },
  "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 Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver
  • "monitoring.googleapis.com" - the Google Cloud Monitoring service
  • "none" - no metrics will be exported from the cluster

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.

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 locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.

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

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 metrics. Currently available options:

  • "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver
  • "logging.googleapis.com" - the Google Cloud Logging service
  • "none" - no logs will be exported from the cluster

desiredVerticalPodAutoscaling

object(VerticalPodAutoscaling)

Cluster-level Vertical Pod Autoscaling 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

Was this page helpful? Let us know how we did:

Send feedback about...

Kubernetes Engine