public sealed class Cluster : IMessage<Cluster>, IEquatable<Cluster>, IDeepCloneable<Cluster>, IBufferMessage, IMessageReference documentation and code samples for the Google Kubernetes Engine v1 API class Cluster.
A Google Kubernetes Engine cluster.
Namespace
Google.Cloud.Container.V1Assembly
Google.Cloud.Container.V1.dll
Constructors
Cluster()
public Cluster()Cluster(Cluster)
public Cluster(Cluster other)| Parameter | |
|---|---|
| Name | Description |
other |
Cluster |
Properties
AddonsConfig
public AddonsConfig AddonsConfig { get; set; }Configurations for the various addons available to run in the cluster.
| Property Value | |
|---|---|
| Type | Description |
AddonsConfig |
|
AuthenticatorGroupsConfig
public AuthenticatorGroupsConfig AuthenticatorGroupsConfig { get; set; }Configuration controlling RBAC group membership information.
| Property Value | |
|---|---|
| Type | Description |
AuthenticatorGroupsConfig |
|
Autopilot
public Autopilot Autopilot { get; set; }Autopilot configuration for the cluster.
| Property Value | |
|---|---|
| Type | Description |
Autopilot |
|
Autoscaling
public ClusterAutoscaling Autoscaling { get; set; }Cluster-level autoscaling configuration.
| Property Value | |
|---|---|
| Type | Description |
ClusterAutoscaling |
|
BinaryAuthorization
public BinaryAuthorization BinaryAuthorization { get; set; }Configuration for Binary Authorization.
| Property Value | |
|---|---|
| Type | Description |
BinaryAuthorization |
|
ClusterIpv4Cidr
public string ClusterIpv4Cidr { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Conditions
public RepeatedField<StatusCondition> Conditions { get; }Which conditions caused the current cluster state.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldStatusCondition |
|
ConfidentialNodes
public ConfidentialNodes ConfidentialNodes { get; set; }Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
| Property Value | |
|---|---|
| Type | Description |
ConfidentialNodes |
|
CostManagementConfig
public CostManagementConfig CostManagementConfig { get; set; }Configuration for the fine-grained cost management feature.
| Property Value | |
|---|---|
| Type | Description |
CostManagementConfig |
|
CreateTime
public string CreateTime { get; set; }[Output only] The time the cluster was created, in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CurrentMasterVersion
public string CurrentMasterVersion { get; set; }[Output only] The current software version of the master endpoint.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CurrentNodeCount
[Obsolete]
public int CurrentNodeCount { get; set; }[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
| Property Value | |
|---|---|
| Type | Description |
int |
|
CurrentNodeVersion
[Obsolete]
public string CurrentNodeVersion { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DatabaseEncryption
public DatabaseEncryption DatabaseEncryption { get; set; }Configuration of etcd encryption.
| Property Value | |
|---|---|
| Type | Description |
DatabaseEncryption |
|
DefaultMaxPodsConstraint
public MaxPodsConstraint DefaultMaxPodsConstraint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
MaxPodsConstraint |
|
Description
public string Description { get; set; }An optional description of this cluster.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnableK8SBetaApis
public K8sBetaAPIConfig EnableK8SBetaApis { get; set; }Beta APIs Config
| Property Value | |
|---|---|
| Type | Description |
K8sBetaAPIConfig |
|
EnableKubernetesAlpha
public bool EnableKubernetesAlpha { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EnableTpu
public bool EnableTpu { get; set; }Enable the ability to use Cloud TPUs in this cluster.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Endpoint
public string Endpoint { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnterpriseConfig
public EnterpriseConfig EnterpriseConfig { get; set; }GKE Enterprise Configuration.
| Property Value | |
|---|---|
| Type | Description |
EnterpriseConfig |
|
Etag
public string Etag { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ExpireTime
public string ExpireTime { get; set; }[Output only] The time the cluster will be automatically deleted in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Fleet
public Fleet Fleet { get; set; }Fleet information for the cluster.
| Property Value | |
|---|---|
| Type | Description |
Fleet |
|
Id
public string Id { get; set; }Output only. Unique id for the cluster.
| Property Value | |
|---|---|
| Type | Description |
string |
|
IdentityServiceConfig
public IdentityServiceConfig IdentityServiceConfig { get; set; }Configuration for Identity Service component.
| Property Value | |
|---|---|
| Type | Description |
IdentityServiceConfig |
|
InitialClusterVersion
public string InitialClusterVersion { get; set; }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
| Property Value | |
|---|---|
| Type | Description |
string |
|
InitialNodeCount
[Obsolete]
public int InitialNodeCount { get; set; }The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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.
This field is deprecated, use node_pool.initial_node_count instead.
| Property Value | |
|---|---|
| Type | Description |
int |
|
InstanceGroupUrls
[Obsolete]
public RepeatedField<string> InstanceGroupUrls { get; }Deprecated. Use node_pools.instance_group_urls.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
IpAllocationPolicy
public IPAllocationPolicy IpAllocationPolicy { get; set; }Configuration for cluster IP allocation.
| Property Value | |
|---|---|
| Type | Description |
IPAllocationPolicy |
|
LabelFingerprint
public string LabelFingerprint { get; set; }The fingerprint of the set of labels for this cluster.
| Property Value | |
|---|---|
| Type | Description |
string |
|
LegacyAbac
public LegacyAbac LegacyAbac { get; set; }Configuration for the legacy ABAC authorization mode.
| Property Value | |
|---|---|
| Type | Description |
LegacyAbac |
|
Location
public string Location { get; set; }| Property Value | |
|---|---|
| Type | Description |
string |
|
Locations
public RepeatedField<string> Locations { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
LoggingConfig
public LoggingConfig LoggingConfig { get; set; }Logging configuration for the cluster.
| Property Value | |
|---|---|
| Type | Description |
LoggingConfig |
|
LoggingService
public string LoggingService { get; set; }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 modellogging.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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
MaintenancePolicy
public MaintenancePolicy MaintenancePolicy { get; set; }Configure the maintenance policy for this cluster.
| Property Value | |
|---|---|
| Type | Description |
MaintenancePolicy |
|
MasterAuth
public MasterAuth MasterAuth { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
MasterAuth |
|
MasterAuthorizedNetworksConfig
public MasterAuthorizedNetworksConfig MasterAuthorizedNetworksConfig { get; set; }The configuration options for master authorized networks feature.
| Property Value | |
|---|---|
| Type | Description |
MasterAuthorizedNetworksConfig |
|
MeshCertificates
public MeshCertificates MeshCertificates { get; set; }Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
| Property Value | |
|---|---|
| Type | Description |
MeshCertificates |
|
MonitoringConfig
public MonitoringConfig MonitoringConfig { get; set; }Monitoring configuration for the cluster.
| Property Value | |
|---|---|
| Type | Description |
MonitoringConfig |
|
MonitoringService
public string MonitoringService { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Network
public string Network { get; set; }The name of the Google Compute Engine
network
to which the cluster is connected. If left unspecified, the default
network will be used.
| Property Value | |
|---|---|
| Type | Description |
string |
|
NetworkConfig
public NetworkConfig NetworkConfig { get; set; }Configuration for cluster networking.
| Property Value | |
|---|---|
| Type | Description |
NetworkConfig |
|
NetworkPolicy
public NetworkPolicy NetworkPolicy { get; set; }Configuration options for the NetworkPolicy feature.
| Property Value | |
|---|---|
| Type | Description |
NetworkPolicy |
|
NodeConfig
[Obsolete]
public NodeConfig NodeConfig { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
NodeConfig |
|
NodeIpv4CidrSize
public int NodeIpv4CidrSize { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
NodePoolAutoConfig
public NodePoolAutoConfig NodePoolAutoConfig { get; set; }Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
| Property Value | |
|---|---|
| Type | Description |
NodePoolAutoConfig |
|
NodePoolDefaults
public NodePoolDefaults NodePoolDefaults { get; set; }Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
| Property Value | |
|---|---|
| Type | Description |
NodePoolDefaults |
|
NodePools
public RepeatedField<NodePool> NodePools { get; }The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldNodePool |
|
NotificationConfig
public NotificationConfig NotificationConfig { get; set; }Notification configuration of the cluster.
| Property Value | |
|---|---|
| Type | Description |
NotificationConfig |
|
PrivateClusterConfig
public PrivateClusterConfig PrivateClusterConfig { get; set; }Configuration for private cluster.
| Property Value | |
|---|---|
| Type | Description |
PrivateClusterConfig |
|
ReleaseChannel
public ReleaseChannel ReleaseChannel { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ReleaseChannel |
|
ResourceLabels
public MapField<string, string> ResourceLabels { get; }The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
ResourceUsageExportConfig
public ResourceUsageExportConfig ResourceUsageExportConfig { get; set; }Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
| Property Value | |
|---|---|
| Type | Description |
ResourceUsageExportConfig |
|
SecurityPostureConfig
public SecurityPostureConfig SecurityPostureConfig { get; set; }Enable/Disable Security Posture API features for the cluster.
| Property Value | |
|---|---|
| Type | Description |
SecurityPostureConfig |
|
SelfLink
public string SelfLink { get; set; }[Output only] Server-defined URL for the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ServicesIpv4Cidr
public string ServicesIpv4Cidr { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ShieldedNodes
public ShieldedNodes ShieldedNodes { get; set; }Shielded Nodes configuration.
| Property Value | |
|---|---|
| Type | Description |
ShieldedNodes |
|
Status
public Cluster.Types.Status Status { get; set; }[Output only] The current status of this cluster.
| Property Value | |
|---|---|
| Type | Description |
ClusterTypesStatus |
|
StatusMessage
[Obsolete]
public string StatusMessage { get; set; }[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Subnetwork
public string Subnetwork { get; set; }The name of the Google Compute Engine subnetwork to which the cluster is connected.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TpuIpv4CidrBlock
public string TpuIpv4CidrBlock { get; set; }[Output only] The IP address range of the Cloud TPUs in this cluster, in
CIDR
notation (e.g. 1.2.3.4/29).
| Property Value | |
|---|---|
| Type | Description |
string |
|
VerticalPodAutoscaling
public VerticalPodAutoscaling VerticalPodAutoscaling { get; set; }Cluster-level Vertical Pod Autoscaling configuration.
| Property Value | |
|---|---|
| Type | Description |
VerticalPodAutoscaling |
|
WorkloadIdentityConfig
public WorkloadIdentityConfig WorkloadIdentityConfig { get; set; }Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
| Property Value | |
|---|---|
| Type | Description |
WorkloadIdentityConfig |
|
Zone
[Obsolete]
public string Zone { get; set; }[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
| Property Value | |
|---|---|
| Type | Description |
string |
|