Initial commit

docs/data-sources/ske_cluster.md

@@ -0,0 +1,119 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_ske_cluster Data Source - stackit"
+subcategory: ""
+description: |-
+  SKE Cluster data source schema.
+---
+
+# stackit_ske_cluster (Data Source)
+
+SKE Cluster data source schema.
+
+## Example Usage
+
+```terraform
+data "stackit_ske_cluster" "example" {
+  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  name       = "example-name"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## 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](#nestedatt--extensions))
+- `hibernations` (Attributes List) One or more hibernation block as defined below. (see [below for nested schema](#nestedatt--hibernations))
+- `id` (String) Terraform's internal resource ID.
+- `kube_config` (String, Sensitive) Kube config file used for connecting to the cluster
+- `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](#nestedatt--maintenance))
+- `node_pools` (Attributes List) One or more `node_pool` block as defined below. (see [below for nested schema](#nestedatt--node_pools))
+
+<a id="nestedatt--extensions"></a>
+### Nested Schema for `extensions`
+
+Read-Only:
+
+- `acl` (Attributes) Cluster access control configuration (see [below for nested schema](#nestedatt--extensions--acl))
+- `argus` (Attributes) A single argus block as defined below (see [below for nested schema](#nestedatt--extensions--argus))
+
+<a id="nestedatt--extensions--acl"></a>
+### Nested Schema for `extensions.acl`
+
+Read-Only:
+
+- `allowed_cidrs` (List of String) Specify a list of CIDRs to whitelist
+- `enabled` (Boolean) Is ACL enabled?
+
+
+<a id="nestedatt--extensions--argus"></a>
+### Nested Schema for `extensions.argus`
+
+Read-Only:
+
+- `argus_instance_id` (String) Instance ID of argus
+- `enabled` (Boolean) Flag to enable/disable argus extensions.
+
+
+
+<a id="nestedatt--hibernations"></a>
+### 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.
+
+
+<a id="nestedatt--maintenance"></a>
+### 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.
+
+
+<a id="nestedatt--node_pools"></a>
+### 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](#nestedatt--node_pools--taints))
+- `volume_size` (Number) The volume size in GB.
+- `volume_type` (String) Specifies the volume type.
+
+<a id="nestedatt--node_pools--taints"></a>
+### 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.