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_v1beta1.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_v1beta1.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. On output this shows the
network ID instead of the name.
|
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_v1beta1.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. On output this shows the
subnetwork ID instead of the name.
|
node_pools |
Sequence[google.cloud.container_v1beta1.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 __
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. v1beta1) 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. |
legacy_abac |
google.cloud.container_v1beta1.types.LegacyAbac
Configuration for the legacy ABAC authorization mode. |
network_policy |
google.cloud.container_v1beta1.types.NetworkPolicy
Configuration options for the NetworkPolicy feature. |
ip_allocation_policy |
google.cloud.container_v1beta1.types.IPAllocationPolicy
Configuration for cluster IP allocation. |
master_authorized_networks_config |
google.cloud.container_v1beta1.types.MasterAuthorizedNetworksConfig
The configuration options for master authorized networks feature. |
maintenance_policy |
google.cloud.container_v1beta1.types.MaintenancePolicy
Configure the maintenance policy for this cluster. |
binary_authorization |
google.cloud.container_v1beta1.types.BinaryAuthorization
Configuration for Binary Authorization. |
pod_security_policy_config |
google.cloud.container_v1beta1.types.PodSecurityPolicyConfig
Configuration for the PodSecurityPolicy feature. |
autoscaling |
google.cloud.container_v1beta1.types.ClusterAutoscaling
Cluster-level autoscaling configuration. |
network_config |
google.cloud.container_v1beta1.types.NetworkConfig
Configuration for cluster networking. |
private_cluster |
bool
If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead. |
master_ipv4_cidr_block |
str
The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. |
default_max_pods_constraint |
google.cloud.container_v1beta1.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_v1beta1.types.ResourceUsageExportConfig
Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified. |
authenticator_groups_config |
google.cloud.container_v1beta1.types.AuthenticatorGroupsConfig
Configuration controlling RBAC group membership information. |
private_cluster_config |
google.cloud.container_v1beta1.types.PrivateClusterConfig
Configuration for private cluster. |
vertical_pod_autoscaling |
google.cloud.container_v1beta1.types.VerticalPodAutoscaling
Cluster-level Vertical Pod Autoscaling configuration. |
shielded_nodes |
google.cloud.container_v1beta1.types.ShieldedNodes
Shielded Nodes configuration. |
release_channel |
google.cloud.container_v1beta1.types.ReleaseChannel
Release channel configuration. |
workload_identity_config |
google.cloud.container_v1beta1.types.WorkloadIdentityConfig
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. |
workload_certificates |
google.cloud.container_v1beta1.types.WorkloadCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods. |
mesh_certificates |
google.cloud.container_v1beta1.types.MeshCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods. |
workload_alts_config |
google.cloud.container_v1beta1.types.WorkloadALTSConfig
Configuration for direct-path (via ALTS) with workload identity. |
cost_management_config |
google.cloud.container_v1beta1.types.CostManagementConfig
Configuration for the fine-grained cost management feature. |
cluster_telemetry |
google.cloud.container_v1beta1.types.ClusterTelemetry
Telemetry integration for the cluster. |
tpu_config |
google.cloud.container_v1beta1.types.TpuConfig
Configuration for Cloud TPU support; |
notification_config |
google.cloud.container_v1beta1.types.NotificationConfig
Notification configuration of the cluster. |
confidential_nodes |
google.cloud.container_v1beta1.types.ConfidentialNodes
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled. |
identity_service_config |
google.cloud.container_v1beta1.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 NodePool.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_v1beta1.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 |
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 __ 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. This field is deprecated, use tpu_config.enabled instead. |
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).
|
database_encryption |
google.cloud.container_v1beta1.types.DatabaseEncryption
Configuration of etcd encryption. |
conditions |
Sequence[google.cloud.container_v1beta1.types.StatusCondition]
Which conditio |