Skip to content

Commit 17f9875

Browse files
committed
Update README.tmpl and values instead of directly updating the README
Signed-off-by: Calvin Audier <calvinaudier@gmail.com>
1 parent e14710d commit 17f9875

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

charts/litmus-agent/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $ helm install litmus-agent litmuschaos/litmus-agent \
4545
--set "LITMUS_BACKEND_URL=http://litmusportal-server-service.litmus.svc.cluster.local:9002" \ # FOR SELF AGENT (SVC)
4646
--set "LITMUS_USERNAME=admin" \
4747
--set "LITMUS_PASSWORD=litmus" \
48-
--set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c"
48+
--set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c" \
4949
--set "LITMUS_ENVIRONMENT_ID=nameofenvironment"
5050
```
5151

@@ -59,7 +59,7 @@ $ helm install litmus-agent litmuschaos/litmus-agent \
5959
| INFRA_NODE_SELECTOR | string | `""` | |
6060
| INFRA_TYPE | string | `"external"` | |
6161
| LITMUS_BACKEND_URL | string | `""` | |
62-
| LITMUS_ENVIRONMENT_ID | string | `""` | `"ID of the environment where the infrastructure will be added"` |
62+
| LITMUS_ENVIRONMENT_ID | string | `""` | ID of the litmus environment where the infrastructure will be added |
6363
| LITMUS_PASSWORD | string | `"litmus"` | |
6464
| LITMUS_PROJECT_ID | string | `""` | |
6565
| LITMUS_URL | string | `"https://my-domain.com"` | |

charts/litmus-agent/README.md.gotmpl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@ To install this chart with the release name `litmus-portal`:
2020
$ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
2121
$ helm install litmus-agent litmuschaos/litmus-agent \
2222
--namespace litmus --create-namespace \
23-
--set "AGENT_NAME=helm-agent" \
24-
--set "AGENT_DESCRIPTION=My first agent deployed with helm !" \
23+
--set "INFRA_NAME=helm-agent" \
24+
--set "INFRA_DESCRIPTION=My first agent deployed with helm !" \
2525
--set "LITMUS_URL=https://chaos-center.domain.com" \ # FOR REMOTE AGENT (INGRESS)
2626
--set "LITMUS_URL=http://litmusportal-frontend-service.litmus.svc.cluster.local:9091" \ # FOR SELF AGENT (SVC)
2727
--set "LITMUS_BACKEND_URL=http://litmusportal-server-service.litmus.svc.cluster.local:9002" \ # FOR SELF AGENT (SVC)
2828
--set "LITMUS_USERNAME=admin" \
2929
--set "LITMUS_PASSWORD=litmus" \
30-
--set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c"
30+
--set "LITMUS_PROJECT_ID=69395cb3-0231-4262-8990-78056c8adb4c" \
31+
--set "LITMUS_ENVIRONMENT_ID=nameofenvironment"
3132
```
3233

3334
{{ template "chart.valuesSection" . }}

charts/litmus-agent/values.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ LITMUS_BACKEND_URL: ""
2828
LITMUS_USERNAME: "admin"
2929
LITMUS_PASSWORD: "litmus"
3030
LITMUS_PROJECT_ID: ""
31+
# -- ID of the litmus environment where the infrastructure will be added
3132
LITMUS_ENVIRONMENT_ID: ""
3233

3334
image:

0 commit comments

Comments
 (0)