Update documentation

interuss · Nov 17, 2023 · 67c5a41 · 67c5a41
1 parent 7da7b3e
commit 67c5a41
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/deploy/services/helm-charts/dss/README.md b/deploy/services/helm-charts/dss/README.md
@@ -8,15 +8,16 @@ Requirements and instructions to create a new Kubernetes cluster can be found [h
 3. Install [Helm](https://helm.sh/) version 3.11.3 or higher
 
 ## Usage
-1. Edit `values.example.yaml`. See `values.schema.json` for schema definition. (Note that the key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration))
-2. Validate the configuration: `helm lint -f values.example.yaml .`
+1. Copy `values.example.yaml` to `values.dev.yaml` and edit it. See `values.schema.json` for schema definition. (Note that the key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)).
+Note that values.yaml contains the default values and are always passed to helm.
+2. Validate the configuration: `helm lint -f values.dev.yaml .`
 3. Set a RELEASE_NAME to `dss`: `export RELEASE_NAME=dss`
 It is temporarily the only release name possible.
 4. Set the kube client context of your , example: `export KUBE_CONTEXT=gke_interuss-deploy-example_europe-west6-a_dss-dev-w6`
 5. Run `helm dep update --kube-context=$KUBE_CONTEXT`
-6. Install the chart: `helm install --kube-context=$KUBE_CONTEXT -f values.example.yaml $RELEASE_NAME .`
+6. Install the chart: `helm install --kube-context=$KUBE_CONTEXT -f values.dev.yaml $RELEASE_NAME .`
 
 ### Update the chart
-When changing the values in values.example.yaml, values.yaml, the templates or upgrading the helm chart dependencies, changes can be applied to the cluster using the following command:
+When changing the values in values.dev.yaml, values.yaml, the templates or upgrading the helm chart dependencies, changes can be applied to the cluster using the following command:
 
-1. Run `helm upgrade --kube-context=$KUBE_CONTEXT -f values.example.yaml $RELEASE_NAME .`
+1. Run `helm upgrade --kube-context=$KUBE_CONTEXT -f values.dev.yaml $RELEASE_NAME .`