Class Cluster

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

A Google Kubernetes Engine cluster.

Attributes

Name	Description
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
cluster_ipv4_cidr	`str` The IP address range of the container pods in this cluster, in `CIDR
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
node_pools	`Sequence[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	`Sequence[str]` The list of Google Compute Engine `zones
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	`Sequence[google.cloud.container_v1.types.Cluster.ResourceLabelsEntry]` 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.
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.
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
self_link	`str` [Output only] Server-defined URL for the resource.
zone	`str` [Output only] The name of the Google Compute Engine `zone
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
create_time	`str` [Output only] The time the cluster was created, in `RFC3339
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
instance_group_urls	`Sequence[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
location	`str` [Output only] The name of the Google Compute Engine `zone
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
conditions	`Sequence[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.

Inheritance

builtins.object > proto.message.Message > Cluster

Classes

ResourceLabelsEntry

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

The abstract base class for a message.

Parameters

Name	Description
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.