DEVOPS-2689-extend-k-8-s-operator-support-to-include-stateful-sets #43

imeliran · 2025-04-29T14:21:42Z

No description provided.

… of the file.

…istency

…yaml

…atible

…mentStatus' for clarity in reconciliation status

…ller.go for improved clarity and maintainability

…go to handle Deployment and StatefulSet

…in helpers.go for consistency with recent changes

…adName and WorkloadType fields, replacing legacy DeploymentName usage. Update indexers and error handling for improved clarity and maintainability.

…oad status and field names, replacing DeploymentStatus with WorkloadStatus and updating related assertions for consistency with recent refactorings.

…ted example StatefulSet YAML files for LightrunJavaAgent.

…eferences with Workload and WorkloadType, enhancing clarity and consistency in the LightrunJavaAgent configuration.

… WorkloadName field description to specify that it can refer to either Deployment or StatefulSet, improving understanding for users.

…pecify that it can refer to either Deployment or StatefulSet, enhancing documentation consistency across the LightrunJavaAgent configuration.

…e and statefulSetName with workloadName and workloadType, enhancing clarity and consistency in documentation. Adjust related documentation to reflect these changes and improve user understanding.

…umentation to recommend using WorkloadName and WorkloadType instead for improved clarity and consistency.

…es, updating documentation to recommend using WorkloadName and WorkloadType instead for improved clarity and consistency.

…f the file to ensure proper rendering and adherence to markdown standards.

api/v1beta/lightrunjavaagent_types.go

moshiko-s · 2025-05-18T08:55:42Z

internal/controller/helpers.go


-	var lightrunJavaAgentList agentv1beta.LightrunJavaAgentList
+	// Combine results
+	agents.Items = append(agents.Items, newAgents.Items...)


is it possible that someone creates a new Custom resource with workloadName and Type and leave the old CR and it will cause issues?

for instance:

deployment: example-deploment

workload cr: example-workload-cr

deployment cr: example-deployment-cr

both workload cr and deployment cr are trying to patch example-deploment . one out of them will succeed to patch and other will throw ReconcileFailed with error deployment already patched:

internal/controller/helpers.go

moshiko-s · 2025-05-18T09:18:44Z

internal/controller/lightrunjavaagent_controller.go

+	}
+}
+
+func (r *LightrunJavaAgentReconciler) determineWorkloadType(lightrunJavaAgent *agentv1beta.LightrunJavaAgent) (agentv1beta.WorkloadType, error) {


IMO, we should support 2 configurations:

deploymentName is set

workloadName and Type are set
if both are set you fail return an error.

if deploymentName is set you should log a warning that it's deprecated in favor of workloadName and workloadType.

If we agree you can add:
var isDeploymentConfigured bool = spec.DeploymentName != "";
var isWorkloadConfigured bool = spec.WorkloadName != "" || spec.WorkloadType != "";

if both are true/false you return an error.

moshiko-s · 2025-05-18T09:22:57Z

internal/controller/lightrunjavaagent_controller.go

+		return spec.WorkloadType, nil
+	}
+
+	// === Case 3: Misconfigured — Both names are set ===


redundant case IMO, see comment above

moshiko-s · 2025-05-18T09:25:51Z

internal/controller/lightrunjavaagent_controller.go

+		// Fall back to legacy field if WorkloadName isn't set
+		deploymentName = lightrunJavaAgent.Spec.DeploymentName
+	}
+


let's add check if deploymentName is empty and return a specialized error

moshiko-s · 2025-05-18T09:27:26Z

internal/controller/lightrunjavaagent_controller.go

+
+// 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.WorkloadName)


let's add a check if workloadName is empty

…ileStatefulSet functions to improve error handling.

moshiko-s · 2025-05-20T19:22:09Z

api/v1beta/lightrunjavaagent_types.go

 }

 //+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=""


let's remove this column 😬 and see if we can fill the "Workload" column with deploymenName if using it

As agreed we will remove this column completely

moshiko-s · 2025-05-20T19:23:33Z

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

@@ -17,6 +17,10 @@ spec:
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
+    - description: Deployment name


why do we need this?

moshiko-s · 2025-05-20T19:23:35Z

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

@@ -211,6 +215,8 @@ spec:
                  - type
                  type: object
                type: array
