Merge branch 'main' into feat/STACKITTPR-399_sfs-error-messages

Author: cgoetz-inovex

.github/docs/contribution-guide/resource.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/hashicorp/terraform-plugin-framework-timeouts/resource/timeouts"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -16,6 +17,7 @@ import (
 	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/core"
 	fooUtils "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/foo/utils"
 	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/utils"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/validate"
 
 	"github.com/stackitcloud/stackit-sdk-go/services/foo"      // Import service "foo" from the STACKIT SDK for Go
 	"github.com/stackitcloud/stackit-sdk-go/services/foo/wait" // Import service "foo" waiters from the STACKIT SDK for Go (in case the service API has asynchronous endpoints)
@@ -32,13 +34,14 @@ var (
 
 // Model is the internal model of the terraform resource
 type Model struct {
-	Id              types.String `tfsdk:"id"` // needed by TF
-	ProjectId       types.String `tfsdk:"project_id"`
-	BarId           types.String `tfsdk:"bar_id"`
-	Region          types.String `tfsdk:"region"`
-	MyRequiredField types.String `tfsdk:"my_required_field"`
-	MyOptionalField types.String `tfsdk:"my_optional_field"`
-	MyReadOnlyField types.String `tfsdk:"my_read_only_field"`
+	Id              types.String   `tfsdk:"id"` // needed by TF
+	ProjectId       types.String   `tfsdk:"project_id"`
+	BarId           types.String   `tfsdk:"bar_id"`
+	Region          types.String   `tfsdk:"region"`
+	MyRequiredField types.String   `tfsdk:"my_required_field"`
+	MyOptionalField types.String   `tfsdk:"my_optional_field"`
+	MyReadOnlyField types.String   `tfsdk:"my_read_only_field"`
+	Timeouts        timeouts.Value `tfsdk:"timeouts"`
 }
 
 // NewBarResource is a helper function to simplify the provider implementation.
@@ -104,7 +107,7 @@ func (r *barResource) Configure(ctx context.Context, req resource.ConfigureReque
 }
 
 // Schema defines the schema for the resource.
-func (r *barResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
+func (r *barResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	descriptions := map[string]string{
 		"main":               "Foo bar resource schema.",
 		"id":                 "Terraform's internal resource identifier. It is structured as \"`project_id`,`bar_id`\".",
@@ -173,6 +176,7 @@ func (r *barResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *
 				Description: descriptions["my_read_only_field"],
 				Computed:    true,
 			},
+			"timeouts": timeouts.AttributesAll(ctx),
 		},
 	}
 }
@@ -185,6 +189,15 @@ func (r *barResource) Create(ctx context.Context, req resource.CreateRequest, re
 		return
 	}
 
+	waiterTimeout := wait.CreateBarWaitHandler(ctx, r.client, projectId, region, resp.BarId).GetTimeout()
+	createTimeout, diags := model.Timeouts.Create(ctx, waiterTimeout+core.DefaultTimeoutMargin)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	ctx, cancel := context.WithTimeout(ctx, createTimeout)
+	defer cancel()
+
 	ctx = core.InitProviderContext(ctx)
 
 	projectId := model.ProjectId.ValueString()
@@ -250,6 +263,14 @@ func (r *barResource) Read(ctx context.Context, req resource.ReadRequest, resp *
 		return
 	}
 
+	readTimeout, diags := model.Timeouts.Create(ctx, core.DefaultOperationTimeout)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	ctx, cancel := context.WithTimeout(ctx, readTimeout)
+	defer cancel()
+
 	ctx = core.InitProviderContext(ctx)
 
 	projectId := model.ProjectId.ValueString()
@@ -296,6 +317,15 @@ func (r *barResource) Delete(ctx context.Context, req resource.DeleteRequest, re
 		return
 	}
 
+	waiterTimeout := wait.DeleteBarWaitHandler(ctx, r.client, projectId, region, barId).GetTimeout()
+	deleteTimeout, diags := model.Timeouts.Create(ctx, waiterTimeout+core.DefaultTimeoutMargin)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	ctx, cancel := context.WithTimeout(ctx, deleteTimeout)
+	defer cancel()
+
 	ctx = core.InitProviderContext(ctx)
 
 	projectId := model.ProjectId.ValueString()

.github/workflows/ci.yaml

@@ -8,7 +8,7 @@ on:
       - main
 
 env:
-  GO_VERSION: "1.24"
+  GO_VERSION: "1.26"
   CODE_COVERAGE_FILE_NAME: "coverage.out" # must be the same as in Makefile
   CODE_COVERAGE_ARTIFACT_NAME: "code-coverage"
 

CONTRIBUTION.md

@@ -103,7 +103,7 @@ If you want to onboard resources of a STACKIT service `foo` that was not yet in
 
 ### Local development
 
-To test your changes locally, you have to compile the provider (requires Go 1.24) and configure the Terraform CLI to use the local version.
+To test your changes locally, you have to compile the provider (requires Go 1.26) and configure the Terraform CLI to use the local version.
 
 1. Clone the repository.
 1. Run `$ make build` to build the Terraform provider binary in `<PATH_TO_REPO>/bin/`

README.md

@@ -222,12 +222,12 @@ Terraform acceptance tests are run using the command `make test-acceptance-tf`.
 
 Additionally:
 
-| Env var                                     | Value                                                                                                   | Example value                          | needed for Acc tests of the following services |
-|---------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------|------------------------------------------------|
-| `TF_ACC_ORGANIZATION_ID`                    | ID of the STACKIT test organization                                                                     | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `authorization`, `iaas`                        |
-| `TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL` | Email of the STACKIT service account                                                                    | `abc-serviceaccount@sa.stackit.cloud`  | `authorization`, `resourcemanager`             |              |
-| `TF_ACC_TEST_PROJECT_PARENT_CONTAINER_ID`   | Container ID of the project parent container (folder within an organization or the organization itself) | `organization-d2b7087`                 | `resourcemanager`                              |
-| `TF_ACC_TEST_PROJECT_PARENT_UUID`           | UUID ID of the project parent container (folder within an organization or the organization itself)      | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `resourcemanager`                              |
+| Env var                                     | Value                                                                                                   | Example value                          | needed for Acc tests of the following services               |
+|---------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------|--------------------------------------------------------------|
+| `TF_ACC_ORGANIZATION_ID`                    | ID of the STACKIT test organization                                                                     | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `authorization`, `iaas`                                      |
+| `TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL` | Email of the STACKIT service account                                                                    | `abc-serviceaccount@sa.stackit.cloud`  | `authorization`, `iaas`, `resourcemanager`, `secretsmanager` |
+| `TF_ACC_TEST_PROJECT_PARENT_CONTAINER_ID`   | Container ID of the project parent container (folder within an organization or the organization itself) | `organization-d2b7087`                 | `resourcemanager`                                            |
+| `TF_ACC_TEST_PROJECT_PARENT_UUID`           | UUID ID of the project parent container (folder within an organization or the organization itself)      | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `resourcemanager`                                            |
 
 ### Run Acceptance Tests of a single service
 

docs/data-sources/dns_record_set.md

@@ -29,6 +29,10 @@ data "stackit_dns_record_set" "example" {
 - `record_set_id` (String) The rr set id.
 - `zone_id` (String) The zone ID to which is dns record set is associated.
 
+### Optional
+
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+
 ### Read-Only
 
 - `active` (Boolean) Specifies if the record set is active or not.
@@ -41,3 +45,10 @@ data "stackit_dns_record_set" "example" {
 - `state` (String) Record set state.
 - `ttl` (Number) Time to live. E.g. 3600
 - `type` (String) The record set type. E.g. `A` or `CNAME`
+
+<a id="nestedatt--timeouts"></a>
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

docs/data-sources/dns_zone.md

@@ -29,6 +29,7 @@ data "stackit_dns_zone" "example" {
 ### Optional
 
 - `dns_name` (String) The zone name. E.g. `example.com` (must not end with a trailing dot).
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
 - `zone_id` (String) The zone ID.
 
 ### Read-Only
@@ -52,3 +53,10 @@ data "stackit_dns_zone" "example" {
 - `state` (String) Zone state.
 - `type` (String) Zone type.
 - `visibility` (String) Visibility of the zone.
+
+<a id="nestedatt--timeouts"></a>
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

docs/data-sources/edgecloud_plans.md

@@ -43,4 +43,5 @@ Read-Only:
 - `description` (String) Description of the plan.
 - `id` (String) The ID of the plan.
 - `max_edge_hosts` (Number) Maximum number of Edge Cloud hosts that can be used.
+- `min_edge_hosts` (Number) Minimum number of Edge Cloud hosts charged.
 - `name` (String) The name of the plan.

docs/data-sources/objectstorage_bucket.md

@@ -34,5 +34,6 @@ data "stackit_objectstorage_bucket" "example" {
 ### Read-Only
 
 - `id` (String) Terraform's internal data source identifier. It is structured as "`project_id`,`region`,`name`".
+- `object_lock` (Boolean) Enable Object Lock on this bucket. Can only be set at creation time. Requires an active project-level compliance lock.
 - `url_path_style` (String)
 - `url_virtual_hosted_style` (String)

docs/data-sources/objectstorage_compliance_lock.md

@@ -0,0 +1,35 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_objectstorage_compliance_lock Data Source - stackit"
+subcategory: ""
+description: |-
+  ObjectStorage compliance lock resource schema. Must have a region specified in the provider configuration.
+---
+
+# stackit_objectstorage_compliance_lock (Data Source)
+
+ObjectStorage compliance lock resource schema. Must have a `region` specified in the provider configuration.
+
+## Example Usage
+
+```terraform
+data "stackit_objectstorage_compliance_lock" "example" {
+  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project_id` (String) STACKIT Project ID to which the compliance lock is associated.
+
+### Optional
+
+- `region` (String) The resource region. If not defined, the provider region is used.
+
+### Read-Only
+
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`".
+- `max_retention_days` (Number) Maximum retention period in days.

docs/data-sources/secretsmanager_instance.md

@@ -31,4 +31,15 @@ data "stackit_secretsmanager_instance" "example" {
 
 - `acls` (Set of String) The access control list for this instance. Each entry is an IP or IP range that is permitted to access, in CIDR notation
 - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
+- `kms_key` (Attributes) The STACKIT-KMS key for secret encryption and decryption. (see [below for nested schema](#nestedatt--kms_key))
 - `name` (String) Instance name.
+
+<a id="nestedatt--kms_key"></a>
+### Nested Schema for `kms_key`
+
+Read-Only:
+
+- `key_id` (String) UUID of the key within the STACKIT-KMS to use for the encryption.
+- `key_ring_id` (String) UUID of the keyring where the key is located within the STACKTI-KMS.
+- `key_version` (Number) Version of the key within the STACKIT-KMS to use for the encryption.
+- `service_account_email` (String) Service-Account linked to the Key within the STACKIT-KMS.