docs: added documentation for values.yaml in kube-controller and remo…

…ve component based image configurations (#532)

* docs: added documentation for values.yaml in kube-controller and removed component based image registry configurations

Signed-off-by: VedRatan <[email protected]>

* remove debug file

Signed-off-by: VedRatan <[email protected]>

* chore: bump chart version

Signed-off-by: VedRatan <[email protected]>

* chore: resolved review comments

Signed-off-by: VedRatan <[email protected]>

* remove tmp.yaml

Signed-off-by: VedRatan <[email protected]>

* chore: change priority for default image tag in kubecontroller

Signed-off-by: VedRatan <[email protected]>

* chore: make image tag configuration more readable

Signed-off-by: VedRatan <[email protected]>

* remove: tmp.yaml

Signed-off-by: VedRatan <[email protected]>

---------

Signed-off-by: VedRatan <[email protected]>

charts/nirmata-kube-controller/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.7
+version: 0.1.8
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/nirmata-kube-controller/templates/nirmata-kube-controller.yaml

@@ -409,7 +409,7 @@ spec:
         - name: NO_PROXY
           value: {{ .Values.proxy.noProxy }}
         {{- end }}
-        image: "{{ default .Values.global.imageRegistry .Values.kubeController.imageRegistry}}/{{  default .Values.global.imageRepository .Values.kubeController.imageRepository }}/nirmata-kube-controller:{{ .Chart.AppVersion | default .Values.kubeController.imageTag }}"
+        image: "{{ .Values.global.imageRegistry }}/{{ .Values.global.imageRepository }}/nirmata-kube-controller:{{ .Values.kubeController.imageTag | default .Chart.AppVersion }}"
         imagePullPolicy: Always
         livenessProbe:
           exec:
@@ -511,7 +511,7 @@ spec:
         command:
         - /otelcol
         - --config=/etc/otel/config.yaml
-        image: "{{ default .Values.global.imageRegistry .Values.otelAgent.imageRegistry}}/{{  default .Values.global.imageRepository .Values.otelAgent.imageRepository }}/opentelemetry-collector:{{ .Values.otelAgent.imageTag }}"
+        image: "{{ .Values.global.imageRegistry }}/{{ .Values.global.imageRepository }}/opentelemetry-collector:{{ .Values.otelAgent.imageTag }}"
         resources:
           limits:
             memory: 512Mi

charts/nirmata-kube-controller/values.yaml

@@ -2,42 +2,80 @@
 # # This is a YAML-formatted file.
 # # Declare variables to be passed into your templates.
 
+# Specifies the WebSocket URL for connecting to the Nirmata service.
 nirmataURL: "wss://nirmata.io/tunnels"
+
+# Defines the Kubernetes namespace where the Nirmata components will be deployed.
 namespace: "nirmata"
+
+#  Contains global configuration settings that is applied across different components.
 global:
+  # The container registry from which images will be pulled.
+  # Replace with your desired container registry.
   imageRegistry: ghcr.io
+  # The repository from which images will be pulled.
+  # Replace with your desired container repository.
   imageRepository: nirmata
+  # Credentials for the private container registry (if required).
   registryUserName:
   registryPassword:
 
-kubeController:
-  imageRegistry:
-  imageRepository:
-  imageTag:
-
+# otelAgent contains configuration for the nirmata otel agent, which is used for observability and monitoring.
 otelAgent:
-  imageRegistry:
-  imageRepository:
+  # imageTag is the tag or version of the otel-agent image.
   imageTag: "0.92.0"
-# cluster name is required
+
+# kubeController contains configuration for the nirmata-kube-controller.
+kubeController:
+  # imageTag is the tag or version of the nirmata-kube-controller image. If added, it will override the  .Chart.AppVersion
+  imageTag: ""
+
+
+# cluster contains configuration related to the Kubernetes cluster which is being onboarded to NCH.
 cluster:
+# name used for cluster by nch (Default: kubesystem namespace ID)
   name: ""
+
+# type of the cluster categorised by nch. (Default value is "default-policy-manager-type")
   type: default-policy-manager-type
-  labels:
-    # key: value
-    # key2: value2
 
+# labels is a set of key-value pairs that can be used to label the cluster while onboarding the cluster to Nirmata Control Hub.
+# These labels are passed as command-line arguments to the Nirmata Kubernetes controller in the deployment.
+# Example:
+# labels:
+#   key1: value1
+#   key2: value2
+#
+# When set, the labels are reflected in the Helm template as follows:
+# In the `deployment.yaml`:
+#       - "-cluster-labels"
+#       - "key1:value1"
+#       - "-cluster-labels"
+#       - "key2:value2"
+  labels: {}
+
+# api token is just for registering the cluster to Nirmata Control Hub.
+# This token is required for the nirmata-kube-controller to communicate with the Nirmata Control Hub. (Required)
 apiToken: ""
 
+# features enables or disables specific features while installing kube-controller.
 features:
+# to provide additional write permissions to deploy policy-exceptions.
   policyExceptions:
     enabled: false
+# to provide additional write permissions to deploy policy-sets.
   policySets:
     enabled: false
 
+# readWriteMode determines whether the nirmata-kube-controller operates in read-write mode or read-only mode.
+# When set to `true`, the controller can make changes to the CR. When `false`, it operates in a read-only manner.
 readWriteMode: false
 
+# proxy contains configuration for proxy settings if the KubeController needs to communicate through a proxy.
 proxy:
+ # httpProxy is the HTTP proxy URL.
   httpProxy: ""
+ # httpsProxy is the HTTPS proxy URL.
   httpsProxy: ""
+ # noProxy is a comma-separated list of domains or IP addresses that should bypass the proxy.
   noProxy: ""