Update Agent Pool CRD & Add Logs

hashicorp · Oct 15, 2024 · d06cd5e · d06cd5e
1 parent e6fbc10
commit d06cd5e
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 20 deletions.
diff --git a/api/v1alpha2/agentpool_types.go b/api/v1alpha2/agentpool_types.go
@@ -91,9 +91,19 @@ type AgentDeploymentAutoscalingCooldownPeriod struct {
 }
 
 type AgentDeployment struct {
-	Replicas    *int32            `json:"replicas,omitempty"`
-	Spec        *v1.PodSpec       `json:"spec,omitempty"`
-	Labels      map[string]string `json:"labels,omitempty"`
+	Replicas *int32      `json:"replicas,omitempty"`
+	Spec     *v1.PodSpec `json:"spec,omitempty"`
+
+	//Labels are intended to specify identifying attributes of objects
+	//that are meaningful and relevant to users.These are applied to the
+	//pod template within the AgentDeployment, helping to organize and select
+	//pods.
+	//+optional
+	Labels map[string]string `json:"labels,omitempty"`
+
+	//Annotations are used to provide metadata. They are applied to the pod
+	//template within the AgentDeployment.
+	//+optional
 	Annotations map[string]string `json:"annotations,omitempty"`
 }
 

diff --git a/api/v1alpha2/zz_generated.deepcopy.go b/api/v1alpha2/zz_generated.deepcopy.go
diff --git a/charts/hcp-terraform-operator/crds/app.terraform.io_agentpools.yaml b/charts/hcp-terraform-operator/crds/app.terraform.io_agentpools.yaml
@@ -45,6 +45,14 @@ spec:
               agentDeployment:
                 description: Agent deployment settings
                 properties:
+                  annotations:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
                   replicas:
                     format: int32
                     type: integer

diff --git a/config/crd/bases/app.terraform.io_agentpools.yaml b/config/crd/bases/app.terraform.io_agentpools.yaml
@@ -42,6 +42,14 @@ spec:
               agentDeployment:
                 description: Agent deployment settings
                 properties:
+                  annotations:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
                   replicas:
                     format: int32
                     type: integer

diff --git a/controllers/agentpool_controller.go b/controllers/agentpool_controller.go
@@ -75,16 +75,6 @@ func (r *AgentPoolReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 	}
 	ap.log.Info("Spec Validation", "msg", "spec is valid")
 
-	// if ap.instance.Spec.AgentDeployment != nil {
-	// 	if ap.instance.Spec.AgentDeployment.Labels != nil {
-	// 		ap.log.Info("Labels available: ", "labels", ap.instance.Spec.AgentDeployment.Labels)
-	// 	} else {
-	// 		ap.log.Info("Labels available: ", "labels", "There are no labels")
-	// 	}
-	// } else {
-	// 	ap.log.Info("There are no labels")
-	// }
-
 	if needToAddFinalizer(&ap.instance, agentPoolFinalizer) {
 		err := r.addFinalizer(ctx, &ap.instance)
 		if err != nil {

diff --git a/controllers/agentpool_controller_deployment.go b/controllers/agentpool_controller_deployment.go
@@ -26,7 +26,7 @@ const (
 	poolIDLabel               = "agentpool.app.terraform.io/pool-id"
 	defaultAgentImage         = "hashicorp/tfc-agent"
 	defaultAgentContainerName = "tfc-agent"
-	DeploymentAnnotations     = "agentpool.app.terraform.io/deployment-name"
+	deploymentAnnotations     = "agentpool.app.terraform.io/deployment-name"
 )
 
 func (r *AgentPoolReconciler) reconcileAgentDeployment(ctx context.Context, ap *agentPoolInstance) error {
@@ -226,22 +226,33 @@ func agentPoolDeploymentName(ap *appv1alpha2.AgentPool) string {
 }
 
 func agentPoolPodLabels(ap *appv1alpha2.AgentPool) map[string]string {
-	label := map[string]string{
-		poolNameLabel: ap.Name,
-	}
+
+	label := map[string]string{}
 
 	//Attempting to merge
-	if ap.Spec.AgentDeployment != nil && ap.Spec.AgentDeployment.Labels != nil {
+	if len(ap.Spec.AgentDeployment.Labels) > 0 {
 		for key, value := range ap.Spec.AgentDeployment.Labels {
 			label[key] = value
 		}
 	}
 
+	//built in assignment
+	label[poolNameLabel] = ap.Name
+
 	return label
 }
 
 func agentDeploymentAnnotations(ap *appv1alpha2.AgentPool) map[string]string {
-	return map[string]string{
-		DeploymentAnnotations: ap.Name, //the format, key:value pair
+
+	annotations := map[string]string{}
+
+	if len(ap.Spec.AgentDeployment.Annotations) > 0 {
+		for key, value := range ap.Spec.AgentDeployment.Annotations {
+			annotations[key] = value
+		}
 	}
+
+	annotations[deploymentAnnotations] = ap.Name
+
+	return annotations
 }
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -29,6 +29,8 @@ _Appears in:_
 | --- | --- |
 | `replicas` _integer_ |  |
 | `spec` _[PodSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#podspec-v1-core)_ |  |
+| `labels` _object (keys:string, values:string)_ |  |
+| `annotations` _object (keys:string, values:string)_ |  |
 
 
 #### AgentDeploymentAutoscaling