Add grafana_k6_project_allowed_load_zones resource / data source (#2271)

* k6 allowed load zones schema / notes

* extend k6 project resource/data source with PLZs

* update docs

* linter fixes

* add project_allowed_load_zones resource

* fix formatting

* properly handle allowed_load_zones null value

* return api error content

* project_allowed_load_zones - project_id as int

* update examples and docs

* fix allowed_load_zones example

* update internal/resources/k6/catalog-resource.yaml

* docs update

* add tests

* update provider schema

* setProjectAllowedLoadZones - fetch LZs in single request

* Update internal/resources/k6/resource_project_allowed_load_zones.go

Co-authored-by: Oleksandr Kotov <[email protected]>

* resource_project_allowed_load_zones Read() - rm checking if proj exist

* revert changes made to resource_project

* add k6_project_allowed_load_zones data source

* handle 404 in resource_project_allowed_load_zones Delete()

* setProjectAllowedLoadZones() - skip lz ids match for empty arr

* update docs

* add test for data_source_k6_project_allowed_load_zones

* update docs

* fix formatting

* resource_project_allowed_load_zones - project_id as str

* project_allowed_load_zones resource - project_id as str

* tweak descriptions

---------

Co-authored-by: Oleksandr Kotov <[email protected]>

Author: pmdz

docs/data-sources/k6_project_allowed_load_zones.md

@@ -0,0 +1,35 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "grafana_k6_project_allowed_load_zones Data Source - terraform-provider-grafana"
+subcategory: "k6"
+description: |-
+  Retrieves allowed private load zones for a k6 project.
+---
+
+# grafana_k6_project_allowed_load_zones (Data Source)
+
+Retrieves allowed private load zones for a k6 project.
+
+## Example Usage
+
+```terraform
+resource "grafana_k6_project" "test_project_allowed_load_zones" {
+  name = "Terraform Project Test Allowed Load Zones"
+}
+
+data "grafana_k6_project_allowed_load_zones" "from_project_id" {
+  project_id = grafana_k6_project.test_project_allowed_load_zones.id
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project_id` (String) The identifier of the project to retrieve private allowed load zones for.
+
+### Read-Only
+
+- `allowed_load_zones` (List of String) List of allowed private k6 load zone IDs for this project.
+- `id` (String) The identifier of the project. This is set to the same as the project_id.

docs/resources/k6_project_allowed_load_zones.md

@@ -0,0 +1,44 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "grafana_k6_project_allowed_load_zones Resource - terraform-provider-grafana"
+subcategory: "k6"
+description: |-
+  Manages allowed private load zones for a k6 project.
+---
+
+# grafana_k6_project_allowed_load_zones (Resource)
+
+Manages allowed private load zones for a k6 project.
+
+## Example Usage
+
+```terraform
+resource "grafana_k6_project" "test_project_allowed_load_zones" {
+  name = "Terraform Project Test Allowed Load Zones"
+}
+
+resource "grafana_k6_project_allowed_load_zones" "test_allowed_zones" {
+  project_id         = grafana_k6_project.test_project_allowed_load_zones.id
+  allowed_load_zones = ["my-load-zone-1", "other-load-zone"]
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `allowed_load_zones` (List of String) List of allowed private k6 load zone IDs for this project.
+- `project_id` (String) The identifier of the project to manage private allowed load zones for.
+
+### Read-Only
+
+- `id` (String) The identifier of the project. This is set to the same as the project_id.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import grafana_k6_project_allowed_load_zones.name "{{ project_id }}"
+```

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

@@ -0,0 +1,7 @@
+resource "grafana_k6_project" "test_project_allowed_load_zones" {
+  name = "Terraform Project Test Allowed Load Zones"
+}
+
+data "grafana_k6_project_allowed_load_zones" "from_project_id" {
+  project_id = grafana_k6_project.test_project_allowed_load_zones.id
+}

examples/resources/grafana_k6_project_allowed_load_zones/import.sh

@@ -0,0 +1 @@
+terraform import grafana_k6_project_allowed_load_zones.name "{{ project_id }}"

examples/resources/grafana_k6_project_allowed_load_zones/resource.tf

@@ -0,0 +1,8 @@
+resource "grafana_k6_project" "test_project_allowed_load_zones" {
+  name = "Terraform Project Test Allowed Load Zones"
+}
+
+resource "grafana_k6_project_allowed_load_zones" "test_allowed_zones" {
+  project_id         = grafana_k6_project.test_project_allowed_load_zones.id
+  allowed_load_zones = ["my-load-zone-1", "other-load-zone"]
+}

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/grafana/grafana/apps/dashboard v0.0.0-20250424064802-2fbb2d6f5d27
 	github.com/grafana/grafana/apps/playlist v0.0.0-20250424064802-2fbb2d6f5d27
 	github.com/grafana/grafana/pkg/apimachinery v0.0.0-20250424064802-2fbb2d6f5d27
-	github.com/grafana/k6-cloud-openapi-client-go v0.0.0-20250416134020-d958828152cd
+	github.com/grafana/k6-cloud-openapi-client-go v0.0.0-20250715154343-32edc34ec1db
 	github.com/grafana/machine-learning-go-client v0.8.2
 	github.com/grafana/river v0.3.0
 	github.com/grafana/slo-openapi-client/go/slo v0.0.0-20250218172929-ab9cae090da6

go.sum

@@ -194,8 +194,8 @@ github.com/grafana/grafana/apps/playlist v0.0.0-20250424064802-2fbb2d6f5d27 h1:a
 github.com/grafana/grafana/apps/playlist v0.0.0-20250424064802-2fbb2d6f5d27/go.mod h1:9U44mptAJW8bkvgPgCxsnki58/nz3wKPgDayeyeFWJs=
 github.com/grafana/grafana/pkg/apimachinery v0.0.0-20250424064802-2fbb2d6f5d27 h1:2Q158xAoyGgPVw7BIWF5cPYTkjjdsn9c8TpNA38gKzM=
 github.com/grafana/grafana/pkg/apimachinery v0.0.0-20250424064802-2fbb2d6f5d27/go.mod h1:kzjpaBODMbCSS2kvAnV43Pwxoq4lOxrgw/TGKqq8oTA=
-github.com/grafana/k6-cloud-openapi-client-go v0.0.0-20250416134020-d958828152cd h1:UOHbve+keUInhIBSqA4m7GtF2wEiKyW8f/kUt9S0+zM=
-github.com/grafana/k6-cloud-openapi-client-go v0.0.0-20250416134020-d958828152cd/go.mod h1:nBtSyJ0NTfJvEPSrRSKc1u7Vn0mB/kttEZdClHwTqi0=
+github.com/grafana/k6-cloud-openapi-client-go v0.0.0-20250715154343-32edc34ec1db h1:GZGkcFrQF09j8rZfxcIRql7liBf1U7pdmqSAseGintg=
+github.com/grafana/k6-cloud-openapi-client-go v0.0.0-20250715154343-32edc34ec1db/go.mod h1:RBPBP7qIR/K6qzQEQYESVhp/XJspiBTOyBEBCbPXrvI=
 github.com/grafana/machine-learning-go-client v0.8.2 h1:TvU4e+Kgg4GhwBNYTMjBUNq4tbhcxe0L8w1eo/UfV2M=
 github.com/grafana/machine-learning-go-client v0.8.2/go.mod h1:GQKDn10CZqG11l1Qtc6BZ5V6e54fSv5Vi8wskWn3BWs=
 github.com/grafana/otel-profiling-go v0.5.1 h1:stVPKAFZSa7eGiqbYuG25VcqYksR6iWvF3YH66t4qL8=

internal/resources/k6/catalog-resource.yaml

@@ -37,3 +37,16 @@ spec:
   type: terraform-resource
   owner: group:default/k6-cloud-provisioning
   lifecycle: production
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: resource-grafana_k6_project_allowed_load_zones
+  title: grafana_k6_project_allowed_load_zones (resource)
+  description: |
+    resource `grafana_k6_project_allowed_load_zones` in Grafana Labs' Terraform Provider
+spec:
+  subcomponentOf: component:default/terraform-provider-grafana
+  type: terraform-resource
+  owner: group:default/k6-cloud-provisioning
+  lifecycle: production

internal/resources/k6/common.go

@@ -3,6 +3,8 @@ package k6
 import (
 	"context"
 	"fmt"
+	"io"
+	"net/http"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
@@ -80,3 +82,88 @@ func (d *basePluginFrameworkDataSource) Configure(_ context.Context, req datasou
 	d.client = client.K6APIClient
 	d.config = client.K6APIConfig
 }
+
+// getProjectAllowedLoadZones retrieves the allowed load zones for a project
+// Returns k6_load_zone_ids directly from the API response
+func getProjectAllowedLoadZones(ctx context.Context, client *k6.APIClient, config *k6providerapi.K6APIConfig, projectID int32) ([]string, error) {
+	ctx = context.WithValue(ctx, k6.ContextAccessToken, config.Token)
+
+	resp, _, err := client.LoadZonesAPI.ProjectsAllowedLoadZonesRetrieve(ctx, projectID).
+		XStackId(config.StackID).
+		Execute()
+	if err != nil {
+		return nil, err
+	}
+
+	var k6LoadZoneIds []string
+	for _, zone := range resp.GetValue() {
+		k6LoadZoneIds = append(k6LoadZoneIds, zone.GetK6LoadZoneId())
+	}
+
+	return k6LoadZoneIds, nil
+}
+
+// setProjectAllowedLoadZones updates the allowed load zones for a project
+// loadZones parameter contains k6_load_zone_ids, which need to be resolved to actual load zone IDs
+func setProjectAllowedLoadZones(ctx context.Context, client *k6.APIClient, config *k6providerapi.K6APIConfig, projectID int32, k6LoadZoneIds []string) error {
+	ctx = context.WithValue(ctx, k6.ContextAccessToken, config.Token)
+
+	// Initialize allowedZones as an empty slice to ensure it's serialized as [] instead of null
+	allowedZones := make([]k6.AllowedLoadZoneToUpdateApiModel, 0)
+
+	// Skip fetching load zones if k6LoadZoneIds is empty
+	if len(k6LoadZoneIds) > 0 {
+		// Fetch all load zones
+		allZonesResp, _, err := client.LoadZonesAPI.LoadZonesList(ctx).
+			XStackId(config.StackID).
+			Execute()
+		if err != nil {
+			return fmt.Errorf("failed to fetch load zones: %w", err)
+		}
+
+		// Track invalid k6_load_zone_ids
+		var invalidZoneIds []string
+
+		// Resolve each k6_load_zone_id to actual load zone ID using in-memory matching
+		for _, k6LoadZoneID := range k6LoadZoneIds {
+			found := false
+			for _, zone := range allZonesResp.GetValue() {
+				if zone.GetK6LoadZoneId() == k6LoadZoneID {
+					// Create an AllowedLoadZoneToUpdateApiModel with the load zone ID
+					zoneToUpdate := k6.NewAllowedLoadZoneToUpdateApiModel(zone.GetId())
+					allowedZones = append(allowedZones, *zoneToUpdate)
+					found = true
+					break
+				}
+			}
+			if !found {
+				invalidZoneIds = append(invalidZoneIds, k6LoadZoneID)
+			}
+		}
+
+		// Return error if any invalid zone IDs were found
+		if len(invalidZoneIds) > 0 {
+			return fmt.Errorf("invalid k6_load_zone_ids: %v", invalidZoneIds)
+		}
+	}
+
+	updateData := k6.NewUpdateAllowedLoadZonesListApiModel(allowedZones)
+
+	_, httpResp, err := client.LoadZonesAPI.ProjectsAllowedLoadZonesUpdate(ctx, projectID).
+		UpdateAllowedLoadZonesListApiModel(updateData).
+		XStackId(config.StackID).
+		Execute()
+
+	if err != nil && httpResp != nil && httpResp.StatusCode == http.StatusBadRequest {
+		// Read the response body to include it in the error message
+		if httpResp.Body != nil {
+			bodyBytes, readErr := io.ReadAll(httpResp.Body)
+			if readErr == nil {
+				return fmt.Errorf("API returned 400 Bad Request: %s. Original error: %v", string(bodyBytes), err)
+			}
+		}
+		return fmt.Errorf("API returned 400 Bad Request. Original error: %v", err)
+	}
+
+	return err
+}

internal/resources/k6/data_source_k6_project_allowed_load_zones.go

@@ -0,0 +1,116 @@
+package k6
+
+import (
+	"context"
+	"strconv"
+
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+
+	"github.com/grafana/terraform-provider-grafana/v4/internal/common"
+)
+
+// Ensure the implementation satisfies the expected interfaces.
+var (
+	_ datasource.DataSourceWithConfigure = (*projectAllowedLoadZonesDataSource)(nil)
+)
+
+var (
+	dataSourceProjectAllowedLoadZonesName = "grafana_k6_project_allowed_load_zones"
+)
+
+func dataSourceProjectAllowedLoadZones() *common.DataSource {
+	return common.NewDataSource(
+		common.CategoryK6,
+		dataSourceProjectAllowedLoadZonesName,
+		&projectAllowedLoadZonesDataSource{},
+	)
+}
+
+// projectAllowedLoadZonesDataSourceModel maps the data source schema data.
+type projectAllowedLoadZonesDataSourceModel struct {
+	ID               types.String `tfsdk:"id"`
+	ProjectID        types.String `tfsdk:"project_id"`
+	AllowedLoadZones types.List   `tfsdk:"allowed_load_zones"`
+}
+
+// projectAllowedLoadZonesDataSource is the data source implementation.
+type projectAllowedLoadZonesDataSource struct {
+	basePluginFrameworkDataSource
+}
+
+// Metadata returns the data source type name.
+func (d *projectAllowedLoadZonesDataSource) Metadata(_ context.Context, _ datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = dataSourceProjectAllowedLoadZonesName
+}
+
+// Schema defines the schema for the data source.
+func (d *projectAllowedLoadZonesDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Description: "Retrieves allowed private load zones for a k6 project.",
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: "The identifier of the project. This is set to the same as the project_id.",
+				Computed:    true,
+			},
+			"project_id": schema.StringAttribute{
+				Description: "The identifier of the project to retrieve private allowed load zones for.",
+				Required:    true,
+			},
+			"allowed_load_zones": schema.ListAttribute{
+				Description: "List of allowed private k6 load zone IDs for this project.",
+				Computed:    true,
+				ElementType: types.StringType,
+			},
+		},
+	}
+}
+
+// Read refreshes the Terraform state with the latest data.
+func (d *projectAllowedLoadZonesDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var state projectAllowedLoadZonesDataSourceModel
+	diags := req.Config.Get(ctx, &state)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	intID, err := strconv.ParseInt(state.ProjectID.ValueString(), 10, 32)
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error parsing project ID",
+			"Could not parse project ID '"+state.ProjectID.ValueString()+"': "+err.Error(),
+		)
+		return
+	}
+	projectID := int32(intID)
+
+	// Get allowed load zones
+	allowedZones, err := getProjectAllowedLoadZones(ctx, d.client, d.config, projectID)
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error reading allowed load zones",
+			"Could not read allowed load zones for k6 project: "+err.Error(),
+		)
+		return
+	}
+
+	// Set ID to match project_id
+	state.ID = state.ProjectID
+
+	// Convert to types.List
+	var zoneValues []attr.Value
+	for _, zone := range allowedZones {
+		zoneValues = append(zoneValues, types.StringValue(zone))
+	}
+	state.AllowedLoadZones, diags = types.ListValue(types.StringType, zoneValues)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	diags = resp.State.Set(ctx, &state)
+	resp.Diagnostics.Append(diags...)
+}