From 9955926b7c0ca1ebe5ea64aef27e36b0b73029e4 Mon Sep 17 00:00:00 2001 From: "Marcel S. Henselin" Date: Thu, 7 May 2026 09:36:34 +0200 Subject: [PATCH] chore: update docs --- docs/data-sources/sqlserverflexbeta_flavor.md | 54 +++++++++++++++++++ .../resource.tf | 27 ++++++++++ .../resource.tf | 25 +++++++++ generator/cmd/docCmd.go | 4 +- 4 files changed, 108 insertions(+), 2 deletions(-) create mode 100644 docs/data-sources/sqlserverflexbeta_flavor.md diff --git a/docs/data-sources/sqlserverflexbeta_flavor.md b/docs/data-sources/sqlserverflexbeta_flavor.md new file mode 100644 index 00000000..4d2a32f3 --- /dev/null +++ b/docs/data-sources/sqlserverflexbeta_flavor.md @@ -0,0 +1,54 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "stackitprivatepreview_sqlserverflexbeta_flavor Data Source - stackitprivatepreview" +subcategory: "" +description: |- + +--- + +# stackitprivatepreview_sqlserverflexbeta_flavor (Data Source) + + + +## Example Usage + +```terraform +data "stackitprivatepreview_sqlserverflexbeta_flavor" "flavor" { + project_id = var.project_id + region = var.region + cpu = 4 + ram = 16 + node_type = "Single" + storage_class = "premium-perf2-stackit" +} +``` + + +## Schema + +### Required + +- `cpu` (Number) The cpu count of the instance. +- `node_type` (String) defines the nodeType it can be either single or HA +- `project_id` (String) The project ID of the flavor. +- `ram` (Number) The memory of the instance in Gibibyte. +- `region` (String) The region of the flavor. +- `storage_class` (String) The memory of the instance in Gibibyte. + +### Read-Only + +- `description` (String) The flavor description. +- `flavor_id` (String) The id of the instance flavor. +- `id` (String) The id of the instance flavor. +- `max_gb` (Number) maximum storage which can be ordered for the flavor in Gigabyte. +- `min_gb` (Number) minimum storage which is required to order in Gigabyte. +- `storage_classes` (Attributes List) maximum storage which can be ordered for the flavor in Gigabyte. (see [below for nested schema](#nestedatt--storage_classes)) + + +### Nested Schema for `storage_classes` + +Read-Only: + +- `class` (String) +- `max_io_per_sec` (Number) +- `max_through_in_mb` (Number) diff --git a/examples/resources/stackitprivatepreview_postgresflexalpha_instance/resource.tf b/examples/resources/stackitprivatepreview_postgresflexalpha_instance/resource.tf index b503f0ce..7250b66b 100644 --- a/examples/resources/stackitprivatepreview_postgresflexalpha_instance/resource.tf +++ b/examples/resources/stackitprivatepreview_postgresflexalpha_instance/resource.tf @@ -1,3 +1,30 @@ +# NOTE: flavor handling will change in future +# V2 compatible flavor usage (example without encryption) +resource "stackitprivatepreview_postgresflexalpha_instance" "example-instance" { + project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + name = "example-instance" + acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"] + backup_schedule = "0 0 * * *" + retention_days = 30 + flavor = { + cpu = 2 + ram = 4 + } + replicas = 1 + storage = { + performance_class = "premium-perf2-stackit" + size = 10 + } + network = { + acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"] + access_scope = "PUBLIC" + } + version = 17 +} + +# future use of flavor (implemented in V3 API) +# first determine flavor and then use the flavor_id + resource "stackitprivatepreview_postgresflexalpha_instance" "example-instance" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" diff --git a/examples/resources/stackitprivatepreview_sqlserverflexbeta_instance/resource.tf b/examples/resources/stackitprivatepreview_sqlserverflexbeta_instance/resource.tf index 06e88f64..565ae019 100644 --- a/examples/resources/stackitprivatepreview_sqlserverflexbeta_instance/resource.tf +++ b/examples/resources/stackitprivatepreview_sqlserverflexbeta_instance/resource.tf @@ -1,3 +1,28 @@ +# NOTE: flavor handling will change in future +# V2 compatible flavor usage +resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" { + project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + name = "example-instance" + backup_schedule = "0 3 * * *" + retention_days = 31 + flavor = { + cpu = 2 + ram = 4 + } + storage = { + class = "premium-perf2-stackit" + size = 50 + } + version = 2022 + network = { + acl = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"] + access_scope = "SNA" + } +} + +# future use of flavor (implemented in V3 API) +# first determine flavor and then use the flavor_id + # without encryption and SNA resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" diff --git a/generator/cmd/docCmd.go b/generator/cmd/docCmd.go index 77b1dc23..cf36610b 100644 --- a/generator/cmd/docCmd.go +++ b/generator/cmd/docCmd.go @@ -172,12 +172,12 @@ func workDocs() error { case "data-sources": dataSources[matches[0][1]] = append(dataSources[matches[0][1]], ResItem{ ItemName: matches[0][2], - ItemLink: fmt.Sprintf("docs/%s/%s", entry.Name(), matches[0][0]), + ItemLink: fmt.Sprintf("/docs/docs/%s/%s", entry.Name(), matches[0][0]), }) case "resources": resources[matches[0][1]] = append(resources[matches[0][1]], ResItem{ ItemName: matches[0][2], - ItemLink: fmt.Sprintf("docs/%s/%s", entry.Name(), matches[0][0]), + ItemLink: fmt.Sprintf("/docs/docs/%s/%s", entry.Name(), matches[0][0]), }) default: return fmt.Errorf("this should never have happened") -- 2.49.1