+              deploymentStatus:


why do we need this?

it is generated by kubebuilder according to

type LightrunJavaAgentStatus struct { LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty"` Conditions []metav1.Condition `json:"conditions,omitempty"` WorkloadStatus string `json:"workloadStatus,omitempty"` DeploymentStatus string `json:"deploymentStatus,omitempty"` }

we need to keep DeploymentStatus so we will be able to update Status field accordingly

internal/controller/lightrunjavaagent_controller.go

moshiko-s · 2025-05-20T19:33:19Z

internal/controller/lightrunjavaagent_controller.go

@@ -86,31 +86,30 @@ func (r *LightrunJavaAgentReconciler) Reconcile(ctx context.Context, req ctrl.Re

 func (r *LightrunJavaAgentReconciler) determineWorkloadType(lightrunJavaAgent *agentv1beta.LightrunJavaAgent) (agentv1beta.WorkloadType, error) {
 	spec := lightrunJavaAgent.Spec
+	// Check which configuration approach is being used
+	var isDeploymentConfigured bool = spec.DeploymentName != ""
+	var isWorkloadConfigured bool = spec.WorkloadName != "" || spec.WorkloadType != ""


should be &&

moshiko-s · 2025-05-20T19:34:59Z

internal/controller/lightrunjavaagent_controller.go


 	// === Case 1: Legacy only — DeploymentName only ===
-	if spec.DeploymentName != "" && spec.WorkloadName == "" && spec.WorkloadType == "" {
+	if isDeploymentConfigured && !isWorkloadConfigured {


based on previous suggestion you can simplify to:
if isDeploymentConfigured

moshiko-s · 2025-05-20T19:37:38Z

internal/controller/lightrunjavaagent_controller.go

 		return agentv1beta.WorkloadTypeDeployment, nil
 	}

 	// === Case 2: New fields — WorkloadName + WorkloadType ===
-	if spec.DeploymentName == "" && spec.WorkloadName != "" {
+	if !isDeploymentConfigured && isWorkloadConfigured {


based on previous suggestion you can remove the condition here and assume isWorkloadConfigured

internal/controller/lightrunjavaagent_controller.go

…t functions by including workload names for better debugging clarity.

…Status to streamline CRD definitions and enhance clarity.

…CRDs and example configurations to enhance clarity and maintain consistency across definitions.

… new configuration validation for deploymentName and workloadName, enhancing clarity in failure conditions.

…dation for LightrunJavaAgent. Enhance error handling by ensuring only one configuration method (legacy or new) is used, and provide clearer error messages for invalid configurations.

…etermination for LightrunJavaAgent. Simplify logic by removing unnecessary checks and enhancing clarity in configuration handling.

eliranb added 13 commits April 29, 2025 12:49

Phase 1: CRD and Initial Structure

65d209c

Phase 1: update chart and config examples

e9b798a

Phase 2: StatefulSet Implementation

f343dcc

Update documentation with statefulset

9bff8c2

Phase 3: Testing

f000a8e

Fix formatting in lightrun-secret.yaml by adding a newline at the end…

4f3ebf2

… of the file.

Add newline at the end of statefulset-lightrunjavaagent.yaml for cons…

0ee5505

…istency

Remove redundant memory option from JAVA_TOOL_OPTIONS in statefulset.…

2cf6070

…yaml

Remove trailing whitespace in statefulset-lightrunjavaagent.yaml

585ac87

Revert WorkloadStatus field to DeploymentStatus to keep backward comp…

dc55550

…atible

removing TODO comment regarding DeploymentStatus field

de2ba95

Update CRD and example files to replace 'WorkloadStatus' with 'Deploy…

1d5c1f2

…mentStatus' for clarity in reconciliation status

Refactor config map data hash calculation in lightrunjavaagent_contro…

191419b

…ller.go for improved clarity and maintainability

imeliran requested a review from moshiko-s May 4, 2025 14:52

eliranb added 3 commits May 13, 2025 15:05

Add WorkloadType and WorkloadName support in lightrunjavaagent_types.…

9115f02

…go to handle Deployment and StatefulSet

Update instance status field from DeploymentStatus to WorkloadStatus …

124b19f

…in helpers.go for consistency with recent changes

Refactor LightrunJavaAgent reconciliation logic to support new Worklo…

21978cb

…adName and WorkloadType fields, replacing legacy DeploymentName usage. Update indexers and error handling for improved clarity and maintainability.

moshiko-s removed their request for review May 14, 2025 06:20

eliranb added 9 commits May 14, 2025 11:40

Update LightrunJavaAgent controller tests to reflect changes in workl…

a104886

…oad status and field names, replacing DeploymentStatus with WorkloadStatus and updating related assertions for consistency with recent refactorings.

Update .gitignore to include macOS .DS_Store files and remove depreca…

4a18f67

…ted example StatefulSet YAML files for LightrunJavaAgent.

Update CRDs and example files to replace Deployment and StatefulSet r…

b8d4a04

…eferences with Workload and WorkloadType, enhancing clarity and consistency in the LightrunJavaAgent configuration.

Enhance documentation in lightrunjavaagent_types.go by clarifying the…

2df1dbc

… WorkloadName field description to specify that it can refer to either Deployment or StatefulSet, improving understanding for users.

Clarify workloadName field description in CRDs and example files to s…

56e5f55

…pecify that it can refer to either Deployment or StatefulSet, enhancing documentation consistency across the LightrunJavaAgent configuration.

Update LightrunJavaAgent configuration files to replace deploymentNam…

05c6fb9

…e and statefulSetName with workloadName and workloadType, enhancing clarity and consistency in documentation. Adjust related documentation to reflect these changes and improve user understanding.

Deprecate DeploymentName field in LightrunJavaAgentSpec, updating doc…

44ed3c3

…umentation to recommend using WorkloadName and WorkloadType instead for improved clarity and consistency.

Deprecate deploymentName field in LightrunJavaAgent configuration fil…

924923b

…es, updating documentation to recommend using WorkloadName and WorkloadType instead for improved clarity and consistency.

Fix formatting in custom_resource.md by adding a newline at the end o…

8c1ad6e

…f the file to ensure proper rendering and adherence to markdown standards.

imeliran requested a review from moshiko-s May 14, 2025 12:30

moshiko-s reviewed May 18, 2025

View reviewed changes

keep deploymetStatus for bc

bb8334d

eliranb added 3 commits May 20, 2025 11:11

simplify determineWorkloadType function per PR's feedback

a712847

add checks for missing workloadName in reconcileDeployment and reconc…

5e1b54d

…ileStatefulSet functions to improve error handling.

update crds

b948101

imeliran requested a review from moshiko-s May 20, 2025 08:30

moshiko-s reviewed May 20, 2025

View reviewed changes

eliranb added 6 commits May 21, 2025 11:06

Improve error messages in reconcileDeployment and reconcileStatefulSe…

52c042c

…t functions by including workload names for better debugging clarity.

Remove deprecated printcolumn for deploymentName in LightrunJavaAgent…

d462f06

…Status to streamline CRD definitions and enhance clarity.

Remove deprecated deploymentName print column from LightrunJavaAgent …

1af59a3

…CRDs and example configurations to enhance clarity and maintain consistency across definitions.

Update error message in LightrunJavaAgent controller tests to reflect…

33831b3

… new configuration validation for deploymentName and workloadName, enhancing clarity in failure conditions.

Refactor determineWorkloadType function to improve configuration vali…

22505e3

…dation for LightrunJavaAgent. Enhance error handling by ensuring only one configuration method (legacy or new) is used, and provide clearer error messages for invalid configurations.

Refactor determineWorkloadType function to streamline workload type d…

2a68b3b

…etermination for LightrunJavaAgent. Simplify logic by removing unnecessary checks and enhancing clarity in configuration handling.

moshiko-s approved these changes May 22, 2025

View reviewed changes

imeliran merged commit 2be38da into main May 22, 2025
2 checks passed

imeliran deleted the DEVOPS-2689-extend-k-8-s-operator-support-to-include-stateful-sets branch May 22, 2025 11:26

DEVOPS-2689-extend-k-8-s-operator-support-to-include-stateful-sets #43

DEVOPS-2689-extend-k-8-s-operator-support-to-include-stateful-sets #43

Uh oh!

Conversation

imeliran commented Apr 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imeliran May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imeliran May 21, 2025 •

edited

Loading