Skip to content

Commit 95ec245

Browse files
authored
fix(docs): wrong description for ske cluster max_unavailable field (#716)
* fix(docs): ske cluster `max_unavailable` description * generate-docs
1 parent 698bbca commit 95ec245

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/resources/ske_cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Optional:
8383
- `cri` (String) Specifies the container runtime. Defaults to `containerd`
8484
- `labels` (Map of String) Labels to add to each node.
8585
- `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.
86-
- `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.
86+
- `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.
8787
- `os_name` (String) The name of the OS image. Defaults to `flatcar`.
8888
- `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.
8989
- `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.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ func (r *clusterResource) Schema(_ context.Context, _ resource.SchemaRequest, re
422422
},
423423
},
424424
"max_unavailable": schema.Int64Attribute{
425-
Description: fmt.Sprintf("%s %s", descriptions["max_surge"], descriptions["nodepool_validators"]),
425+
Description: fmt.Sprintf("%s %s", descriptions["max_unavailable"], descriptions["nodepool_validators"]),
426426
Optional: true,
427427
Computed: true,
428428
PlanModifiers: []planmodifier.Int64{

0 commit comments

Comments
 (0)