Class Cluster (2.34.0) 

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

A Google Kubernetes Engine cluster.

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

Attributes

NameDescription
name str
The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: - Lowercase letters, numbers, and hyphens only. - Must start with a letter. - Must end with a number or a letter.
description str
An optional description of this cluster.
initial_node_count int
The number of nodes to create in this cluster. You must ensure that your Compute Engine `resource quota
node_config google.cloud.container_v1.types.NodeConfig
Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
master_auth google.cloud.container_v1.types.MasterAuth
The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.
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.
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.
network str
The name of the Google Compute Engine network __ to which the cluster is connected. If left unspecified, the default network will be used.
cluster_ipv4_cidr str
The IP address range of the container pods in this cluster, in CIDR __ notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.
addons_config google.cloud.container_v1.types.AddonsConfig
Configurations for the various addons available to run in the cluster.
subnetwork str
The name of the Google Compute Engine subnetwork __ to which the cluster is connected.
node_pools MutableSequence[google.cloud.container_v1.types.NodePool]
The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
locations MutableSequence[str]
The list of Google Compute Engine zones __ in which the cluster's nodes should be located. This field provides a default value if NodePool.Locations __ are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations __ of all node pools and will result in nodes being added and/or removed.
enable_kubernetes_alpha bool
Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
resource_labels MutableMapping[str, str]
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
label_fingerprint str
The fingerprint of the set of labels for this cluster.
legacy_abac google.cloud.container_v1.types.LegacyAbac
Configuration for the legacy ABAC authorization mode.
network_policy google.cloud.container_v1.types.NetworkPolicy
Configuration options for the NetworkPolicy feature.
ip_allocation_policy google.cloud.container_v1.types.IPAllocationPolicy
Configuration for cluster IP allocation.
master_authorized_networks_config google.cloud.container_v1.types.MasterAuthorizedNetworksConfig
The configuration options for master authorized networks feature.
maintenance_policy google.cloud.container_v1.types.MaintenancePolicy
Configure the maintenance policy for this cluster.
binary_authorization google.cloud.container_v1.types.BinaryAuthorization
Configuration for Binary Authorization.
autoscaling google.cloud.container_v1.types.ClusterAutoscaling
Cluster-level autoscaling configuration.
network_config google.cloud.container_v1.types.NetworkConfig
Configuration for cluster networking.
default_max_pods_constraint google.cloud.container_v1.types.MaxPodsConstraint
The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
resource_usage_export_config google.cloud.container_v1.types.ResourceUsageExportConfig
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
authenticator_groups_config google.cloud.container_v1.types.AuthenticatorGroupsConfig
Configuration controlling RBAC group membership information.
private_cluster_config google.cloud.container_v1.types.PrivateClusterConfig
Configuration for private cluster.
database_encryption google.cloud.container_v1.types.DatabaseEncryption
Configuration of etcd encryption.
vertical_pod_autoscaling google.cloud.container_v1.types.VerticalPodAutoscaling
Cluster-level Vertical Pod Autoscaling configuration.
shielded_nodes google.cloud.container_v1.types.ShieldedNodes
Shielded Nodes configuration.
release_channel google.cloud.container_v1.types.ReleaseChannel
Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.
workload_identity_config google.cloud.container_v1.types.WorkloadIdentityConfig
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
mesh_certificates google.cloud.container_v1.types.MeshCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
cost_management_config google.cloud.container_v1.types.CostManagementConfig
Configuration for the fine-grained cost management feature.
notification_config google.cloud.container_v1.types.NotificationConfig
Notification configuration of the cluster.
confidential_nodes google.cloud.container_v1.types.ConfidentialNodes
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
identity_service_config google.cloud.container_v1.types.IdentityServiceConfig
Configuration for Identity Service component.
self_link str
[Output only] Server-defined URL for the resource.
zone str
[Output only] The name of the Google Compute Engine zone __ in which the cluster resides. This field is deprecated, use location instead.
endpoint str
[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.
initial_cluster_version str
The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. 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
current_master_version str
[Output only] The current software version of the master endpoint.
current_node_version str
[Output only] Deprecated, use NodePools.version __ instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
create_time str
[Output only] The time the cluster was created, in RFC3339 __ text format.
status google.cloud.container_v1.types.Cluster.Status
[Output only] The current status of this cluster.
status_message str
[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
node_ipv4_cidr_size int
[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.
services_ipv4_cidr str
[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR __ notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
instance_group_urls MutableSequence[str]
Deprecated. Use node_pools.instance_group_urls.
current_node_count int
[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
expire_time str
[Output only] The time the cluster will be automatically deleted in RFC3339 __ text format.
location str
[Output only] The name of the Google Compute Engine zone __ or region __ in which the cluster resides.
enable_tpu bool
Enable the ability to use Cloud TPUs in this cluster.
tpu_ipv4_cidr_block str
[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR __ notation (e.g. 1.2.3.4/29).
conditions MutableSequence[google.cloud.container_v1.types.StatusCondition]
Which conditions caused the current cluster state.
autopilot google.cloud.container_v1.types.Autopilot
Autopilot configuration for the cluster.
id str
Output only. Unique id for the cluster.
node_pool_defaults google.cloud.container_v1.types.NodePoolDefaults
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. This field is a member of oneof_ _node_pool_defaults.
logging_config google.cloud.container_v1.types.LoggingConfig
Logging configuration for the cluster.
monitoring_config google.cloud.container_v1.types.MonitoringConfig
Monitoring configuration for the cluster.
node_pool_auto_config google.cloud.container_v1.types.NodePoolAutoConfig
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
etag str
This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
fleet google.cloud.container_v1.types.Fleet
Fleet information for the cluster.
security_posture_config google.cloud.container_v1.types.SecurityPostureConfig
Enable/Disable Security Posture API features for the cluster.
enable_k8s_beta_apis google.cloud.container_v1.types.K8sBetaAPIConfig
Beta APIs Config
enterprise_config google.cloud.container_v1.types.EnterpriseConfig
GKE Enterprise Configuration.

Classes

ResourceLabelsEntry

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

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Status

Status(value)

The current status of the cluster.

Values: STATUS_UNSPECIFIED (0): Not set. PROVISIONING (1): The PROVISIONING state indicates the cluster is being created. RUNNING (2): The RUNNING state indicates the cluster has been created and is fully usable. RECONCILING (3): The RECONCILING state indicates that some work is actively being done on the cluster, such as upgrading the master or node software. Details can be found in the statusMessage field. STOPPING (4): The STOPPING state indicates the cluster is being deleted. ERROR (5): The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the statusMessage field. DEGRADED (6): The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the statusMessage field.