Phase 1: CRD and Initial Structure

Author: eliranb

api/v1beta/lightrunjavaagent_types.go

@@ -38,8 +38,13 @@ type LightrunJavaAgentSpec struct {
 	ContainerSelector []string      `json:"containerSelector"`
 	InitContainer     InitContainer `json:"initContainer"`
 
-	//Name of the Deployment that will be patched
-	DeploymentName string `json:"deploymentName"`
+	// Name of the Deployment that will be patched
+	// +optional
+	DeploymentName string `json:"deploymentName,omitempty"`
+
+	// Name of the StatefulSet that will be patched
+	// +optional
+	StatefulSetName string `json:"statefulSetName,omitempty"`
 
 	//Name of the Secret in the same namespace contains lightrun key and conmpany id
 	SecretName string `json:"secretName"`
@@ -76,14 +81,15 @@ type LightrunJavaAgentSpec struct {
 type LightrunJavaAgentStatus struct {
 	LastScheduleTime *metav1.Time       `json:"lastScheduleTime,omitempty"`
 	Conditions       []metav1.Condition `json:"conditions,omitempty"`
-	DeploymentStatus string             `json:"deploymentStatus,omitempty"`
+	WorkloadStatus   string             `json:"workloadStatus,omitempty"`
 }
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 //+kubebuilder:resource:shortName=lrja
 //+kubebuilder:printcolumn:priority=0,name=Deployment,type=string,JSONPath=".spec.deploymentName",description="Deployment name",format=""
-//+kubebuilder:printcolumn:priority=0,name="Status",type=string,JSONPath=".status.deploymentStatus",description="Status of Deployment Reconciliation",format=""
+//+kubebuilder:printcolumn:priority=0,name=StatefulSet,type=string,JSONPath=".spec.statefulSetName",description="StatefulSet name",format=""
+//+kubebuilder:printcolumn:priority=0,name="Status",type=string,JSONPath=".status.workloadStatus",description="Status of Workload Reconciliation",format=""
 //+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 
 // LightrunJavaAgent is the Schema for the lightrunjavaagents API

config/crd/bases/agents.lightrun.com_lightrunjavaagents.yaml

@@ -21,8 +21,12 @@ spec:
       jsonPath: .spec.deploymentName
       name: Deployment
       type: string
-    - description: Status of Deployment Reconciliation
-      jsonPath: .status.deploymentStatus
+    - description: StatefulSet name
+      jsonPath: .spec.statefulSetName
+      name: StatefulSet
+      type: string
+    - description: Status of Workload Reconciliation
+      jsonPath: .status.workloadStatus
       name: Status
       type: string
     - jsonPath: .metadata.creationTimestamp
@@ -115,11 +119,13 @@ spec:
                   Lightrun server hostname that will be used for downloading an agent
                   Key and company id in the secret has to be taken from this server as well
                 type: string
+              statefulSetName:
+                description: Name of the StatefulSet that will be patched
+                type: string
             required:
             - agentEnvVarName
             - agentTags
             - containerSelector
-            - deploymentName
             - initContainer
             - secretName
             - serverHostname
@@ -196,11 +202,11 @@ spec:
                   - type
                   type: object
                 type: array
-              deploymentStatus:
-                type: string
               lastScheduleTime:
                 format: date-time
                 type: string
+              workloadStatus:
+                type: string
             type: object
         type: object
     served: true

config/rbac/role.yaml

@@ -39,6 +39,15 @@ rules:
   - list
   - patch
   - watch
+- apiGroups:
+  - apps
+  resources:
+  - statefulsets
+  verbs:
+  - get
+  - list
+  - patch
+  - watch
 - apiGroups:
   - ""
   resources:

internal/controller/helpers.go

@@ -48,6 +48,31 @@ func (r *LightrunJavaAgentReconciler) mapDeploymentToAgent(ctx context.Context,
 	return requests
 }
 
+func (r *LightrunJavaAgentReconciler) mapStatefulSetToAgent(ctx context.Context, obj client.Object) []reconcile.Request {
+	statefulSet := obj.(*appsv1.StatefulSet)
+
+	var lightrunJavaAgentList agentv1beta.LightrunJavaAgentList
+
+	if err := r.List(ctx, &lightrunJavaAgentList,
+		client.InNamespace(statefulSet.Namespace),
+		client.MatchingFields{statefulSetNameIndexField: statefulSet.Name},
+	); err != nil {
+		r.Log.Error(err, "could not list LightrunJavaAgentList. "+
+			"change to statefulset will not be reconciled.",
+			statefulSet.Name, statefulSet.Namespace)
+		return nil
+	}
+
+	requests := make([]reconcile.Request, len(lightrunJavaAgentList.Items))
+
+	for i, lightrunJavaAgent := range lightrunJavaAgentList.Items {
+		requests[i] = reconcile.Request{
+			NamespacedName: client.ObjectKeyFromObject(&lightrunJavaAgent),
+		}
+	}
+	return requests
+}
+
 func (r *LightrunJavaAgentReconciler) mapSecretToAgent(ctx context.Context, obj client.Object) []reconcile.Request {
 	secret := obj.(*corev1.Secret)
 
@@ -96,7 +121,7 @@ func (r *LightrunJavaAgentReconciler) successStatus(ctx context.Context, instanc
 		Status:             metav1.ConditionTrue,
 	}
 	SetStatusCondition(&instance.Status.Conditions, condition)
-	instance.Status.DeploymentStatus = r.findLastConditionType(&instance.Status.Conditions)
+	instance.Status.WorkloadStatus = r.findLastConditionType(&instance.Status.Conditions)
 	err := r.Status().Update(ctx, instance)
 	if err != nil {
 		if apierrors.IsConflict(err) {
@@ -122,7 +147,7 @@ func (r *LightrunJavaAgentReconciler) errorStatus(ctx context.Context, instance
 		Status:             metav1.ConditionTrue,
 	}
 	SetStatusCondition(&instance.Status.Conditions, condition)
-	instance.Status.DeploymentStatus = r.findLastConditionType(&instance.Status.Conditions)
+	instance.Status.WorkloadStatus = r.findLastConditionType(&instance.Status.Conditions)
 	err := r.Status().Update(ctx, instance)
 	if err != nil {
 		if apierrors.IsConflict(err) {

internal/controller/lightrunjavaagent_controller.go

@@ -36,9 +36,10 @@ import (
 )
 
 const (
-	deploymentNameIndexField = "spec.deployment"
-	secretNameIndexField     = "spec.secret"
-	finalizerName            = "agent.finalizers.lightrun.com"
+	deploymentNameIndexField  = "spec.deployment"
+	statefulSetNameIndexField = "spec.statefulset"
+	secretNameIndexField      = "spec.secret"
+	finalizerName             = "agent.finalizers.lightrun.com"
 )
 
 var err error
@@ -56,19 +57,40 @@ type LightrunJavaAgentReconciler struct {
 //+kubebuilder:rbac:groups=agents.lightrun.com,resources=lightrunjavaagents/finalizers,verbs=update
 //+kubebuilder:rbac:groups=core,resources=configmaps,verbs=get;list;watch;create;update;patch;delete
 //+kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;watch;list;patch
+//+kubebuilder:rbac:groups=apps,resources=statefulsets,verbs=get;watch;list;patch
 //+kubebuilder:rbac:groups=core,resources=secrets,verbs=get;watch;list
 
 func (r *LightrunJavaAgentReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	log := r.Log.WithValues("lightrunJavaAgent", req.NamespacedName)
-	fieldManager := "lightrun-conrtoller"
 	lightrunJavaAgent := &agentv1beta.LightrunJavaAgent{}
 	if err = r.Get(ctx, req.NamespacedName, lightrunJavaAgent); err != nil {
 		return ctrl.Result{}, client.IgnoreNotFound(err)
 	}
 
+	// Determine which workload type to reconcile
+	if lightrunJavaAgent.Spec.DeploymentName != "" && lightrunJavaAgent.Spec.StatefulSetName != "" {
+		log.Error(nil, "Both DeploymentName and StatefulSetName are set. Only one should be specified")
+		return r.errorStatus(ctx, lightrunJavaAgent, errors.New("both deployment and statefulset specified"))
+	} else if lightrunJavaAgent.Spec.DeploymentName != "" {
+		// Handle Deployment reconciliation (existing code)
+		return r.reconcileDeployment(ctx, lightrunJavaAgent, req.Namespace)
+	} else if lightrunJavaAgent.Spec.StatefulSetName != "" {
+		// Handle StatefulSet reconciliation (to be implemented)
+		return r.reconcileStatefulSet(ctx, lightrunJavaAgent, req.Namespace)
+	} else {
+		log.Error(nil, "Neither DeploymentName nor StatefulSetName is set")
+		return r.errorStatus(ctx, lightrunJavaAgent, errors.New("no workload specified"))
+	}
+}
+
+// reconcileDeployment handles the reconciliation logic for Deployment workloads
+func (r *LightrunJavaAgentReconciler) reconcileDeployment(ctx context.Context, lightrunJavaAgent *agentv1beta.LightrunJavaAgent, namespace string) (ctrl.Result, error) {
+	log := r.Log.WithValues("lightrunJavaAgent", lightrunJavaAgent.Name, "deployment", lightrunJavaAgent.Spec.DeploymentName)
+	fieldManager := "lightrun-conrtoller"
+
 	deplNamespacedObj := client.ObjectKey{
 		Name:      lightrunJavaAgent.Spec.DeploymentName,
-		Namespace: req.Namespace,
+		Namespace: namespace,
 	}
 	originalDeployment := &appsv1.Deployment{}
 	err = r.Get(ctx, deplNamespacedObj, originalDeployment)
@@ -106,7 +128,7 @@ func (r *LightrunJavaAgentReconciler) Reconcile(ctx context.Context, req ctrl.Re
 		log.V(2).Info("Searching for secret", "Name", lightrunJavaAgent.Spec.SecretName)
 		secretNamespacedObj := client.ObjectKey{
 			Name:      lightrunJavaAgent.Spec.SecretName,
-			Namespace: req.Namespace,
+			Namespace: namespace,
 		}
 		secret = &corev1.Secret{}
 		err = r.Get(ctx, secretNamespacedObj, secret)
@@ -289,6 +311,15 @@ func (r *LightrunJavaAgentReconciler) Reconcile(ctx context.Context, req ctrl.Re
 	return r.successStatus(ctx, lightrunJavaAgent, reconcileTypeReady)
 }
 
+// reconcileStatefulSet handles the reconciliation logic for StatefulSet workloads
+func (r *LightrunJavaAgentReconciler) reconcileStatefulSet(ctx context.Context, lightrunJavaAgent *agentv1beta.LightrunJavaAgent, namespace string) (ctrl.Result, error) {
+	log := r.Log.WithValues("lightrunJavaAgent", lightrunJavaAgent.Name, "statefulSet", lightrunJavaAgent.Spec.StatefulSetName)
+
+	// This is a placeholder for Phase 2 implementation
+	log.Info("StatefulSet reconciliation not yet implemented", "StatefulSet", lightrunJavaAgent.Spec.StatefulSetName)
+	return r.errorStatus(ctx, lightrunJavaAgent, errors.New("statefulset reconciliation not yet implemented"))
+}
+
 // SetupWithManager sets up the controller with the Manager.
 func (r *LightrunJavaAgentReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	// Add spec.container_selector.deployment field to cache for future filtering
@@ -310,6 +341,25 @@ func (r *LightrunJavaAgentReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		return err
 	}
 
+	// Add spec.container_selector.statefulset field to cache for future filtering
+	err = mgr.GetFieldIndexer().IndexField(
+		context.Background(),
+		&agentv1beta.LightrunJavaAgent{},
+		statefulSetNameIndexField,
+		func(object client.Object) []string {
+			lightrunJavaAgent := object.(*agentv1beta.LightrunJavaAgent)
+
+			if lightrunJavaAgent.Spec.StatefulSetName == "" {
+				return nil
+			}
+
+			return []string{lightrunJavaAgent.Spec.StatefulSetName}
+		})
+
+	if err != nil {
+		return err
+	}
+
 	// Add spec.container_selector.secret field to cache for future filtering
 	err = mgr.GetFieldIndexer().IndexField(
 		context.Background(),
@@ -336,6 +386,10 @@ func (r *LightrunJavaAgentReconciler) SetupWithManager(mgr ctrl.Manager) error {
 			&appsv1.Deployment{},
 			handler.EnqueueRequestsFromMapFunc(r.mapDeploymentToAgent),
 		).
+		Watches(
+			&appsv1.StatefulSet{},
+			handler.EnqueueRequestsFromMapFunc(r.mapStatefulSetToAgent),
+		).
 		Watches(
 			&corev1.Secret{},
 			handler.EnqueueRequestsFromMapFunc(r.mapSecretToAgent),

internal/controller/lightrunjavaagent_controller_test.go

@@ -643,7 +643,7 @@ var _ = Describe("LightrunJavaAgent controller", func() {
 				if err := k8sClient.Get(ctx, lrAgentRequest2, &lrAgent2); err != nil {
 					return false
 				}
-				return lrAgent2.Status.DeploymentStatus == "Ready"
+				return lrAgent2.Status.WorkloadStatus == "Ready"
 			}).Should(BeTrue())
 		})
 
@@ -678,7 +678,7 @@ var _ = Describe("LightrunJavaAgent controller", func() {
 				if err := k8sClient.Get(ctx, lrAgentRequest3, &lrAgent3); err != nil {
 					return false
 				}
-				return lrAgent3.Status.DeploymentStatus == "ReconcileFailed"
+				return lrAgent3.Status.WorkloadStatus == "ReconcileFailed"
 			}).Should(BeTrue())
 		})
 		It("Should not add finalizer to the duplicate CR", func() {
@@ -774,7 +774,7 @@ var _ = Describe("LightrunJavaAgent controller", func() {
 				if err := k8sClient.Get(ctx, lrAgentRequest4, &lrAgent4); err != nil {
 					return false
 				}
-				return lrAgent4.Status.DeploymentStatus == "" && lrAgent4.Status.Conditions == nil
+				return lrAgent4.Status.WorkloadStatus == "" && lrAgent4.Status.Conditions == nil
 			}).Should(BeTrue())
 		})
 		It("Should not patch the deployment", func() {