Make default data view API space aware

Author: tobio

docs/resources/kibana_default_data_view.md

@@ -45,6 +45,7 @@ resource "elasticstack_kibana_default_data_view" "default" {
 
 - `force` (Boolean) Update an existing default data view identifier. If set to false and a default data view already exists, the operation will fail.
 - `skip_delete` (Boolean) If set to true, the default data view will not be unset when the resource is destroyed. The existing default data view will remain unchanged.
+- `space_id` (String) The Kibana space ID to set the default data view in. Defaults to `default`.
 
 ### Read-Only
 

generated/kbapi/kibana.gen.go

@@ -690,6 +690,7 @@ func transformKibanaPaths(schema *Schema) {
 		"/api/maintenance_window/{id}",
 		"/api/actions/connector/{id}",
 		"/api/actions/connectors",
+		"/api/data_views/default",
 	}
 
 	// Add a spaceId parameter if not already present

generated/kbapi/transform_schema.go

@@ -89,8 +89,8 @@ func DeleteDataView(ctx context.Context, client *Client, spaceID string, viewID
 }
 
 // GetDefaultDataView reads the default data view from the API.
-func GetDefaultDataView(ctx context.Context, client *Client) (*string, diag.Diagnostics) {
-	resp, err := client.API.GetDefaultDataViewDefaultWithResponse(ctx)
+func GetDefaultDataView(ctx context.Context, client *Client, spaceID string) (*string, diag.Diagnostics) {
+	resp, err := client.API.GetDefaultDataViewDefaultWithResponse(ctx, spaceID)
 	if err != nil {
 		return nil, diagutil.FrameworkDiagFromError(err)
 	}
@@ -107,8 +107,8 @@ func GetDefaultDataView(ctx context.Context, client *Client) (*string, diag.Diag
 }
 
 // SetDefaultDataView sets the default data view.
-func SetDefaultDataView(ctx context.Context, client *Client, req kbapi.SetDefaultDatailViewDefaultJSONRequestBody) diag.Diagnostics {
-	resp, err := client.API.SetDefaultDatailViewDefaultWithResponse(ctx, req)
+func SetDefaultDataView(ctx context.Context, client *Client, spaceID string, req kbapi.SetDefaultDatailViewDefaultJSONRequestBody) diag.Diagnostics {
+	resp, err := client.API.SetDefaultDatailViewDefaultWithResponse(ctx, spaceID, req)
 	if err != nil {
 		return diagutil.FrameworkDiagFromError(err)
 	}

internal/clients/kibana_oapi/data_views.go

@@ -25,18 +25,20 @@ func TestAccResourceDefaultDataView(t *testing.T) {
 				SkipFunc: versionutils.CheckIfVersionIsUnsupported(minDataViewAPISupport),
 				Config:   testAccResourceDefaultDataViewBasic(indexName1),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttrSet("elasticstack_kibana_default_data_view.test", "id"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "id", "default"),
 					resource.TestCheckResourceAttrSet("elasticstack_kibana_default_data_view.test", "data_view_id"),
 					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "force", "true"),
 					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "skip_delete", "false"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "space_id", "default"),
 				),
 			},
 			{
 				SkipFunc: versionutils.CheckIfVersionIsUnsupported(minDataViewAPISupport),
 				Config:   testAccResourceDefaultDataViewUpdate(indexName1, indexName2),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttrSet("elasticstack_kibana_default_data_view.test", "id"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "id", "default"),
 					resource.TestCheckResourceAttrSet("elasticstack_kibana_default_data_view.test", "data_view_id"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "space_id", "default"),
 				),
 			},
 		},
@@ -54,8 +56,32 @@ func TestAccResourceDefaultDataViewWithSkipDelete(t *testing.T) {
 				SkipFunc: versionutils.CheckIfVersionIsUnsupported(minDataViewAPISupport),
 				Config:   testAccResourceDefaultDataViewWithSkipDelete(indexName),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttrSet("elasticstack_kibana_default_data_view.test", "id"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "id", "default"),
 					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "skip_delete", "true"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "space_id", "default"),
+				),
+			},
+		},
+	})
+}
+
+func TestAccResourceDefaultDataViewWithCustomSpace(t *testing.T) {
+	indexName := "my-index-" + sdkacctest.RandStringFromCharSet(4, sdkacctest.CharSetAlphaNum)
+	spaceID := "test-space-" + sdkacctest.RandStringFromCharSet(6, sdkacctest.CharSetAlphaNum)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { acctest.PreCheck(t) },
+		ProtoV6ProviderFactories: acctest.Providers,
+		Steps: []resource.TestStep{
+			{
+				SkipFunc: versionutils.CheckIfVersionIsUnsupported(minDataViewAPISupport),
+				Config:   testAccResourceDefaultDataViewWithCustomSpace(indexName, spaceID),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "id", spaceID),
+					resource.TestCheckResourceAttrSet("elasticstack_kibana_default_data_view.test", "data_view_id"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "force", "true"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "skip_delete", "false"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_default_data_view.test", "space_id", spaceID),
 				),
 			},
 		},
@@ -152,3 +178,37 @@ resource "elasticstack_kibana_default_data_view" "test" {
 }
 `, indexName, indexName)
 }
+
+func testAccResourceDefaultDataViewWithCustomSpace(indexName, spaceID string) string {
+	return fmt.Sprintf(`
+provider "elasticstack" {
+	elasticsearch {}
+	kibana {}
+}
+
+resource "elasticstack_kibana_space" "test_space" {
+	space_id    = "%s"
+	name        = "Test Space %s"
+	description = "Test space for default data view"
+}
+
+resource "elasticstack_elasticsearch_index" "my_index" {
+	name                = "%s"
+	deletion_protection = false
+}
+
+resource "elasticstack_kibana_data_view" "dv" {
+	space_id = elasticstack_kibana_space.test_space.space_id
+	data_view = {
+		title = "%s*"
+	}
+	depends_on = [elasticstack_elasticsearch_index.my_index]
+}
+
+resource "elasticstack_kibana_default_data_view" "test" {
+	space_id     = elasticstack_kibana_space.test_space.space_id
+	data_view_id = elasticstack_kibana_data_view.dv.data_view.id
+	force        = true
+}
+`, spaceID, spaceID, indexName, indexName)
+}

internal/kibana/default_data_view/acc_test.go

@@ -5,41 +5,47 @@ import (
 
 	"github.com/elastic/terraform-provider-elasticstack/generated/kbapi"
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients/kibana_oapi"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
 func (r *DefaultDataViewResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
-	var plan defaultDataViewModel
-	diags := req.Plan.Get(ctx, &plan)
-	resp.Diagnostics.Append(diags...)
-	if resp.Diagnostics.HasError() {
-		return
+	resp.Diagnostics.Append(r.setDefaultDataView(ctx, req.Plan, &resp.State)...)
+}
+
+// setDefaultDataView is a helper method that contains the core logic for setting the default data view.
+func (r *DefaultDataViewResource) setDefaultDataView(ctx context.Context, plan tfsdk.Plan, state *tfsdk.State) diag.Diagnostics {
+	var model defaultDataViewModel
+	diags := plan.Get(ctx, &model)
+	if diags.HasError() {
+		return diags
 	}
 
 	client, err := r.client.GetKibanaOapiClient()
 	if err != nil {
-		resp.Diagnostics.AddError("unable to get kibana client", err.Error())
-		return
+		diags.AddError("unable to get kibana client", err.Error())
+		return diags
 	}
 
-	dataViewID := plan.DataViewID.ValueString()
-	force := plan.Force.ValueBool()
-
+	dataViewID := model.DataViewID.ValueString()
+	force := model.Force.ValueBool()
+	spaceID := model.SpaceID.ValueString()
 	setReq := kbapi.SetDefaultDatailViewDefaultJSONRequestBody{
 		DataViewId: &dataViewID,
 		Force:      &force,
 	}
 
-	diags = kibana_oapi.SetDefaultDataView(ctx, client, setReq)
-	resp.Diagnostics.Append(diags...)
-	if resp.Diagnostics.HasError() {
-		return
+	apiDiags := kibana_oapi.SetDefaultDataView(ctx, client, spaceID, setReq)
+	diags.Append(apiDiags...)
+	if diags.HasError() {
+		return diags
 	}
 
-	// Set a static ID since there's only one default data view setting
-	plan.ID = types.StringValue("default")
+	// Use the space_id as the resource ID
+	model.ID = types.StringValue(spaceID)
 
-	diags = resp.State.Set(ctx, plan)
-	resp.Diagnostics.Append(diags...)
+	diags = state.Set(ctx, model)
+	return diags
 }

internal/kibana/default_data_view/create.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/elastic/terraform-provider-elasticstack/generated/kbapi"
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients/kibana_oapi"
+	"github.com/elastic/terraform-provider-elasticstack/internal/utils"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 )
 
@@ -27,15 +28,16 @@ func (r *DefaultDataViewResource) Delete(ctx context.Context, req resource.Delet
 		return
 	}
 
-	// Unset the default data view by setting it to null
-	var nullDataViewID *string = nil
-	force := true
+	spaceID := state.SpaceID.ValueString()
+	if spaceID == "" {
+		spaceID = "default"
+	}
 
+	// Unset the default data view by setting it to null
 	setReq := kbapi.SetDefaultDatailViewDefaultJSONRequestBody{
-		DataViewId: nullDataViewID,
-		Force:      &force,
+		Force: utils.Pointer(true),
 	}
 
-	diags = kibana_oapi.SetDefaultDataView(ctx, client, setReq)
+	diags = kibana_oapi.SetDefaultDataView(ctx, client, spaceID, setReq)
 	resp.Diagnostics.Append(diags...)
 }

internal/kibana/default_data_view/delete.go

@@ -9,4 +9,5 @@ type defaultDataViewModel struct {
 	DataViewID types.String `tfsdk:"data_view_id"`
 	Force      types.Bool   `tfsdk:"force"`
 	SkipDelete types.Bool   `tfsdk:"skip_delete"`
+	SpaceID    types.String `tfsdk:"space_id"`
 }

internal/kibana/default_data_view/models.go

@@ -22,7 +22,12 @@ func (r *DefaultDataViewResource) Read(ctx context.Context, req resource.ReadReq
 		return
 	}
 
-	defaultDataViewID, diags := kibana_oapi.GetDefaultDataView(ctx, client)
+	spaceID := state.SpaceID.ValueString()
+	if spaceID == "" {
+		spaceID = "default"
+	}
+
+	defaultDataViewID, diags := kibana_oapi.GetDefaultDataView(ctx, client, spaceID)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
@@ -36,9 +41,9 @@ func (r *DefaultDataViewResource) Read(ctx context.Context, req resource.ReadReq
 
 	// Update state with current default data view
 	state.DataViewID = types.StringValue(*defaultDataViewID)
-	// Keep the ID as "default" - it should remain static
+	// Use the space_id as the resource ID
 	if state.ID.IsNull() || state.ID.IsUnknown() {
-		state.ID = types.StringValue("default")
+		state.ID = types.StringValue(spaceID)
 	}
 
 	diags = resp.State.Set(ctx, state)

internal/kibana/default_data_view/read.go

@@ -8,6 +8,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 )
@@ -37,15 +38,22 @@ func getSchema() schema.Schema {
 			"force": schema.BoolAttribute{
 				MarkdownDescription: "Update an existing default data view identifier. If set to false and a default data view already exists, the operation will fail.",
 				Optional:            true,
-				Computed:            true,
-				Default:             booldefault.StaticBool(true),
 			},
 			"skip_delete": schema.BoolAttribute{
 				MarkdownDescription: "If set to true, the default data view will not be unset when the resource is destroyed. The existing default data view will remain unchanged.",
 				Optional:            true,
 				Computed:            true,
 				Default:             booldefault.StaticBool(false),
 			},
+			"space_id": schema.StringAttribute{
+				MarkdownDescription: "The Kibana space ID to set the default data view in. Defaults to `default`.",
+				Optional:            true,
+				Computed:            true,
+				Default:             stringdefault.StaticString("default"),
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.RequiresReplace(),
+				},
+			},
 		},
 	}
 }