update docs and comments (#7)

* update docs and comments
* update test data according to example deployment

Author: Leonid Podolinskiy

.github/workflows/e2e.yaml

@@ -128,7 +128,7 @@ jobs:
         printf "Install helm chart\n"
         helm install -n lightrun-k8s-operator lightrun-k8s-operator ./helm-chart -f .github/workflows/tests_data/chart_values.yaml
 
-        kubectl wait deployment  app --for condition=Available=True --timeout=90s
+        kubectl wait deployment  sample-deployment --for condition=Available=True --timeout=90s
         
         kubectl get deployments -n lightrun-k8s-operator
         kubectl get pods -n lightrun-k8s-operator
@@ -137,7 +137,7 @@ jobs:
         
         
         kubectl apply -f .github/workflows/tests_data/lightrunjavaagent.yaml 
-        kubectl wait deployment  app --for condition=Available=True --timeout=90s
+        kubectl wait deployment  sample-deployment  --for condition=Available=True --timeout=90s
 
         
         printf "Wait 1 minute\n"
@@ -149,13 +149,13 @@ jobs:
 
 
         printf "\n\nAgent INFO log\n"
-        kubectl exec -t deploy/app -c app -- cat /tmp/lightrun_java_agent.INFO
+        kubectl exec -t deploy/sample-deployment  -c app -- cat /tmp/lightrun_java_agent.INFO
         printf "\n\nAgent ERROR log\n"
-        kubectl exec -t deploy/app -c app -- cat /tmp/lightrun_java_agent.ERROR || true
+        kubectl exec -t deploy/sample-deployment  -c app -- cat /tmp/lightrun_java_agent.ERROR || true
 
 
         printf "\nSearching for "registered" in INFO log\n"
-        if kubectl exec -t deploy/app -c app -- cat /tmp/lightrun_java_agent.INFO | grep Debuggee |grep registered > /dev/null; then
+        if kubectl exec -t deploy/sample-deployment  -c app -- cat /tmp/lightrun_java_agent.INFO | grep Debuggee |grep registered > /dev/null; then
           printf "\n----------------\nAgent registered succesfully!\n----------------\n"
         else
           printf "\n----------------\nAgent failed to register!\n----------------\n"
@@ -186,7 +186,7 @@ jobs:
         kubectl apply -f .github/workflows/tests_data/lightrunjavaagent.yaml 
 
         sleep 5 
-        kubectl describe deployment app
+        kubectl describe deployment sample-deployment 
 
         printf "Controller logs\n\n\n"
         kubectl logs --tail=500 -l control-plane=controller-manager -n lightrun-k8s-operator

.github/workflows/tests_data/lightrunjavaagent.yaml

@@ -7,7 +7,7 @@ spec:
     image: "lightruncom/k8s-operator-init-java-agent-linux:1.8.5-init.1"
     sharedVolumeName: lightrun-agent-init
     sharedVolumeMountPath: "/lightrun"
-  deploymentName: app  
+  deploymentName: sample-deployment  
   secretName: lightrun-secrets 
   serverHostname: dogfood.internal.lightrun.com
   agentEnvVarName: JAVA_TOOL_OPTIONS

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

@@ -125,8 +125,8 @@ spec:
                   description: "Condition contains details for one aspect of the current
                     state of this API Resource. --- This struct is intended for direct
                     use as an array at the field path .status.conditions.  For example,
-                    type FooStatus struct{ // Represents the observations of a foo's
-                    current state. // Known .status.conditions.type are: \"Available\",
+                    \n type FooStatus struct{ // Represents the observations of a
+                    foo's current state. // Known .status.conditions.type are: \"Available\",
                     \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
                     // +listType=map // +listMapKey=type Conditions []metav1.Condition
                     `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"

config/samples/operator.yaml

@@ -131,8 +131,8 @@ spec:
                   description: "Condition contains details for one aspect of the current
                     state of this API Resource. --- This struct is intended for direct
                     use as an array at the field path .status.conditions.  For example,
-                    type FooStatus struct{ // Represents the observations of a foo's
-                    current state. // Known .status.conditions.type are: \"Available\",
+                    \n type FooStatus struct{ // Represents the observations of a
+                    foo's current state. // Known .status.conditions.type are: \"Available\",
                     \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
                     // +listType=map // +listMapKey=type Conditions []metav1.Condition
                     `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"

controllers/lightrunjavaagent_controller_test.go

@@ -572,6 +572,15 @@ var _ = Describe("LightrunJavaAgent controller", func() {
 			Expect(k8sClient.Create(ctx, &depl)).Should(Succeed())
 		})
 
+		It("Should have successful status of existing CR", func() {
+			Eventually(func() bool {
+				if err := k8sClient.Get(ctx, lrAgentRequest2, &lrAgent2); err != nil {
+					return false
+				}
+				return lrAgent2.Status.DeploymentStatus == "Ready"
+			}).Should(BeTrue())
+		})
+
 		It("prepare new CR with patched deployment", func() {
 			By("Creating new CR")
 			lrAgent3 := agentsv1beta.LightrunJavaAgent{

docs/README.md

@@ -46,6 +46,8 @@ To set up the Lightrun K8s operator:
 kubectl create namespace lightrun-operator
 kubectl create namespace lightrun-agent-test
 ```
+_`lightrun-operator` namespace is hardcoded in the example `operator.yaml` due to Role and RoleBinding objects_
+_If you want to deploy operator to a different namespace - you can use helm chart_
 
 2. Deploy operator to the operator namesapce
 ```sh

examples/deployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: app
+  name: sample-deployment
   labels:
     app: app
 spec:

examples/lightrunjavaagent.yaml

@@ -3,38 +3,49 @@ kind: LightrunJavaAgent
 metadata:
   name: example-cr 
 spec:
+  ###############################################################################################
+  # Fields that you need to change if you want to try operator with your own deployment
+  ###############################################################################################
+  # Name of the deployment that you are going to patch.
+  # Has to be in the same namespace
+  deploymentName: sample-deployment 
+  # List of container names inside the pod of the deployment
+  # If container not mentioned here it will be not patched
+  containerSelector:
+    - app 
+  # Agent config will override  default configuration with provided values
+  # You can find list of available options here https://docs.lightrun.com/jvm/agent-configuration/
+  agentEnvVarName: JAVA_TOOL_OPTIONS
+  # Name of the secret where agent will take `lightrun_key` and `pinned_cert_hash` from
+  # Has to be in the same namespace
+  secretName: lightrun-secrets 
+
+
+  ###############################################################################################
+  # Fields that are mostly fine with default values for most deployments
+  ###############################################################################################
   # Init container with agent. Differes by agent version and platform that it will be used for. For now supported platforms are `linux` and `alpine`  
   initContainer:  
     # parts that may vary here are 
     # platform - `linux/alpine`
     # agent version - first part of the tag (1.7.0)
     # init container sub-version - last part of the tag (init.0)
-    image: "lightruncom/k8s-operator-init-java-agent-linux:1.8.3-init.0"
+    image: "lightruncom/k8s-operator-init-java-agent-linux:1.8.5-init.1"
     # Volume name in case you have some convention in the names
     sharedVolumeName: lightrun-agent-init
     # Mount path where volume will be parked. Various distributions may have it's limitations.
     # For example you can't mount volumes to any path except `/tmp` when using AWS Fargate
     sharedVolumeMountPath: "/lightrun"
-  # Name of the deployment that you are going to patch.
-  # Has to be in the same namespace
-  deploymentName: app  
-  # Name of the secret where agent will take `lightrun_key` and `pinned_cert_hash` from
-  # Has to be in the same namespace
-  secretName: lightrun-secrets 
   # Hostname of the server. Will be different for on-prem ans single-tenant installations
-  # For saas it will be app.lightrun.com
-  serverHostname: <lightrun_server>  
+  # For saas it is app.lightrun.com
+  serverHostname:  app.lightrun.com
   # Env var that will be patched with agent path.
   # If your application not using any, recommended option is to use "JAVA_TOOL_OPTIONS"
   # Also may be "_JAVA_OPTIONS", "JAVA_OPTS"
   # There are also different variations if using Maven -  "MAVEN_OPTS", and so on
   # You can find more info here: https://docs.lightrun.com/jvm/agent/
-  agentEnvVarName: JAVA_TOOL_OPTIONS
-  # Agent config will override  default configuration with provided values
-  # You can find list of available options here https://docs.lightrun.com/jvm/agent-configuration/
   agentConfig:
     max_log_cpu_cost: "2"
-
   # agentCliFlags is used if need to pass additional flags to the agent,
   # that are not part of configuration file. 
   # https://docs.lightrun.com/jvm/agent-configuration/#additional-command-line-flags
@@ -45,13 +56,10 @@ spec:
   agentTags:
     - operator
     - example
-    - 1.8.3
+    - 1.8.5
   # Agent name. If not provided, pod name will be used
   #agentName: "operator-test-agent"
-  # List of container names inside the pod of the deployment
-  # If container not mentioned here it will be not patched
-  containerSelector:
-    - app
+
 ---
 apiVersion: v1
 metadata: 

examples/operator.yaml

@@ -126,8 +126,8 @@ spec:
                   description: "Condition contains details for one aspect of the current
                     state of this API Resource. --- This struct is intended for direct
                     use as an array at the field path .status.conditions.  For example,
-                    type FooStatus struct{ // Represents the observations of a foo's
-                    current state. // Known .status.conditions.type are: \"Available\",
+                    \n type FooStatus struct{ // Represents the observations of a
+                    foo's current state. // Known .status.conditions.type are: \"Available\",
                     \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
                     // +listType=map // +listMapKey=type Conditions []metav1.Condition
                     `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"

helm-chart/Chart.yaml

@@ -36,31 +36,22 @@ annotations:
       metadata:
         name: example-cr 
       spec:
+        deploymentName: sample-deployment
+        containerSelector:
+          - app
+        secretName: lightrun-secrets 
+        serverHostname: app.lightrun.com
+        agentEnvVarName: JAVA_TOOL_OPTIONS
         initContainer:  
           image: "lightruncom/k8s-operator-init-java-agent-linux:1.8.5-init.1"
           sharedVolumeName: lightrun-agent-init
           sharedVolumeMountPath: "/lightrun"
-        deploymentName: app  
-        secretName: lightrun-secrets 
-        serverHostname: app.lightrun.com
-        agentEnvVarName: JAVA_TOOL_OPTIONS
-        agentConfig:
-          max_log_cpu_cost: "2"
         agentTags:
           - operator
           - example
           - 1.8.3
-        containerSelector:
-          - app
-      ---
-      apiVersion: v1
-      metadata: 
-        name: lightrun-secrets
-      stringData:
-        lightrun_key: <lightrun_key_from_ui>
-        pinned_cert_hash: <pinned_cert_hash>
-      kind: Secret
-      type: Opaque
+
+
 
   artifacthub.io/license: Apache-2.0
   artifacthub.io/links: |