From 95ec24556a84abf1931afaefa17682d486af0ace Mon Sep 17 00:00:00 2001 From: Kai Kummerer <70690427+Kumm-Kai@users.noreply.github.com> Date: Fri, 21 Mar 2025 16:13:38 +0100 Subject: [PATCH] fix(docs): wrong description for ske cluster `max_unavailable` field (#716) * fix(docs): ske cluster `max_unavailable` description * generate-docs --- docs/resources/ske_cluster.md | 2 +- stackit/internal/services/ske/cluster/resource.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/resources/ske_cluster.md b/docs/resources/ske_cluster.md index 12991f08..af3c8769 100644 --- a/docs/resources/ske_cluster.md +++ b/docs/resources/ske_cluster.md @@ -83,7 +83,7 @@ Optional: - `cri` (String) Specifies the container runtime. Defaults to `containerd` - `labels` (Map of String) Labels to add to each node. - `max_surge` (Number) Maximum number of additional VMs that are created during an update. If set (larger than 0), then it must be at least the amount of zones configured for the nodepool. The `max_surge` and `max_unavailable` fields cannot both be unset at the same time. -- `max_unavailable` (Number) Maximum number of additional VMs that are created during an update. If set (larger than 0), then it must be at least the amount of zones configured for the nodepool. The `max_surge` and `max_unavailable` fields cannot both be unset at the same time. +- `max_unavailable` (Number) Maximum number of VMs that that can be unavailable during an update. If set (larger than 0), then it must be at least the amount of zones configured for the nodepool. The `max_surge` and `max_unavailable` fields cannot both be unset at the same time. - `os_name` (String) The name of the OS image. Defaults to `flatcar`. - `os_version` (String, Deprecated) This field is deprecated, use `os_version_min` to configure the version and `os_version_used` to get the currently used version instead. - `os_version_min` (String) The minimum OS image version. This field will be used to set the minimum OS image version on creation/update of the cluster. If unset, the latest supported OS image version will be used. SKE automatically updates the cluster Kubernetes version if you have set `maintenance.enable_kubernetes_version_updates` to true or if there is a mandatory update, as described in [Updates for Kubernetes versions and Operating System versions in SKE](https://docs.stackit.cloud/stackit/en/version-updates-in-ske-10125631.html). To get the current OS image version being used for the node pool, use the read-only `os_version_used` field. diff --git a/stackit/internal/services/ske/cluster/resource.go b/stackit/internal/services/ske/cluster/resource.go index 920b85ed..b0ce5bce 100644 --- a/stackit/internal/services/ske/cluster/resource.go +++ b/stackit/internal/services/ske/cluster/resource.go @@ -422,7 +422,7 @@ func (r *clusterResource) Schema(_ context.Context, _ resource.SchemaRequest, re }, }, "max_unavailable": schema.Int64Attribute{ - Description: fmt.Sprintf("%s %s", descriptions["max_surge"], descriptions["nodepool_validators"]), + Description: fmt.Sprintf("%s %s", descriptions["max_unavailable"], descriptions["nodepool_validators"]), Optional: true, Computed: true, PlanModifiers: []planmodifier.Int64{