Update variables reconciliation logic to reduce number of API calls (#…

…390)
hashicorp · Apr 23, 2024 · fe8d4a5 · fe8d4a5
1 parent da17f0b
commit fe8d4a5
Show file tree

Hide file tree

Showing 13 changed files with 329 additions and 212 deletions.
diff --git a/.changes/unreleased/ENHANCEMENTS-390-20240419-102720.yaml b/.changes/unreleased/ENHANCEMENTS-390-20240419-102720.yaml
@@ -0,0 +1,6 @@
+kind: ENHANCEMENTS
+body: '`Workspace`: Update variables reconciliation logic to reduce the number of
+  API calls.'
+time: 2024-04-19T10:27:20.790343+02:00
+custom:
+  PR: "390"
diff --git a/.changes/unreleased/NOTES-390-20240419-102736.yaml b/.changes/unreleased/NOTES-390-20240419-102736.yaml
@@ -0,0 +1,6 @@
+kind: NOTES
+body: The `Workspace` CRD has been changed. Please follow the Helm chart instructions
+  on how to upgrade it.
+time: 2024-04-19T10:27:36.644376+02:00
+custom:
+  PR: "390"
diff --git a/api/v1alpha2/workspace_helpers.go b/api/v1alpha2/workspace_helpers.go
@@ -3,6 +3,52 @@
 
 package v1alpha2
 
+import (
+	"github.com/hashicorp/terraform-cloud-operator/internal/slice"
+)
+
 func (w *Workspace) IsCreationCandidate() bool {
 	return w.Status.WorkspaceID == ""
 }
+
+// AddOrUpdateVariableStatus adds a given variable to the status if it does not exist there; otherwise, it updates it.
+func (s *WorkspaceStatus) AddOrUpdateVariableStatus(variable VariableStatus) {
+	for i, v := range s.Variables {
+		if v.Name == variable.Name && v.Category == variable.Category {
+			s.Variables[i].ID = variable.ID
+			s.Variables[i].VersionID = variable.VersionID
+			s.Variables[i].ValueID = variable.ValueID
+			s.Variables[i].Category = variable.Category
+			return
+		}
+	}
+
+	s.Variables = append(s.Variables, VariableStatus{
+		Name:      variable.Name,
+		ID:        variable.ID,
+		VersionID: variable.VersionID,
+		ValueID:   variable.ValueID,
+		Category:  variable.Category,
+	})
+}
+
+// GetVariableStatus returns a given variable from the status if it exists there; otherwise, nil.
+func (s *WorkspaceStatus) GetVariableStatus(variable VariableStatus) *VariableStatus {
+	for _, v := range s.Variables {
+		if v.Name == variable.Name && v.Category == variable.Category {
+			return &v
+		}
+	}
+
+	return nil
+}
+
+// DeleteVariableStatus deletes a given variable from the status.
+func (s *WorkspaceStatus) DeleteVariableStatus(variable VariableStatus) {
+	for i, v := range s.Variables {
+		if v.Name == variable.Name && v.Category == variable.Category {
+			s.Variables = slice.RemoveFromSlice(s.Variables, i)
+			return
+		}
+	}
+}
diff --git a/api/v1alpha2/workspace_types.go b/api/v1alpha2/workspace_types.go
@@ -598,6 +598,19 @@ type RunStatus struct {
 	OutputRunID string `json:"outputRunID,omitempty"`
 }
 
