feat: introduce field to set annotations on tfstate secret

api/v1alpha2/terraform_types.go

@@ -227,6 +227,10 @@ type TerraformSpec struct {
 	// +optional
 	TFState *TFStateSpec `json:"tfstate,omitempty"`
 
+	// annotations to add to the tfstate secret
+	// +optional
+	TFStateAnnotations map[string]string `json:"tfstateAnnotations,omitempty"`
+
 	// Targets specify the resource, module or collection of resources to target.
 	// +optional
 	Targets []string `json:"targets,omitempty"`

charts/tofu-controller/crds/crds.yaml

@@ -10441,6 +10441,11 @@ spec:
                       Defaults to `0s` which will behave as though `LockTimeout` was not set
                     type: string
                 type: object
+              tfstateAnnotations:
+                additionalProperties:
+                  type: string
+                description: annotations to add to the tfstate secret
+                type: object
               values:
                 description: |-
                   Values map to the Terraform variable "values", which is an object of arbitrary values.

config/crd/bases/infra.contrib.fluxcd.io_terraforms.yaml

@@ -10441,6 +10441,11 @@ spec:
                       Defaults to `0s` which will behave as though `LockTimeout` was not set
                     type: string
                 type: object
+              tfstateAnnotations:
+                additionalProperties:
+                  type: string
+                description: annotations to add to the tfstate secret
+                type: object
               values:
                 description: |-
                   Values map to the Terraform variable "values", which is an object of arbitrary values.

controllers/tf_controller.go

@@ -816,6 +816,38 @@ func (r *TerraformReconciler) patchStatus(ctx context.Context, objectKey types.N
 	return r.Status().Patch(ctx, &terraform, patch, statusOpts)
 }
 
+func (r *TerraformReconciler) patchAnnotationsToTfstateSecret(ctx context.Context, terraform infrav1.Terraform) error {
+	if len(terraform.Spec.TFStateAnnotations) == 0 {
+		// skip if no annotations are provided
+		return nil
+	}
+	secretSuffix := terraform.Name
+	if terraform.Spec.BackendConfig != nil && terraform.Spec.BackendConfig.SecretSuffix != "" {
+		secretSuffix = terraform.Spec.BackendConfig.SecretSuffix
+	}
+
+	secret := &corev1.Secret{}
+	err := r.Client.Get(ctx, types.NamespacedName{
+		Namespace: terraform.Namespace,
+		Name:      fmt.Sprintf(`tfstate-%s-%s`, terraform.WorkspaceName(), secretSuffix),
+	}, secret)
+	if err != nil {
+		return err
+	}
+
+	// set annotations to the secret
+	for key, value := range terraform.Spec.TFStateAnnotations {
+		secret.Annotations[key] = value
+	}
+
+	err = r.Client.Update(ctx, secret)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (r *TerraformReconciler) IndexBy(kind string) func(o client.Object) []string {
 	return func(o client.Object) []string {
 		terraform, ok := o.(*infrav1.Terraform)

controllers/tf_controller_reconcile.go

@@ -206,6 +206,11 @@ func (r *TerraformReconciler) reconcile(ctx context.Context, runnerClient runner
 			return &terraform, err
 		}
 
+		if err := r.patchAnnotationsToTfstateSecret(ctx, terraform); err != nil {
+			log.Error(err, "unable to set annotations to tfstate secret")
+			// not a critical error, continue
+		}
+
 		if err := r.patchStatus(ctx, objectKey, terraform.Status); err != nil {
 			log.Error(err, "unable to update status after applying")
 			return &terraform, err

docs/References/terraform.md

@@ -1789,6 +1789,18 @@ TFStateSpec
 </tr>
 <tr>
 <td>
+<code>tfstateAnnotations</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>annotations to add to the tfstate secret</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>targets</code><br>
 <em>
 []string
@@ -2352,6 +2364,18 @@ TFStateSpec
 </tr>
 <tr>
 <td>
+<code>tfstateAnnotations</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>annotations to add to the tfstate secret</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>targets</code><br>
 <em>
 []string