terraform-provider-stackitp.../docs/data-sources/ske_cluster.md
Vicente Pinto bde1fc55e4
Deprecate kubeconfig field and add stackit_ske_kubeconfig resource (#256)
* Implement kubeconfig resource

* Update acc test, skip get credentials

* Update acc test

* Add warning on Create

* Add option to refresh

* Fix lint

* Add comment, generate docs

* Update stackit/internal/services/ske/cluster/resource.go

Co-authored-by: João Palet <joao.palet@outlook.com>

* Update stackit/internal/services/ske/kubeconfig/resource.go

Co-authored-by: João Palet <joao.palet@outlook.com>

* Changes after review

* Fix schema

* Gen docs

* Rename

* Credentials handling in datasource, update acc test

* Fix datasource

* Update descriptions

---------

Co-authored-by: João Palet <joao.palet@outlook.com>
2024-02-09 10:17:04 +00:00

4.9 KiB

page_title subcategory description
stackit_ske_cluster Data Source - stackit SKE Cluster data source schema. Must have a region specified in the provider configuration.

stackit_ske_cluster (Data Source)

SKE Cluster data source schema. Must have a region specified in the provider configuration.

Example Usage

data "stackit_ske_cluster" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name       = "example-name"
}

Schema

Required

  • name (String) The cluster name.
  • project_id (String) STACKIT project ID to which the cluster is associated.

Read-Only

  • allow_privileged_containers (Boolean, Deprecated) DEPRECATED as of Kubernetes 1.25+ Flag to specify if privileged mode for containers is enabled or not. This should be used with care since it also disables a couple of other features like the use of some volume type (e.g. PVCs).
  • extensions (Attributes) A single extensions block as defined below (see below for nested schema)
  • hibernations (Attributes List) One or more hibernation block as defined below. (see below for nested schema)
  • id (String) Terraform's internal data source. ID. It is structured as "project_id,name".
  • kube_config (String, Sensitive, Deprecated) Kube config file used for connecting to the cluster. This field will be empty for clusters with Kubernetes v1.27+, or if you have obtained the kubeconfig or performed credentials rotation using the new process, either through the Portal or the SKE API. Use the stackit_ske_kubeconfig resource instead. For more information, see How to rotate SKE credentials (https://docs.stackit.cloud/stackit/en/how-to-rotate-ske-credentials-200016334.html).
  • kubernetes_version (String) Kubernetes version.
  • kubernetes_version_used (String) Full Kubernetes version used. For example, if 1.22 was selected, this value may result to 1.22.15
  • maintenance (Attributes) A single maintenance block as defined below (see below for nested schema)
  • node_pools (Attributes List) One or more node_pool block as defined below. (see below for nested schema)

Nested Schema for extensions

Read-Only:

Nested Schema for extensions.acl

Read-Only:

  • allowed_cidrs (List of String) Specify a list of CIDRs to whitelist
  • enabled (Boolean) Is ACL enabled?

Nested Schema for extensions.argus

Read-Only:

  • argus_instance_id (String) Instance ID of argus
  • enabled (Boolean) Flag to enable/disable argus extensions.

Nested Schema for hibernations

Read-Only:

  • end (String) End time of hibernation, in crontab syntax.
  • start (String) Start time of cluster hibernation in crontab syntax.
  • timezone (String) Timezone name corresponding to a file in the IANA Time Zone database.

Nested Schema for maintenance

Read-Only:

  • enable_kubernetes_version_updates (Boolean) Flag to enable/disable auto-updates of the Kubernetes version.
  • enable_machine_image_version_updates (Boolean) Flag to enable/disable auto-updates of the OS image version.
  • end (String) Date time for maintenance window end.
  • start (String) Date time for maintenance window start.

Nested Schema for node_pools

Read-Only:

  • availability_zones (List of String) Specify a list of availability zones.
  • cri (String) Specifies the container runtime.
  • labels (Map of String) Labels to add to each node.
  • machine_type (String) The machine type.
  • max_surge (Number) The maximum number of nodes upgraded simultaneously.
  • max_unavailable (Number) The maximum number of nodes unavailable during upgraded.
  • maximum (Number) Maximum number of nodes in the pool.
  • minimum (Number) Minimum number of nodes in the pool.
  • name (String) Specifies the name of the node pool.
  • os_name (String) The name of the OS image.
  • os_version (String) The OS image version.
  • taints (Attributes List) Specifies a taint list as defined below. (see below for nested schema)
  • volume_size (Number) The volume size in GB.
  • volume_type (String) Specifies the volume type.

Nested Schema for node_pools.taints

Read-Only:

  • effect (String) The taint effect.
  • key (String) Taint key to be applied to a node.
  • value (String) Taint value corresponding to the taint key.