Update README.tmpl and values instead of directly updating the README

Signed-off-by: Calvin Audier <[email protected]>
litmuschaos · Mar 5, 2024 · 17f9875 · 17f9875
1 parent e14710d
commit 17f9875
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/charts/litmus-agent/README.md b/charts/litmus-agent/README.md
@@ -45,7 +45,7 @@ $ helm install litmus-agent litmuschaos/litmus-agent \
   --set "LITMUS_BACKEND_URL=http://litmusportal-server-service.litmus.svc.cluster.local:9002" \ # FOR SELF AGENT (SVC)
   --set "LITMUS_USERNAME=admin" \
   --set "LITMUS_PASSWORD=litmus" \
-  --set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c"
+  --set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c" \
   --set "LITMUS_ENVIRONMENT_ID=nameofenvironment"
 ```
 
@@ -59,7 +59,7 @@ $ helm install litmus-agent litmuschaos/litmus-agent \
 | INFRA_NODE_SELECTOR | string | `""` |  |
 | INFRA_TYPE | string | `"external"` |  |
 | LITMUS_BACKEND_URL | string | `""` |  |
-| LITMUS_ENVIRONMENT_ID | string | `""` | `"ID of the environment where the infrastructure will be added"` |
+| LITMUS_ENVIRONMENT_ID | string | `""` | ID of the litmus environment where the infrastructure will be added |
 | LITMUS_PASSWORD | string | `"litmus"` |  |
 | LITMUS_PROJECT_ID | string | `""` |  |
 | LITMUS_URL | string | `"https://my-domain.com"` |  |

diff --git a/charts/litmus-agent/README.md.gotmpl b/charts/litmus-agent/README.md.gotmpl
@@ -20,14 +20,15 @@ To install this chart with the release name `litmus-portal`:
 $ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
 $ helm install litmus-agent litmuschaos/litmus-agent \
   --namespace litmus --create-namespace \
-  --set "AGENT_NAME=helm-agent" \ 
-  --set "AGENT_DESCRIPTION=My first agent deployed with helm !" \
+  --set "INFRA_NAME=helm-agent" \ 
+  --set "INFRA_DESCRIPTION=My first agent deployed with helm !" \
   --set "LITMUS_URL=https://chaos-center.domain.com" \ # FOR REMOTE AGENT (INGRESS)
   --set "LITMUS_URL=http://litmusportal-frontend-service.litmus.svc.cluster.local:9091" \ # FOR SELF AGENT (SVC)
   --set "LITMUS_BACKEND_URL=http://litmusportal-server-service.litmus.svc.cluster.local:9002" \ # FOR SELF AGENT (SVC)
   --set "LITMUS_USERNAME=admin" \
   --set "LITMUS_PASSWORD=litmus" \
-  --set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c"
+  --set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c" \
+  --set "LITMUS_ENVIRONMENT_ID=nameofenvironment"
 ```
 
 {{ template "chart.valuesSection" . }}

diff --git a/charts/litmus-agent/values.yaml b/charts/litmus-agent/values.yaml
@@ -28,6 +28,7 @@ LITMUS_BACKEND_URL: ""
 LITMUS_USERNAME: "admin"
 LITMUS_PASSWORD: "litmus"
 LITMUS_PROJECT_ID: ""
+# -- ID of the litmus environment where the infrastructure will be added
 LITMUS_ENVIRONMENT_ID: ""
 
 image: