fix: Save cluster state after creating it in the API (#109)

maciaszczykm · web-flow · commit 429474da7195 · 2025-11-19T12:17:33.000-05:00
diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md
@@ -33,6 +33,7 @@ A representation of a cluster you can deploy to.
 
 ### Read-Only
 
+- `agent_deployed` (Boolean) Whether the agent was deployed to the cluster.
 - `id` (String) Internal identifier of this cluster.
 - `inserted_at` (String) Creation date of this cluster.
 
diff --git a/example/cluster/main.tf b/example/cluster/main.tf
@@ -2,13 +2,17 @@ terraform {
   required_providers {
     plural = {
       source = "pluralsh/plural"
-      version = "0.2.28"
+      version = "0.2.30"
     }
   }
 }
 
 provider "plural" {
   use_cli = true
+  kubeconfig = {
+    # It can be sourced from environment variables instead, i.e.: export PLURAL_KUBE_CONFIG_PATH=$KUBECONFIG
+    config_path = pathexpand("~/.kube/config")
+  }
 }
 
 data "plural_project" "test" {
diff --git a/internal/planmodifier/ensure_agent.go b/internal/planmodifier/ensure_agent.go
@@ -0,0 +1,40 @@
+package resource
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+type ensureAgentPlanModifier struct{}
+
+func (in ensureAgentPlanModifier) Description(_ context.Context) string {
+	return "Forces resource update when agent is not deployed"
+}
+
+func (in ensureAgentPlanModifier) MarkdownDescription(_ context.Context) string {
+	return "Forces resource update when agent is not deployed"
+}
+
+func (in ensureAgentPlanModifier) PlanModifyBool(ctx context.Context, req planmodifier.BoolRequest, resp *planmodifier.BoolResponse) {
+	if req.State.Raw.IsNull() {
+		return
+	}
+
+	var agentDeployed types.Bool
+	resp.Diagnostics.Append(req.Plan.GetAttribute(ctx, path.Root("agent_deployed"), &agentDeployed)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// If the agent is not deployed, force update by setting the field to unknown.
+	if !agentDeployed.IsNull() && !agentDeployed.ValueBool() {
+		resp.PlanValue = types.BoolUnknown()
+	}
+}
+
+func EnsureAgent() planmodifier.Bool {
+	return ensureAgentPlanModifier{}
+}
diff --git a/internal/resource/cluster.go b/internal/resource/cluster.go
@@ -11,12 +11,21 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"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/objectplanmodifier"
+	"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/types"
+	"github.com/pluralsh/plural-cli/pkg/console"
 	"github.com/samber/lo"
 	"k8s.io/apimachinery/pkg/util/wait"
 )
 
 var _ resource.Resource = &clusterResource{}
 var _ resource.ResourceWithImportState = &clusterResource{}
+var _ resource.ResourceWithUpgradeState = &clusterResource{}
 
 func NewClusterResource() resource.Resource {
 	return &clusterResource{}
@@ -68,21 +77,20 @@ func (r *clusterResource) Create(ctx context.Context, req resource.CreateRequest
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to create cluster, got error: %s", err))
 		return
 	}
+	data.FromCreate(result, ctx, &resp.Diagnostics)
 
 	if r.kubeClient != nil || data.HasKubeconfig() {
-		if result.CreateCluster.DeployToken == nil {
-			resp.Diagnostics.AddError("Client Error", "Unable to fetch cluster deploy token")
-			return
-		}
-
-		if err = InstallOrUpgradeAgent(ctx, r.client, data.GetKubeconfig(), r.kubeClient, data.HelmRepoUrl.ValueString(),
-			data.HelmValues.ValueStringPointer(), r.consoleUrl, lo.FromPtr(result.CreateCluster.DeployToken), result.CreateCluster.ID, &resp.Diagnostics); err != nil {
-			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to install operator, got error: %s", err))
-			return
+		err = InstallOrUpgradeAgent(ctx, r.client, data.GetKubeconfig(), r.kubeClient, data.HelmRepoUrl.ValueString(),
+			data.HelmValues.ValueStringPointer(), r.consoleUrl, lo.FromPtr(result.CreateCluster.DeployToken),
+			result.CreateCluster.ID, &resp.Diagnostics)
+		if err != nil {
+			resp.Diagnostics.AddWarning("Agent Installation Failed", fmt.Sprintf(
+				"Unable to install agent, in order to retry run `terraform apply` again. Got error: %s", err))
+		} else {
+			data.AgentDeployed = types.BoolValue(true)
 		}
 	}
 
-	data.FromCreate(result, ctx, &resp.Diagnostics)
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }
 
@@ -142,7 +150,7 @@ func (r *clusterResource) Update(ctx context.Context, req resource.UpdateRequest
 	}
 
 	kubeconfigChanged := data.HasKubeconfig() && !data.GetKubeconfig().Unchanged(state.GetKubeconfig())
-	reinstallable := !data.HelmRepoUrl.Equal(state.HelmRepoUrl) || kubeconfigChanged
+	reinstallable := !data.AgentDeployed.ValueBool() || !data.HelmRepoUrl.Equal(state.HelmRepoUrl) || kubeconfigChanged
 	if reinstallable && (r.kubeClient != nil || data.HasKubeconfig()) {
 		clusterWithToken, err := r.client.GetClusterWithToken(ctx, data.Id.ValueStringPointer(), nil)
 		if err != nil {
@@ -155,6 +163,8 @@ func (r *clusterResource) Update(ctx context.Context, req resource.UpdateRequest
 			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to install operator, got error: %s", err))
 			return
 		}
+
+		data.AgentDeployed = types.BoolValue(true)
 	}
 
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
@@ -210,3 +220,140 @@ func (r *clusterResource) ImportState(ctx context.Context, req resource.ImportSt
 
 	resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
 }
+
+func (r *clusterResource) UpgradeState(_ context.Context) map[int64]resource.StateUpgrader {
+	return map[int64]resource.StateUpgrader{
+		// State upgrade from 0 to 1
+		0: {
+			PriorSchema: &schema.Schema{
+				Version: 0,
+				Attributes: map[string]schema.Attribute{
+					"id": schema.StringAttribute{
+						Computed:      true,
+						PlanModifiers: []planmodifier.String{stringplanmodifier.UseStateForUnknown()},
+					},
+					"inserted_at": schema.StringAttribute{
+						Computed:      true,
+						PlanModifiers: []planmodifier.String{stringplanmodifier.UseStateForUnknown()},
+					},
+					"name": schema.StringAttribute{
+						Required:      true,
+						PlanModifiers: []planmodifier.String{stringplanmodifier.UseStateForUnknown()},
+					},
+					"handle": schema.StringAttribute{
+						Optional:      true,
+						Computed:      true,
+						PlanModifiers: []planmodifier.String{stringplanmodifier.UseStateForUnknown()},
+					},
+					"project_id": schema.StringAttribute{
+						Optional: true,
+					},
+					"detach": schema.BoolAttribute{
+						Optional: true,
+						Computed: true,
+						Default:  booldefault.StaticBool(false),
+					},
+					"metadata": schema.StringAttribute{
+						Optional:      true,
+						Computed:      true,
+						Default:       stringdefault.StaticString("{}"),
+						PlanModifiers: []planmodifier.String{stringplanmodifier.UseStateForUnknown()},
+					},
+					"helm_repo_url": schema.StringAttribute{
+						Optional: true,
+						Computed: true,
+						Default:  stringdefault.StaticString(console.RepoUrl),
+					},
+					"helm_values": schema.StringAttribute{
+						Optional: true,
+					},
+					"kubeconfig": common.KubeconfigResourceSchema(),
+					"protect": schema.BoolAttribute{
+						Optional: true,
+						Computed: true,
+						Default:  booldefault.StaticBool(false),
+					},
+					"tags": schema.MapAttribute{
+						Optional:    true,
+						ElementType: types.StringType,
+					},
+					"bindings": schema.SingleNestedAttribute{
+						Optional: true,
+						Attributes: map[string]schema.Attribute{
+							"read": schema.SetNestedAttribute{
+								Optional: true,
+								NestedObject: schema.NestedAttributeObject{
+									Attributes: map[string]schema.Attribute{
+										"group_id": schema.StringAttribute{Optional: true},
+										"id":       schema.StringAttribute{Optional: true},
+										"user_id":  schema.StringAttribute{Optional: true},
+									},
+								},
+							},
+							"write": schema.SetNestedAttribute{
+								Optional:            true,
+								Description:         "Write policies of this cluster.",
+								MarkdownDescription: "Write policies of this cluster.",
+								NestedObject: schema.NestedAttributeObject{
+									Attributes: map[string]schema.Attribute{
+										"group_id": schema.StringAttribute{
+											Optional: true,
+										},
+										"id": schema.StringAttribute{
+											Optional: true,
+										},
+										"user_id": schema.StringAttribute{
+											Optional: true,
+										},
+									},
+								},
+							},
+						},
+						PlanModifiers: []planmodifier.Object{objectplanmodifier.UseStateForUnknown()},
+					},
+				},
+			},
+			StateUpgrader: func(ctx context.Context, req resource.UpgradeStateRequest, resp *resource.UpgradeStateResponse) {
+				var priorStateData struct {
+					Id          types.String       `tfsdk:"id"`
+					InsertedAt  types.String       `tfsdk:"inserted_at"`
+					Name        types.String       `tfsdk:"name"`
+					Handle      types.String       `tfsdk:"handle"`
+					ProjectId   types.String       `tfsdk:"project_id"`
+					Detach      types.Bool         `tfsdk:"detach"`
+					Protect     types.Bool         `tfsdk:"protect"`
+					Tags        types.Map          `tfsdk:"tags"`
+					Metadata    types.String       `tfsdk:"metadata"`
+					Bindings    *common.Bindings   `tfsdk:"bindings"`
+					HelmRepoUrl types.String       `tfsdk:"helm_repo_url"`
+					HelmValues  types.String       `tfsdk:"helm_values"`
+					Kubeconfig  *common.Kubeconfig `tfsdk:"kubeconfig"`
+				}
+
+				resp.Diagnostics.Append(req.State.Get(ctx, &priorStateData)...)
+				if resp.Diagnostics.HasError() {
+					return
+				}
+
+				upgradedStateData := cluster{
+					Id:            priorStateData.Id,
+					InsertedAt:    priorStateData.InsertedAt,
+					Name:          priorStateData.Name,
+					Handle:        priorStateData.Handle,
+					ProjectId:     priorStateData.ProjectId,
+					Detach:        priorStateData.Detach,
+					Protect:       priorStateData.Protect,
+					Tags:          priorStateData.Tags,
+					Metadata:      priorStateData.Metadata,
+					Bindings:      priorStateData.Bindings,
+					HelmRepoUrl:   priorStateData.HelmRepoUrl,
+					HelmValues:    priorStateData.HelmValues,
+					Kubeconfig:    priorStateData.Kubeconfig,
+					AgentDeployed: types.BoolValue(true),
+				}
+
+				resp.Diagnostics.Append(resp.State.Set(ctx, upgradedStateData)...)
+			},
+		},
+	}
+}
diff --git a/internal/resource/cluster_model.go b/internal/resource/cluster_model.go
@@ -13,19 +13,20 @@ import (
 )
 
 type cluster struct {
-	Id          types.String       `tfsdk:"id"`
-	InsertedAt  types.String       `tfsdk:"inserted_at"`
-	Name        types.String       `tfsdk:"name"`
-	Handle      types.String       `tfsdk:"handle"`
-	ProjectId   types.String       `tfsdk:"project_id"`
-	Detach      types.Bool         `tfsdk:"detach"`
-	Protect     types.Bool         `tfsdk:"protect"`
-	Tags        types.Map          `tfsdk:"tags"`
-	Metadata    types.String       `tfsdk:"metadata"`
-	Bindings    *common.Bindings   `tfsdk:"bindings"`
-	HelmRepoUrl types.String       `tfsdk:"helm_repo_url"`
-	HelmValues  types.String       `tfsdk:"helm_values"`
-	Kubeconfig  *common.Kubeconfig `tfsdk:"kubeconfig"`
+	Id            types.String       `tfsdk:"id"`
+	InsertedAt    types.String       `tfsdk:"inserted_at"`
+	Name          types.String       `tfsdk:"name"`
+	Handle        types.String       `tfsdk:"handle"`
+	ProjectId     types.String       `tfsdk:"project_id"`
+	Detach        types.Bool         `tfsdk:"detach"`
+	Protect       types.Bool         `tfsdk:"protect"`
+	Tags          types.Map          `tfsdk:"tags"`
+	Metadata      types.String       `tfsdk:"metadata"`
+	Bindings      *common.Bindings   `tfsdk:"bindings"`
+	HelmRepoUrl   types.String       `tfsdk:"helm_repo_url"`
+	HelmValues    types.String       `tfsdk:"helm_values"`
+	Kubeconfig    *common.Kubeconfig `tfsdk:"kubeconfig"`
+	AgentDeployed types.Bool         `tfsdk:"agent_deployed"`
 }
 
 func (c *cluster) TagsAttribute(ctx context.Context, d *diag.Diagnostics) []*console.TagAttributes {
@@ -94,6 +95,7 @@ func (c *cluster) FromCreate(cc *console.CreateCluster, _ context.Context, d *di
 	c.Handle = types.StringPointerValue(cc.CreateCluster.Handle)
 	c.Protect = types.BoolPointerValue(cc.CreateCluster.Protect)
 	c.Tags = common.TagsFrom(cc.CreateCluster.Tags, c.Tags, d)
+	c.AgentDeployed = types.BoolValue(false)
 }
 
 func (c *cluster) ClusterVersionFrom(prov *console.ClusterProviderFragment, version, currentVersion *string) types.String {
diff --git a/internal/resource/cluster_operator_handler.go b/internal/resource/cluster_operator_handler.go
@@ -33,6 +33,10 @@ import (
 
 func InstallOrUpgradeAgent(ctx context.Context, client *client.Client, kubeconfig *common.Kubeconfig, kubeClient *common.KubeClient,
 	repoUrl string, values *string, consoleUrl string, token string, clusterId string, d *diag.Diagnostics) error {
+	if lo.IsEmpty(token) {
+		return fmt.Errorf("deploy token cannot be empty")
+	}
+
 	workingDir, chartPath, err := fetchVendoredAgentChart(consoleUrl)
 	if err != nil {
 		d.AddWarning("Client Warning", fmt.Sprintf("Could not fetch vendored agent chart, using chart from the registry: %s", err))
diff --git a/internal/resource/cluster_schema.go b/internal/resource/cluster_schema.go
@@ -2,6 +2,7 @@ package resource
 
 import (
 	"terraform-provider-plural/internal/common"
+	resource "terraform-provider-plural/internal/planmodifier"
 
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
 	"github.com/pluralsh/plural-cli/pkg/console"
@@ -18,6 +19,7 @@ func (r *clusterResource) schema() schema.Schema {
 	return schema.Schema{
 		Description:         "A representation of a cluster you can deploy to.",
 		MarkdownDescription: "A representation of a cluster you can deploy to.",
+		Version:             1,
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Description:         "Internal identifier of this cluster.",
@@ -134,6 +136,12 @@ func (r *clusterResource) schema() schema.Schema {
 				},
 				PlanModifiers: []planmodifier.Object{objectplanmodifier.UseStateForUnknown()},
 			},
+			"agent_deployed": schema.BoolAttribute{
+				Description:         "Whether the agent was deployed to the cluster.",
+				MarkdownDescription: "Whether the agent was deployed to the cluster.",
+				Computed:            true,
+				PlanModifiers:       []planmodifier.Bool{resource.EnsureAgent()},
+			},
 		},
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,17 @@ terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`plural = {`
`4`	`4`	`source = "pluralsh/plural"`
`5`		`- version = "0.2.28"`
	`5`	`+ version = "0.2.30"`
`6`	`6`	`}`
`7`	`7`	`}`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`provider "plural" {`
`11`	`11`	`use_cli = true`
	`12`	`+ kubeconfig = {`
	`13`	`+ # It can be sourced from environment variables instead, i.e.: export PLURAL_KUBE_CONFIG_PATH=$KUBECONFIG`
	`14`	`+ config_path = pathexpand("~/.kube/config")`
	`15`	`+ }`
`12`	`16`	`}`
`13`	`17`
`14`	`18`	`data "plural_project" "test" {`