+type VariableStatus struct {
+	// Name of the variable.
+	Name string `json:"name"`
+	// ID of the variable.
+	ID string `json:"id"`
+	// VersionID is a hash of the variable on the TFC end.
+	VersionID string `json:"versionID"`
+	// ValueID is a hash of the variable on the CRD end.
+	ValueID string `json:"valueID"`
+	// Category of the variable.
+	Category string `json:"category"`
+}
+
 // WorkspaceStatus defines the observed state of Workspace.
 type WorkspaceStatus struct {
 	// Workspace ID that is managed by the controller.
@@ -624,6 +637,10 @@ type WorkspaceStatus struct {
 	//+kubebuilder:validation:Pattern:="^\\d{1}\\.\\d{1,2}\\.\\d{1,2}$"
 	//+optional
 	TerraformVersion string `json:"terraformVersion,omitempty"`
+	// Workspace variables.
+	//
+	//+optional
+	Variables []VariableStatus `json:"variables,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/api/v1alpha2/zz_generated.deepcopy.go b/api/v1alpha2/zz_generated.deepcopy.go
diff --git a/charts/terraform-cloud-operator/README.md b/charts/terraform-cloud-operator/README.md
@@ -84,6 +84,14 @@ For a more detailed explanation, please refer to the [FAQ](../../docs/faq.md#gen
 
 #### Upgrade recommendations
 
+  - `2.3.0` to `2.4.0`
+
+    - The `Workspace` CRD has been changed:
+
+      ```console
+      $ kubectl replace -f https://raw.githubusercontent.com/hashicorp/terraform-cloud-operator/v2.4.0/charts/terraform-cloud-operator/crds/app.terraform.io_workspaces.yaml
+      ```
+
   - `2.2.0` to `2.3.0`
 
     - The `Workspace` CRD has been changed:

diff --git a/charts/terraform-cloud-operator/README.md.gotmpl b/charts/terraform-cloud-operator/README.md.gotmpl
@@ -84,6 +84,14 @@ For a more detailed explanation, please refer to the [FAQ](../../docs/faq.md#gen
 
 #### Upgrade recommendations
 
+  - `2.3.0` to `2.4.0`
+
+    - The `Workspace` CRD has been changed:
+
+      ```console
+      $ kubectl replace -f https://raw.githubusercontent.com/hashicorp/terraform-cloud-operator/v2.4.0/charts/terraform-cloud-operator/crds/app.terraform.io_workspaces.yaml
+      ```
+
   - `2.2.0` to `2.3.0`
 
     - The `Workspace` CRD has been changed:

diff --git a/charts/terraform-cloud-operator/crds/app.terraform.io_workspaces.yaml b/charts/terraform-cloud-operator/crds/app.terraform.io_workspaces.yaml
@@ -758,6 +758,34 @@ spec:
                 description: Workspace last update timestamp.
                 format: int64
                 type: integer
+              variables:
+                description: Workspace variables.
+                items:
+                  properties:
+                    category:
+                      description: Category of the variable.
+                      type: string
+                    id:
+                      description: ID of the variable.
+                      type: string
+                    name:
+                      description: Name of the variable.
+                      type: string
+                    valueID:
+                      description: ValueID is a hash of the variable on the CRD end.
+                      type: string
+                    versionID:
+                      description: VersionID is a hash of the variable on the TFC
+                        end.
+                      type: string
+                  required:
+                  - category
+                  - id
+                  - name
+                  - valueID
+                  - versionID
+                  type: object
+                type: array
               workspaceID:
                 description: Workspace ID that is managed by the controller.
                 type: string

diff --git a/config/crd/bases/app.terraform.io_workspaces.yaml b/config/crd/bases/app.terraform.io_workspaces.yaml
@@ -755,6 +755,34 @@ spec:
                 description: Workspace last update timestamp.
                 format: int64
                 type: integer
+              variables:
+                description: Workspace variables.
+                items:
+                  properties:
+                    category:
+                      description: Category of the variable.
+                      type: string
+                    id:
+                      description: ID of the variable.
+                      type: string
+                    name:
+                      description: Name of the variable.
+                      type: string
+                    valueID:
+                      description: ValueID is a hash of the variable on the CRD end.
+                      type: string
+                    versionID:
+                      description: VersionID is a hash of the variable on the TFC
+                        end.
+                      type: string
+                  required:
+                  - category
+                  - id
+                  - name
+                  - valueID
+                  - versionID
+                  type: object
+                type: array
               workspaceID:
                 description: Workspace ID that is managed by the controller.
                 type: string

diff --git a/controllers/workspace_controller.go b/controllers/workspace_controller.go
@@ -11,6 +11,8 @@ import (
 	"os"
 	"strconv"
 
+	"github.com/go-logr/logr"
+	tfc "github.com/hashicorp/go-tfe"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -22,9 +24,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
-	"github.com/go-logr/logr"
-
-	tfc "github.com/hashicorp/go-tfe"
 	appv1alpha2 "github.com/hashicorp/terraform-cloud-operator/api/v1alpha2"
 	"github.com/hashicorp/terraform-cloud-operator/version"
 )