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 ( |
Fields | |
---|---|
desiredNodeVersion |
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:
|
desiredMonitoringService |
The monitoring service the cluster should use to write metrics. Currently available options:
If left as an empty string, |
desiredAddonsConfig |
Configurations for the various addons available to run in the cluster. |
desiredNodePoolId |
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 |
The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. |
desiredNodePoolAutoscaling |
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[] |
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 |
The desired configuration options for master authorized networks feature. Deprecated: Use desiredControlPlaneEndpointsConfig.ip_endpoints_config.authorized_networks_config instead. |
desiredPodSecurityPolicyConfig |
The desired configuration options for the PodSecurityPolicy feature. |
desiredClusterAutoscaling |
Cluster-level autoscaling configuration. |
desiredBinaryAuthorization |
The desired configuration options for the Binary Authorization feature. |
desiredLoggingService |
The logging service the cluster should use to write logs. Currently available options:
If left as an empty string, |
desiredResourceUsageExportConfig |
The desired configuration for exporting resource usage. |
desiredVerticalPodAutoscaling |
Cluster-level Vertical Pod Autoscaling configuration. |
desiredPrivateClusterConfig |
The desired private cluster configuration. masterGlobalAccessConfig is the only field that can be changed via this field. See also Deprecated: Use desiredControlPlaneEndpointsConfig.ip_endpoints_config.global_access instead. |
desiredIntraNodeVisibilityConfig |
The desired config of Intra-node visibility. |
desiredDefaultSnatStatus |
The desired status of whether to disable default sNAT for this cluster. |
desiredClusterTelemetry |
The desired telemetry integration for the cluster. |
desiredReleaseChannel |
The desired release channel configuration. |
privateClusterConfig |
The desired private cluster configuration. Has no effect. Use |
desiredTpuConfig |
The desired Cloud TPU configuration. |
desiredL4ilbSubsettingConfig |
The desired L4 Internal Load Balancer Subsetting configuration. |
desiredDatapathProvider |
The desired datapath provider for the cluster. |
desiredPrivateIpv6GoogleAccess |
The desired state of IPv6 connectivity to Google Services. |
desiredNotificationConfig |
The desired notification configuration. |
desiredMasterVersion |
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:
|
desiredParentProductConfig |
The desired parent product config for the cluster. |
desiredGcfsConfig |
The desired GCFS config for the cluster. |
desiredDatabaseEncryption |
Configuration of etcd encryption. |
desiredWorkloadIdentityConfig |
Configuration for Workload Identity. |
desiredWorkloadCertificates |
Configuration for issuance of mTLS keys and certificates to Kubernetes pods. |
desiredMeshCertificates |
Configuration for issuance of mTLS keys and certificates to Kubernetes pods. |
desiredWorkloadAltsConfig |
Configuration for direct-path (via ALTS) with workload identity. |
desiredShieldedNodes |
Configuration for Shielded Nodes. |
desiredCostManagementConfig |
The desired configuration for the fine-grained cost management feature. |
desiredMaster |
Configuration for master components. |
desiredDnsConfig |
DNSConfig contains clusterDNS config for this cluster. |
desiredServiceExternalIpsConfig |
ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field. |
desiredAuthenticatorGroupsConfig |
AuthenticatorGroupsConfig specifies the config for the cluster security groups settings. |
desiredLoggingConfig |
The desired logging configuration. |
desiredMonitoringConfig |
The desired monitoring configuration. |
desiredIdentityServiceConfig |
The desired Identity Service component configuration. |
desiredControlPlaneEndpointsConfig |
|
desiredNodePoolAutoConfigNetworkTags |
The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. |
desiredGatewayApiConfig |
The desired config of Gateway API on this cluster. |
etag |
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 |
The desired node pool logging configuration defaults for the cluster. |
desiredFleet |
The desired fleet configuration for the cluster. |
desiredStackType |
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. |
additionalPodRangesConfig |
The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. |
removedAdditionalPodRangesConfig |
The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additionalPodRangesConfig' argument. |
enableK8sBetaApis |
Kubernetes open source beta apis enabled on the cluster. Only beta apis |
desiredSecurityPostureConfig |
Enable/Disable Security Posture API features for the cluster. |
desiredNetworkPerformanceConfig |
The desired network performance config. |
desiredAutopilotWorkloadPolicyConfig |
The desired workload policy configuration for the autopilot cluster. |
desiredK8sBetaApis |
Beta APIs enabled for cluster. |
desiredHostMaintenancePolicy |
HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts. |
desiredContainerdConfig |
The desired containerd config for the cluster. |
desiredNodePoolAutoConfigResourceManagerTags |
The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. |
desiredNodeKubeletConfig |
The desired node kubelet config for the cluster. |
desiredNodePoolAutoConfigKubeletConfig |
The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. |
userManagedKeysConfig |
The Custom keys configuration for the cluster. |
desiredEnablePrivateEndpoint |
Enable/Disable private endpoint for the cluster's master. Deprecated: Use desiredControlPlaneEndpointsConfig.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enablePublicEndpoint is reversed: if enablePrivateEndpoint is false, then enablePublicEndpoint will be true. |
desiredDefaultEnablePrivateNodes |
Override the default setting of whether future created nodes have private IP addresses only, namely |
desiredProtectConfig |
Deprecated: Use DesiredSecurityPostureConfig instead. Enable/Disable Protect API features for the cluster. |
desiredEnableFqdnNetworkPolicy |
Enable/Disable FQDN Network Policy for the cluster. |
desiredEnableMultiNetworking |
Enable/Disable Multi-Networking for the cluster |
desiredInTransitEncryptionConfig |
Specify the details of in-transit encryption. Now named inter-node transparent encryption. |
desiredEnableCiliumClusterwideNetworkPolicy |
Enable/Disable Cilium Clusterwide Network Policy for the cluster. |
desiredSecretManagerConfig |
Enable/Disable Secret Manager Config. |
desiredCompliancePostureConfig |
Enable/Disable Compliance Posture features for the cluster. |
desiredRbacBindingConfig |
RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. |
IntraNodeVisibilityConfig
IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
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 |
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 |