Class Cluster (2.11.2)

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

A Google Kubernetes Engine cluster.


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
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.
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: - - The Cloud Logging service with a Kubernetes-native resource model - - 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,\ will be used for GKE 1.14+ or for earlier versions.
monitoring_service str
The monitoring service the cluster should use to write metrics. Currently available options: - "" - The Cloud Monitoring service with a Kubernetes-native resource model - - 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,\ will be used for GKE 1.14+ or 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. Leave blank to have one automatically chosen or specify a /14 block in
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 Sequence[]
The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
locations Sequence[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 Mapping[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.
Configuration for the legacy ABAC authorization mode.
Configuration options for the NetworkPolicy feature.
Configuration for cluster IP allocation.
The configuration options for master authorized networks feature.
Configure the maintenance policy for this cluster.
Configuration for Binary Authorization.
Cluster-level autoscaling configuration.
Configuration for cluster networking.
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.
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
Configuration controlling RBAC group membership information.
Configuration for private cluster.
Configuration of etcd encryption.
Cluster-level Vertical Pod Autoscaling configuration.
Shielded Nodes configuration.
Release channel configuration.
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
Notification configuration of the cluster.
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
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.
[Output only] The current status of this cluster.
status_message str
[Output only] Deprecated. Use conditions instead. Additi