Class ClusterUpdate (2.54.0) 

ClusterUpdate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
desired_node_version str
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
desired_monitoring_service str
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.
desired_addons_config google.cloud.container_v1.types.AddonsConfig
Configurations for the various addons available to run in the cluster.
desired_node_pool_id str
The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
desired_image_type str
The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
desired_database_encryption google.cloud.container_v1.types.DatabaseEncryption
Configuration of etcd encryption.
desired_workload_identity_config google.cloud.container_v1.types.WorkloadIdentityConfig
Configuration for Workload Identity.
desired_mesh_certificates google.cloud.container_v1.types.MeshCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
desired_shielded_nodes google.cloud.container_v1.types.ShieldedNodes
Configuration for Shielded Nodes.
desired_cost_management_config google.cloud.container_v1.types.CostManagementConfig
The desired configuration for the fine-grained cost management feature.
desired_dns_config google.cloud.container_v1.types.DNSConfig
DNSConfig contains clusterDNS config for this cluster.
desired_node_pool_autoscaling google.cloud.container_v1.types.NodePoolAutoscaling
Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
desired_locations MutableSequence[str]
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.
desired_master_authorized_networks_config google.cloud.container_v1.types.MasterAuthorizedNetworksConfig
The desired configuration options for master authorized networks feature. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config instead.
desired_cluster_autoscaling google.cloud.container_v1.types.ClusterAutoscaling
Cluster-level autoscaling configuration.
desired_binary_authorization google.cloud.container_v1.types.BinaryAuthorization
The desired configuration options for the Binary Authorization feature.
desired_logging_service str
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.
desired_resource_usage_export_config google.cloud.container_v1.types.ResourceUsageExportConfig
The desired configuration for exporting resource usage.
desired_vertical_pod_autoscaling google.cloud.container_v1.types.VerticalPodAutoscaling
Cluster-level Vertical Pod Autoscaling configuration.
desired_private_cluster_config google.cloud.container_v1.types.PrivateClusterConfig
The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field. See also ClusterUpdate.desired_enable_private_endpoint][google.container.v1.ClusterUpdate.desired_enable_private_endpoint] for modifying other fields within PrivateClusterConfig][google.container.v1.PrivateClusterConfig]. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead.
desired_intra_node_visibility_config google.cloud.container_v1.types.IntraNodeVisibilityConfig
The desired config of Intra-node visibility.
desired_default_snat_status google.cloud.container_v1.types.DefaultSnatStatus
The desired status of whether to disable default sNAT for this cluster.
desired_release_channel google.cloud.container_v1.types.ReleaseChannel
The desired release channel configuration.
desired_l4ilb_subsetting_config google.cloud.container_v1.types.ILBSubsettingConfig
The desired L4 Internal Load Balancer Subsetting configuration.
desired_datapath_provider google.cloud.container_v1.types.DatapathProvider
The desired datapath provider for the cluster.
desired_private_ipv6_google_access google.cloud.container_v1.types.PrivateIPv6GoogleAccess
The desired state of IPv6 connectivity to Google Services.
desired_notification_config google.cloud.container_v1.types.NotificationConfig
The desired notification configuration.
desired_authenticator_groups_config google.cloud.container_v1.types.AuthenticatorGroupsConfig
The desired authenticator groups config for the cluster.
desired_logging_config google.cloud.container_v1.types.LoggingConfig
The desired logging configuration.
desired_monitoring_config google.cloud.container_v1.types.MonitoringConfig
The desired monitoring configuration.
desired_identity_service_config google.cloud.container_v1.types.IdentityServiceConfig
The desired Identity Service component configuration.
desired_service_external_ips_config google.cloud.container_v1.types.ServiceExternalIPsConfig
ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
desired_enable_private_endpoint bool
Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. This field is a member of oneof_ _desired_enable_private_endpoint.
desired_default_enable_private_nodes bool
Override the default setting of whether future created nodes have private IP addresses only, namely NetworkConfig.default_enable_private_nodes][google.container.v1.NetworkConfig.default_enable_private_nodes] This field is a member of oneof_ _desired_default_enable_private_nodes.
desired_control_plane_endpoints_config google.cloud.container_v1.types.ControlPlaneEndpointsConfig
[Control plane endpoints][google.container.v1.Cluster.control_plane_endpoints_config] configuration.
desired_master_version str
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
desired_gcfs_config google.cloud.container_v1.types.GcfsConfig
The desired GCFS config for the cluster
desired_node_pool_auto_config_network_tags google.cloud.container_v1.types.NetworkTags
The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
desired_gateway_api_config google.cloud.container_v1.types.GatewayAPIConfig
The desired config of Gateway API on this cluster.
etag str
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.
desired_node_pool_logging_config google.cloud.container_v1.types.NodePoolLoggingConfig
The desired node pool logging configuration defaults for the cluster.
desired_fleet google.cloud.container_v1.types.Fleet
The desired fleet configuration for the cluster.
desired_stack_type google.cloud.container_v1.types.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.
additional_pod_ranges_config google.cloud.container_v1.types.AdditionalPodRangesConfig
The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
removed_additional_pod_ranges_config google.cloud.container_v1.types.AdditionalPodRangesConfig
The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.
enable_k8s_beta_apis google.cloud.container_v1.types.K8sBetaAPIConfig
Kubernetes open source beta apis enabled on the cluster. Only beta apis
desired_security_posture_config google.cloud.container_v1.types.SecurityPostureConfig
Enable/Disable Security Posture API features for the cluster.
desired_network_performance_config google.cloud.container_v1.types.NetworkConfig.ClusterNetworkPerformanceConfig
The desired network performance config.
desired_enable_fqdn_network_policy bool
Enable/Disable FQDN Network Policy for the cluster. This field is a member of oneof_ _desired_enable_fqdn_network_policy.
desired_autopilot_workload_policy_config google.cloud.container_v1.types.WorkloadPolicyConfig
The desired workload policy configuration for the autopilot cluster.
desired_k8s_beta_apis google.cloud.container_v1.types.K8sBetaAPIConfig
Desired Beta APIs to be enabled for cluster.
desired_containerd_config google.cloud.container_v1.types.ContainerdConfig
The desired containerd config for the cluster.
desired_enable_multi_networking bool
Enable/Disable Multi-Networking for the cluster This field is a member of oneof_ _desired_enable_multi_networking.
desired_node_pool_auto_config_resource_manager_tags google.cloud.container_v1.types.ResourceManagerTags
The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
desired_in_transit_encryption_config google.cloud.container_v1.types.InTransitEncryptionConfig
Specify the details of in-transit encryption. This field is a member of oneof_ _desired_in_transit_encryption_config.
desired_enable_cilium_clusterwide_network_policy bool
Enable/Disable Cilium Clusterwide Network Policy for the cluster. This field is a member of oneof_ _desired_enable_cilium_clusterwide_network_policy.
desired_secret_manager_config google.cloud.container_v1.types.SecretManagerConfig
Enable/Disable Secret Manager Config. This field is a member of oneof_ _desired_secret_manager_config.
desired_compliance_posture_config google.cloud.container_v1.types.CompliancePostureConfig
Enable/Disable Compliance Posture features for the cluster. This field is a member of oneof_ _desired_compliance_posture_config.
desired_node_kubelet_config google.cloud.container_v1.types.NodeKubeletConfig
The desired node kubelet config for the cluster.
desired_node_pool_auto_config_kubelet_config google.cloud.container_v1.types.NodeKubeletConfig
The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
user_managed_keys_config google.cloud.container_v1.types.UserManagedKeysConfig
The Custom keys configuration for the cluster.
desired_rbac_binding_config google.cloud.container_v1.types.RBACBindingConfig
RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. This field is a member of oneof_ _desired_rbac_binding_config.
desired_enterprise_config google.cloud.container_v1.types.DesiredEnterpriseConfig
The desired enterprise configuration for the cluster.
desired_node_pool_auto_config_linux_node_config google.cloud.container_v1.types.LinuxNodeConfig
The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. Currently only cgroup_mode can be set here.