feat(postgresflex): implement flavors data source

docs/data-sources/postgresflex_flavors.md

@@ -0,0 +1,84 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_postgresflex_flavors Data Source - stackit"
+subcategory: ""
+description: |-
+  Postgres Flex flavors data source schema.
+---
+
+# stackit_postgresflex_flavors (Data Source)
+
+Postgres Flex flavors data source schema.
+
+## Example Usage
+
+```terraform
+data "stackit_postgresflex_flavors" "example" {
+  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  # region is taken from the provider configuration
+}
+
+# Example usage with an instance
+resource "stackit_postgresflex_instance" "example" {
+  project_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  name            = "example"
+  flavor_id       = one([for flavor in data.stackit_postgresflex_flavors.example.flavors : flavor.id if flavor.cpu == 2 && flavor.memory == 4 && flavor.node_type == "Single"])
+  backup_schedule = "0 16 * * *"
+  storage = {
+    class = "premium-perf2-stackit"
+    size  = 5
+  }
+  version = "17"
+  network = {
+    acl = ["192.168.0.0/24"]
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project_id` (String) STACKIT project ID.
+
+### Optional
+
+- `region` (String) Postgres Flex flavors data source region. If undefined, the provider region is used.
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+
+### Read-Only
+
+- `flavors` (Attributes List) List of flavors available for the project. (see [below for nested schema](#nestedatt--flavors))
+- `id` (String) Terraform's internal data source ID, structured as "`project_id`,`region`".
+
+<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).
+
+
+<a id="nestedatt--flavors"></a>
+### Nested Schema for `flavors`
+
+Read-Only:
+
+- `cpu` (Number) CPU count of the instance.
+- `description` (String) Flavor description.
+- `id` (String) Flavor ID.
+- `max_gb` (Number) Maximum storage capacity available for the flavor in GB.
+- `memory` (Number) Memory of the instance in GiB.
+- `min_gb` (Number) Minimum storage capacity available for the flavor in GB.
+- `node_type` (String) Node type of the flavor, either single or replica.
+- `storage_classes` (Attributes List) Storage classes available for the flavor. (see [below for nested schema](#nestedatt--flavors--storage_classes))
+
+<a id="nestedatt--flavors--storage_classes"></a>
+### Nested Schema for `flavors.storage_classes`
+
+Read-Only:
+
+- `class` (String) Storage class.
+- `max_io_per_sec` (Number) Maximum I/O operations per second.
+- `max_through_in_mb` (Number) Maximum throughput in MB per second.

examples/data-sources/stackit_postgresflex_flavors/data-source.tf

@@ -0,0 +1,20 @@
+data "stackit_postgresflex_flavors" "example" {
+  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  # region is taken from the provider configuration
+}
+
+# Example usage with an instance
+resource "stackit_postgresflex_instance" "example" {
+  project_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  name            = "example"
+  flavor_id       = one([for flavor in data.stackit_postgresflex_flavors.example.flavors : flavor.id if flavor.cpu == 2 && flavor.memory == 4 && flavor.node_type == "Single"])
+  backup_schedule = "0 16 * * *"
+  storage = {
+    class = "premium-perf2-stackit"
+    size  = 5
+  }
+  version = "17"
+  network = {
+    acl = ["192.168.0.0/24"]
+  }
+}

stackit/internal/services/postgresflex/flavors/datasource.go

@@ -0,0 +1,264 @@
+package flavors
+
+import (
+	"context"
+	"fmt"
+	"slices"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-framework-timeouts/datasource/timeouts"
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	postgresflex "github.com/stackitcloud/stackit-sdk-go/services/postgresflex/v3api"
+
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/conversion"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/core"
+	postgresflexUtils "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/postgresflex/utils"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/utils"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/validate"
+)
+
+var (
+	_ datasource.DataSource              = new(flavors)
+	_ datasource.DataSourceWithConfigure = new(flavors)
+)
+
+type model struct {
+	ID        types.String   `tfsdk:"id"`
+	ProjectId types.String   `tfsdk:"project_id"`
+	Region    types.String   `tfsdk:"region"`
+	Flavors   []flavor       `tfsdk:"flavors"`
+	Timeouts  timeouts.Value `tfsdk:"timeouts"`
+}
+
+type flavor struct {
+	Id             types.String   `tfsdk:"id"`
+	Description    types.String   `tfsdk:"description"`
+	CPU            types.Int64    `tfsdk:"cpu"`
+	Memory         types.Int64    `tfsdk:"memory"`
+	MinGB          types.Int32    `tfsdk:"min_gb"`
+	MaxGB          types.Int32    `tfsdk:"max_gb"`
+	NodeType       types.String   `tfsdk:"node_type"`
+	StorageClasses []storageClass `tfsdk:"storage_classes"`
+}
+
+type storageClass struct {
+	Class          types.String `tfsdk:"class"`
+	MaxIOPerSec    types.Int32  `tfsdk:"max_io_per_sec"`
+	MaxThroughInMB types.Int32  `tfsdk:"max_through_in_mb"`
+}
+
+type flavors struct {
+	client       *postgresflex.APIClient
+	providerData core.ProviderData
+}
+
+func NewFlavorsDataSource() datasource.DataSource {
+	return new(flavors)
+}
+
+func (f *flavors) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_postgresflex_flavors"
+}
+
+func (f *flavors) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	var ok bool
+	f.providerData, ok = conversion.ParseProviderData(ctx, req.ProviderData, &resp.Diagnostics)
+	if !ok {
+		return
+	}
+
+	apiClient := postgresflexUtils.ConfigureClient(ctx, &f.providerData, &resp.Diagnostics)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	f.client = apiClient
+	tflog.Info(ctx, "Postgres Flex flavors client configured")
+}
+
+func (f *flavors) Schema(ctx context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Description: "Postgres Flex flavors data source schema.",
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: "Terraform's internal data source ID, structured as \"`project_id`,`region`\".",
+				Computed:    true,
+			},
+			"project_id": schema.StringAttribute{
+				Description: "STACKIT project ID.",
+				Required:    true,
+				Validators: []validator.String{
+					validate.UUID(),
+					validate.NoSeparator(),
+				},
+			},
+			"region": schema.StringAttribute{
+				Description: "Postgres Flex flavors data source region. If undefined, the provider region is used.",
+				Optional:    true,
+				Computed:    true,
+			},
+			"timeouts": timeouts.Attributes(ctx),
+			"flavors": schema.ListNestedAttribute{
+				Description: "List of flavors available for the project.",
+				Computed:    true,
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: map[string]schema.Attribute{
+						"id": schema.StringAttribute{
+							Description: "Flavor ID.",
+							Computed:    true,
+						},
+						"description": schema.StringAttribute{
+							Description: "Flavor description.",
+							Computed:    true,
+						},
+						"cpu": schema.Int64Attribute{
+							Description: "CPU count of the instance.",
+							Computed:    true,
+						},
+						"memory": schema.Int64Attribute{
+							Description: "Memory of the instance in GiB.",
+							Computed:    true,
+						},
+						"min_gb": schema.Int32Attribute{
+							Description: "Minimum storage capacity available for the flavor in GB.",
+							Computed:    true,
+						},
+						"max_gb": schema.Int32Attribute{
+							Description: "Maximum storage capacity available for the flavor in GB.",
+							Computed:    true,
+						},
+						"node_type": schema.StringAttribute{
+							Description: "Node type of the flavor, either single or replica.",
+							Computed:    true,
+						},
+						"storage_classes": schema.ListNestedAttribute{
+							Description: "Storage classes available for the flavor.",
+							Computed:    true,
+							NestedObject: schema.NestedAttributeObject{
+								Attributes: map[string]schema.Attribute{
+									"class": schema.StringAttribute{
+										Description: "Storage class.",
+										Computed:    true,
+									},
+									"max_io_per_sec": schema.Int32Attribute{
+										Description: "Maximum I/O operations per second.",
+										Computed:    true,
+									},
+									"max_through_in_mb": schema.Int32Attribute{
+										Description: "Maximum throughput in MB per second.",
+										Computed:    true,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func (f *flavors) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { // nolint:gocritic // function signature required by Terraform
+	var model model
+	resp.Diagnostics.Append(req.Config.Get(ctx, &model)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	readTimeout, diags := model.Timeouts.Read(ctx, core.DefaultOperationTimeout)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	ctx, cancel := context.WithTimeout(ctx, readTimeout)
+	defer cancel()
+
+	projectId := model.ProjectId.ValueString()
+	region := f.providerData.GetRegionWithOverride(model.Region)
+	model.Region = types.StringValue(region)
+	ctx = utils.SetAndLogStateFields(ctx, &resp.Diagnostics, &resp.State, map[string]any{
+		"project_id": projectId,
+		"region":     region,
+	})
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	ctx = core.InitProviderContext(ctx)
+
+	const pageSize int64 = 100
+	flavorsResp, err := f.client.DefaultAPI.ListFlavors(ctx, projectId, region).Size(pageSize).Execute()
+	if err != nil {
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Reading flavors", fmt.Sprintf("Calling ListFlavors: %v", err))
+		return
+	}
+	if flavorsResp == nil {
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Reading flavors", "ListFlavors returned an empty response")
+		return
+	}
+	if flavorsResp.Pagination.TotalRows > pageSize {
+		core.LogAndAddWarning(ctx, &resp.Diagnostics,
+			"Truncated results",
+			fmt.Sprintf("Due to API limitations, only the first %d of %d available flavors are returned.", pageSize, flavorsResp.Pagination.TotalRows),
+		)
+	}
+
+	ctx = core.LogResponse(ctx)
+
+	if err := mapFields(flavorsResp, &model); err != nil {
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Reading flavors", fmt.Sprintf("Processing API payload: %v", err))
+		return
+	}
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, model)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	tflog.Info(ctx, "Postgres Flex flavors read")
+}
+
+func mapFields(resp *postgresflex.ListFlavorsResponse, m *model) error {
+	if resp == nil {
+		return fmt.Errorf("nil response")
+	}
+	if m == nil {
+		return fmt.Errorf("nil model")
+	}
+
+	m.ID = utils.BuildInternalTerraformId(m.ProjectId.ValueString(), m.Region.ValueString())
+	m.Flavors = make([]flavor, 0, len(resp.Flavors))
+
+	slices.SortFunc(resp.Flavors, func(a, b postgresflex.ListFlavors) int {
+		return strings.Compare(a.Id, b.Id)
+	})
+
+	for _, respFlavor := range resp.Flavors {
+		modelFlavor := flavor{
+			Id:          types.StringValue(respFlavor.Id),
+			Description: types.StringValue(respFlavor.Description),
+			CPU:         types.Int64Value(respFlavor.Cpu),
+			Memory:      types.Int64Value(respFlavor.Memory),
+			MinGB:       types.Int32Value(respFlavor.MinGB),
+			MaxGB:       types.Int32Value(respFlavor.MaxGB),
+			NodeType:    types.StringValue(respFlavor.NodeType),
+		}
+
+		slices.SortFunc(respFlavor.StorageClasses, func(a, b postgresflex.FlavorStorageClassesStorageClass) int {
+			return strings.Compare(a.Class, b.Class)
+		})
+
+		modelFlavor.StorageClasses = make([]storageClass, 0, len(respFlavor.StorageClasses))
+		for _, respStorageClass := range respFlavor.StorageClasses {
+			modelFlavor.StorageClasses = append(modelFlavor.StorageClasses, storageClass{
+				Class:          types.StringValue(respStorageClass.Class),
+				MaxIOPerSec:    types.Int32Value(respStorageClass.MaxIoPerSec),
+				MaxThroughInMB: types.Int32Value(respStorageClass.MaxThroughInMb),
+			})
+		}
+		m.Flavors = append(m.Flavors, modelFlavor)
+	}
+	return nil
+}