import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../../types/output"; /** * Gets the details for a specific cluster. */ export declare function getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise; export interface GetClusterArgs { clusterId: string; location: string; project?: string; projectId: string; zone: string; } export interface GetClusterResult { /** * Configurations for the various addons available to run in the cluster. */ readonly addonsConfig: outputs.container.v1beta1.AddonsConfigResponse; /** * Configuration controlling RBAC group membership information. */ readonly authenticatorGroupsConfig: outputs.container.v1beta1.AuthenticatorGroupsConfigResponse; /** * Autopilot configuration for the cluster. */ readonly autopilot: outputs.container.v1beta1.AutopilotResponse; /** * Cluster-level autoscaling configuration. */ readonly autoscaling: outputs.container.v1beta1.ClusterAutoscalingResponse; /** * Configuration for Binary Authorization. */ readonly binaryAuthorization: outputs.container.v1beta1.BinaryAuthorizationResponse; /** * The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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`. */ readonly clusterIpv4Cidr: string; /** * Telemetry integration for the cluster. */ readonly clusterTelemetry: outputs.container.v1beta1.ClusterTelemetryResponse; /** * Which conditions caused the current cluster state. */ readonly conditions: outputs.container.v1beta1.StatusConditionResponse[]; /** * Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled. */ readonly confidentialNodes: outputs.container.v1beta1.ConfidentialNodesResponse; /** * Configuration for the fine-grained cost management feature. */ readonly costManagementConfig: outputs.container.v1beta1.CostManagementConfigResponse; /** * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ readonly createTime: string; /** * [Output only] The current software version of the master endpoint. */ readonly currentMasterVersion: string; /** * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. * * @deprecated [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ readonly currentNodeCount: number; /** * [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) 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. */ readonly currentNodeVersion: string; /** * Configuration of etcd encryption. */ readonly databaseEncryption: outputs.container.v1beta1.DatabaseEncryptionResponse; /** * 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. */ readonly defaultMaxPodsConstraint: outputs.container.v1beta1.MaxPodsConstraintResponse; /** * An optional description of this cluster. */ readonly description: string; /** * Kubernetes open source beta apis enabled on the cluster. Only beta apis. */ readonly enableK8sBetaApis: outputs.container.v1beta1.K8sBetaAPIConfigResponse; /** * 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. */ readonly enableKubernetesAlpha: boolean; /** * Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. * * @deprecated Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. */ readonly enableTpu: boolean; /** * [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. */ readonly endpoint: string; /** * GKE Enterprise Configuration. */ readonly enterpriseConfig: outputs.container.v1beta1.EnterpriseConfigResponse; /** * 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. */ readonly etag: string; /** * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ readonly expireTime: string; /** * Fleet information for the cluster. */ readonly fleet: outputs.container.v1beta1.FleetResponse; /** * Configuration for Identity Service component. */ readonly identityServiceConfig: outputs.container.v1beta1.IdentityServiceConfigResponse; /** * 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 */ readonly initialClusterVersion: string; /** * The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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. * * @deprecated The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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. */ readonly initialNodeCount: number; /** * Deprecated. Use node_pools.instance_group_urls. * * @deprecated Deprecated. Use node_pools.instance_group_urls. */ readonly instanceGroupUrls: string[]; /** * Configuration for cluster IP allocation. */ readonly ipAllocationPolicy: outputs.container.v1beta1.IPAllocationPolicyResponse; /** * The fingerprint of the set of labels for this cluster. */ readonly labelFingerprint: string; /** * Configuration for the legacy ABAC authorization mode. */ readonly legacyAbac: outputs.container.v1beta1.LegacyAbacResponse; /** * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ readonly location: string; /** * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. */ readonly locations: string[]; /** * Logging configuration for the cluster. */ readonly loggingConfig: outputs.container.v1beta1.LoggingConfigResponse; /** * 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. */ readonly loggingService: string; /** * Configure the maintenance policy for this cluster. */ readonly maintenancePolicy: outputs.container.v1beta1.MaintenancePolicyResponse; /** * Configuration for master components. */ readonly master: outputs.container.v1beta1.MasterResponse; /** * 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. */ readonly masterAuth: outputs.container.v1beta1.MasterAuthResponse; /** * The configuration options for master authorized networks feature. */ readonly masterAuthorizedNetworksConfig: outputs.container.v1beta1.MasterAuthorizedNetworksConfigResponse; /** * 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. * * @deprecated 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. */ readonly masterIpv4CidrBlock: string; /** * Configuration for issuance of mTLS keys and certificates to Kubernetes pods. */ readonly meshCertificates: outputs.container.v1beta1.MeshCertificatesResponse; /** * Monitoring configuration for the cluster. */ readonly monitoringConfig: outputs.container.v1beta1.MonitoringConfigResponse; /** * 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. */ readonly monitoringService: string; /** * 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. */ readonly name: string; /** * The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) 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. */ readonly network: string; /** * Configuration for cluster networking. */ readonly networkConfig: outputs.container.v1beta1.NetworkConfigResponse; /** * Configuration options for the NetworkPolicy feature. */ readonly networkPolicy: outputs.container.v1beta1.NetworkPolicyResponse; /** * 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. * * @deprecated 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. */ readonly nodeConfig: outputs.container.v1beta1.NodeConfigResponse; /** * [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. */ readonly nodeIpv4CidrSize: number; /** * Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. */ readonly nodePoolAutoConfig: outputs.container.v1beta1.NodePoolAutoConfigResponse; /** * Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. */ readonly nodePoolDefaults: outputs.container.v1beta1.NodePoolDefaultsResponse; /** * The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. */ readonly nodePools: outputs.container.v1beta1.NodePoolResponse[]; /** * Notification configuration of the cluster. */ readonly notificationConfig: outputs.container.v1beta1.NotificationConfigResponse; /** * The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster. */ readonly parentProductConfig: outputs.container.v1beta1.ParentProductConfigResponse; /** * Configuration for the PodSecurityPolicy feature. */ readonly podSecurityPolicyConfig: outputs.container.v1beta1.PodSecurityPolicyConfigResponse; /** * 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. * * @deprecated 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. */ readonly privateCluster: boolean; /** * Configuration for private cluster. */ readonly privateClusterConfig: outputs.container.v1beta1.PrivateClusterConfigResponse; /** * Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster. * * @deprecated Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster. */ readonly protectConfig: outputs.container.v1beta1.ProtectConfigResponse; /** * 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. */ readonly releaseChannel: outputs.container.v1beta1.ReleaseChannelResponse; /** * The resource labels for the cluster to use to annotate any related Google Compute Engine resources. */ readonly resourceLabels: { [key: string]: string; }; /** * Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified. */ readonly resourceUsageExportConfig: outputs.container.v1beta1.ResourceUsageExportConfigResponse; /** * Enable/Disable Security Posture API features for the cluster. */ readonly securityPostureConfig: outputs.container.v1beta1.SecurityPostureConfigResponse; /** * [Output only] Server-defined URL for the resource. */ readonly selfLink: string; /** * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ readonly servicesIpv4Cidr: string; /** * Shielded Nodes configuration. */ readonly shieldedNodes: outputs.container.v1beta1.ShieldedNodesResponse; /** * [Output only] The current status of this cluster. */ readonly status: string; /** * [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. * * @deprecated [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. */ readonly statusMessage: string; /** * The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. */ readonly subnetwork: string; /** * Configuration for Cloud TPU support; */ readonly tpuConfig: outputs.container.v1beta1.TpuConfigResponse; /** * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ readonly tpuIpv4CidrBlock: string; /** * Cluster-level Vertical Pod Autoscaling configuration. */ readonly verticalPodAutoscaling: outputs.container.v1beta1.VerticalPodAutoscalingResponse; /** * Configuration for direct-path (via ALTS) with workload identity. */ readonly workloadAltsConfig: outputs.container.v1beta1.WorkloadALTSConfigResponse; /** * Configuration for issuance of mTLS keys and certificates to Kubernetes pods. */ readonly workloadCertificates: outputs.container.v1beta1.WorkloadCertificatesResponse; /** * Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. */ readonly workloadIdentityConfig: outputs.container.v1beta1.WorkloadIdentityConfigResponse; /** * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. * * @deprecated [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ readonly zone: string; } /** * Gets the details for a specific cluster. */ export declare function getClusterOutput(args: GetClusterOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output; export interface GetClusterOutputArgs { clusterId: pulumi.Input; location: pulumi.Input; project?: pulumi.Input; projectId: pulumi.Input; zone: pulumi.Input; }