stackit-dev-tools/terraform-provider-stackitprivatepreview
2
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Add note regarding update to SKE cluster node pools (#421)

Browse source
This commit is contained in:
João Palet 2024-06-25 14:57:49 +01:00 • committed by GitHub
parent 89b03f1a75
commit 923764172d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/resources/ske_cluster.md
View file

@ -4,12 +4,15 @@ page_title: "stackit_ske_cluster Resource - stackit"
subcategory: ""
description: |-
SKE Cluster Resource schema. Must have a region specified in the provider configuration.
-> When updating node_pools of a stackit_ske_cluster, the Terraform plan might appear incorrect as it matches the node pools by index rather than by name. However, the SKE API correctly identifies node pools by name and applies the intended changes. Please review your changes carefully to ensure the correct configuration will be applied.
---
# stackit_ske_cluster (Resource)
SKE Cluster Resource schema. Must have a `region` specified in the provider configuration.
-> When updating `node_pools` of a `stackit_ske_cluster`, the Terraform plan might appear incorrect as it matches the node pools by index rather than by name. However, the SKE API correctly identifies node pools by name and applies the intended changes. Please review your changes carefully to ensure the correct configuration will be applied.
## Example Usage
```terraform

10
stackit/internal/services/ske/cluster/resource.go
View file

@ -260,8 +260,16 @@ func (r *clusterResource) Configure(ctx context.Context, req resource.ConfigureR
// Schema defines the schema for the resource.
func (r *clusterResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
descriptions := map[string]string{
"main": "SKE Cluster Resource schema. Must have a `region` specified in the provider configuration.",
"node_pools_plan_note": "When updating `node_pools` of a `stackit_ske_cluster`, the Terraform plan might appear incorrect as it matches the node pools by index rather than by name. " +
"However, the SKE API correctly identifies node pools by name and applies the intended changes. Please review your changes carefully to ensure the correct configuration will be applied.",
}
resp.Schema = schema.Schema{
Description: "SKE Cluster Resource schema. Must have a `region` specified in the provider configuration.",
Description: fmt.Sprintf("%s\n%s", descriptions["main"], descriptions["node_pools_plan_note"]),
// Callout block: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
MarkdownDescription: fmt.Sprintf("%s\n\n-> %s", descriptions["main"], descriptions["node_pools_plan_note"]),
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: "Terraform's internal resource ID. It is structured as \"`project_id`,`name`\".",