Add description for the parameters field of DSA instances (#445)

joaopalet · web-flow · commit aec518b8f32f · 2024-07-02T19:02:19.000+01:00
* Add description for the parameters field of DSA instances

* Improve sentence
diff --git a/docs/data-sources/logme_instance.md b/docs/data-sources/logme_instance.md
@@ -20,7 +20,6 @@ data "stackit_logme_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -43,7 +42,6 @@ data "stackit_logme_instance" "example" {
 - `version` (String) The service version.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Read-Only:
diff --git a/docs/data-sources/mariadb_instance.md b/docs/data-sources/mariadb_instance.md
@@ -20,7 +20,6 @@ data "stackit_mariadb_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -43,7 +42,6 @@ data "stackit_mariadb_instance" "example" {
 - `version` (String) The service version.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Read-Only:
diff --git a/docs/data-sources/opensearch_instance.md b/docs/data-sources/opensearch_instance.md
@@ -20,7 +20,6 @@ data "stackit_opensearch_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -43,7 +42,6 @@ data "stackit_opensearch_instance" "example" {
 - `version` (String) The service version.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Read-Only:
diff --git a/docs/data-sources/postgresql_credential.md b/docs/data-sources/postgresql_credential.md
@@ -4,7 +4,7 @@ page_title: "stackit_postgresql_credential Data Source - stackit"
 subcategory: ""
 description: |-
   PostgreSQL credential data source schema. Must have a region specified in the provider configuration.
-  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexuser instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
+  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_user instead. For more details, check
 ---
 
 # stackit_postgresql_credential (Data Source)
diff --git a/docs/data-sources/postgresql_instance.md b/docs/data-sources/postgresql_instance.md
@@ -4,7 +4,7 @@ page_title: "stackit_postgresql_instance Data Source - stackit"
 subcategory: ""
 description: |-
   PostgreSQL instance data source schema. Must have a region specified in the provider configuration.
-  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexinstance instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
+  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_instance instead. For more details, check
 ---
 
 # stackit_postgresql_instance (Data Source)
diff --git a/docs/data-sources/rabbitmq_instance.md b/docs/data-sources/rabbitmq_instance.md
@@ -20,7 +20,6 @@ data "stackit_rabbitmq_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -43,7 +42,6 @@ data "stackit_rabbitmq_instance" "example" {
 - `version` (String) The service version.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Read-Only:
diff --git a/docs/data-sources/redis_instance.md b/docs/data-sources/redis_instance.md
@@ -20,7 +20,6 @@ data "stackit_redis_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -43,7 +42,6 @@ data "stackit_redis_instance" "example" {
 - `version` (String) The service version.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Read-Only:
diff --git a/docs/data-sources/resourcemanager_project.md b/docs/data-sources/resourcemanager_project.md
@@ -3,7 +3,7 @@
 page_title: "stackit_resourcemanager_project Data Source - stackit"
 subcategory: ""
 description: |-
-  Resource Manager project data source schema. To identify the project, you need to provider either projectid or containerid. If you provide both, project_id will be used.
+  Resource Manager project data source schema. To identify the project, you need to provider either project_id or container_id. If you provide both, project_id will be used.
 ---
 
 # stackit_resourcemanager_project (Data Source)
diff --git a/docs/resources/loadbalancer.md b/docs/resources/loadbalancer.md
@@ -8,23 +8,25 @@ description: |-
   To automate the creation of load balancers, OpenStack can be used to setup the supporting infrastructure.
   To set up the OpenStack provider, you can create a token through the STACKIT Portal, in your project's Infrastructure API page.
   There, the OpenStack user domain name, username, and password are generated and can be obtained. The provider can then be configured as follows:
-  ```terraform
+  
   terraform {
-      required_providers {
-          (...)
-          openstack = {
-              source = "terraform-provider-openstack/openstack"
-          }
-      }
+  	required_providers {
+  		(...)
+  		openstack = {
+  			source = "terraform-provider-openstack/openstack"
+  		}
+  	}
   }
+  
   provider "openstack" {
-      userdomainname = "{OpenStack user domain name}"
-      username        = "{OpenStack username}"
-      password         = "{OpenStack password}"
-      region           = "RegionOne"
-      authurl         = "https://keystone.api.iaas.eu01.stackit.cloud/v3"
+  	user_domain_name = "{OpenStack user domain name}"
+  	user_name        = "{OpenStack username}"
+  	password         = "{OpenStack password}"
+  	region           = "RegionOne"
+  	auth_url         = "https://keystone.api.iaas.eu01.stackit.cloud/v3"
   }
-  ```
+  
+  
   Configuring the supporting infrastructure
   The example below uses OpenStack to create the network, router, a public IP address and a compute instance.
 ---
diff --git a/docs/resources/logme_instance.md b/docs/resources/logme_instance.md
@@ -25,7 +25,6 @@ resource "stackit_logme_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -37,7 +36,7 @@ resource "stackit_logme_instance" "example" {
 
 ### Optional
 
-- `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
+- `parameters` (Attributes) Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it. (see [below for nested schema](#nestedatt--parameters))
 
 ### Read-Only
 
@@ -51,7 +50,6 @@ resource "stackit_logme_instance" "example" {
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Optional:
diff --git a/docs/resources/mariadb_instance.md b/docs/resources/mariadb_instance.md
@@ -25,7 +25,6 @@ resource "stackit_mariadb_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -37,7 +36,7 @@ resource "stackit_mariadb_instance" "example" {
 
 ### Optional
 
-- `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
+- `parameters` (Attributes) Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it. (see [below for nested schema](#nestedatt--parameters))
 
 ### Read-Only
 
@@ -51,7 +50,6 @@ resource "stackit_mariadb_instance" "example" {
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Optional:
diff --git a/docs/resources/opensearch_instance.md b/docs/resources/opensearch_instance.md
@@ -25,7 +25,6 @@ resource "stackit_opensearch_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -37,7 +36,7 @@ resource "stackit_opensearch_instance" "example" {
 
 ### Optional
 
-- `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
+- `parameters` (Attributes) Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it. (see [below for nested schema](#nestedatt--parameters))
 
 ### Read-Only
 
@@ -51,7 +50,6 @@ resource "stackit_opensearch_instance" "example" {
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Optional:
diff --git a/docs/resources/postgresql_credential.md b/docs/resources/postgresql_credential.md
@@ -4,7 +4,7 @@ page_title: "stackit_postgresql_credential Resource - stackit"
 subcategory: ""
 description: |-
   PostgreSQL credential resource schema. Must have a region specified in the provider configuration.
-  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexuser instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html
+  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_user instead. For more details, check
 ---
 
 # stackit_postgresql_credential (Resource)
diff --git a/docs/resources/postgresql_instance.md b/docs/resources/postgresql_instance.md
@@ -4,7 +4,7 @@ page_title: "stackit_postgresql_instance Resource - stackit"
 subcategory: ""
 description: |-
   PostgreSQL instance resource schema. Must have a region specified in the provider configuration.
-  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackitpostgresflexinstance instead. Check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html on how to backup and restore an instance from PostgreSQL to PostgreSQL Flex, then import the resource to Terraform using an "import" block (https://developer.hashicorp.com/terraform/language/import)
+  !> The STACKIT PostgreSQL service has reached its end of support on June 30th 2024. Resources of this type have stopped working since then. Use stackit_postgresflex_instance instead. Check  on how to backup and restore an instance from PostgreSQL to PostgreSQL Flex, then import the resource to Terraform using an "import" block ()
 ---
 
 # stackit_postgresql_instance (Resource)
diff --git a/docs/resources/rabbitmq_instance.md b/docs/resources/rabbitmq_instance.md
@@ -28,7 +28,6 @@ resource "stackit_rabbitmq_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -40,7 +39,7 @@ resource "stackit_rabbitmq_instance" "example" {
 
 ### Optional
 
-- `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
+- `parameters` (Attributes) Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it. (see [below for nested schema](#nestedatt--parameters))
 
 ### Read-Only
 
@@ -54,7 +53,6 @@ resource "stackit_rabbitmq_instance" "example" {
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Optional:
diff --git a/docs/resources/redis_instance.md b/docs/resources/redis_instance.md
@@ -28,7 +28,6 @@ resource "stackit_redis_instance" "example" {
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -40,7 +39,7 @@ resource "stackit_redis_instance" "example" {
 
 ### Optional
 
-- `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
+- `parameters` (Attributes) Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it. (see [below for nested schema](#nestedatt--parameters))
 
 ### Read-Only
 
@@ -54,7 +53,6 @@ resource "stackit_redis_instance" "example" {
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>
-
 ### Nested Schema for `parameters`
 
 Optional:
diff --git a/stackit/internal/services/logme/instance/resource.go b/stackit/internal/services/logme/instance/resource.go
@@ -168,6 +168,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 		"version":     "The service version.",
 		"plan_name":   "The selected plan name.",
 		"plan_id":     "The selected plan ID.",
+		"parameters":  "Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it.",
 	}
 
 	parametersDescriptions := map[string]string{
@@ -244,6 +245,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 				Computed:    true,
 			},
 			"parameters": schema.SingleNestedAttribute{
+				Description: descriptions["parameters"],
 				Attributes: map[string]schema.Attribute{
 					"sgw_acl": schema.StringAttribute{
 						Description: parametersDescriptions["sgw_acl"],
diff --git a/stackit/internal/services/mariadb/instance/resource.go b/stackit/internal/services/mariadb/instance/resource.go
@@ -136,6 +136,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 		"version":     "The service version.",
 		"plan_name":   "The selected plan name.",
 		"plan_id":     "The selected plan ID.",
+		"parameters":  "Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it.",
 	}
 
 	parametersDescriptions := map[string]string{
@@ -206,6 +207,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 				Computed:    true,
 			},
 			"parameters": schema.SingleNestedAttribute{
+				Description: descriptions["parameters"],
 				Attributes: map[string]schema.Attribute{
 					"sgw_acl": schema.StringAttribute{
 						Description: parametersDescriptions["sgw_acl"],
diff --git a/stackit/internal/services/opensearch/instance/resource.go b/stackit/internal/services/opensearch/instance/resource.go
@@ -149,6 +149,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 		"version":     "The service version.",
 		"plan_name":   "The selected plan name.",
 		"plan_id":     "The selected plan ID.",
+		"parameters":  "Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it.",
 	}
 
 	parametersDescriptions := map[string]string{
@@ -225,6 +226,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 				Computed:    true,
 			},
 			"parameters": schema.SingleNestedAttribute{
+				Description: descriptions["parameters"],
 				Attributes: map[string]schema.Attribute{
 					"sgw_acl": schema.StringAttribute{
 						Description: parametersDescriptions["sgw_acl"],
diff --git a/stackit/internal/services/rabbitmq/instance/resource.go b/stackit/internal/services/rabbitmq/instance/resource.go
@@ -146,6 +146,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 		"version":     "The service version.",
 		"plan_name":   "The selected plan name.",
 		"plan_id":     "The selected plan ID.",
+		"parameters":  "Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it.",
 	}
 
 	parametersDescriptions := map[string]string{
@@ -221,6 +222,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 				Computed:    true,
 			},
 			"parameters": schema.SingleNestedAttribute{
+				Description: descriptions["parameters"],
 				Attributes: map[string]schema.Attribute{
 					"sgw_acl": schema.StringAttribute{
 						Description: parametersDescriptions["sgw_acl"],
diff --git a/stackit/internal/services/redis/instance/resource.go b/stackit/internal/services/redis/instance/resource.go
@@ -165,6 +165,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 		"version":     "The service version.",
 		"plan_name":   "The selected plan name.",
 		"plan_id":     "The selected plan ID.",
+		"parameters":  "Configuration parameters. Please note that removing a previously configured field from your Terraform configuration won't replace its value in the API. To update a previously configured field, explicitly set a new value for it.",
 	}
 
 	parametersDescriptions := map[string]string{
@@ -249,6 +250,7 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
 				Computed:    true,
 			},
 			"parameters": schema.SingleNestedAttribute{
+				Description: descriptions["parameters"],
 				Attributes: map[string]schema.Attribute{
 					"sgw_acl": schema.StringAttribute{
 						Description: parametersDescriptions["sgw_acl"],
