From d2c9bbf4a3343a9d8f3ddd27faae73da654d0049 Mon Sep 17 00:00:00 2001 From: Ramakrishna Pattnaik Date: Tue, 11 Oct 2022 12:09:05 +0530 Subject: [PATCH 1/2] docs: update README of helm-example --- code-examples/helm-kafka-example/README.md | 28 ++++++++++++++++++---- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/code-examples/helm-kafka-example/README.md b/code-examples/helm-kafka-example/README.md index a34bf1958..091aad607 100644 --- a/code-examples/helm-kafka-example/README.md +++ b/code-examples/helm-kafka-example/README.md @@ -33,10 +33,28 @@ $ oc apply -f ./rhoas-secrets.yaml $ oc apply -f ./rhoas-services.yaml ``` -5. Deploy the helm chart setting the appropriate values: - -``` -$ helm install . --generate-name --set-string rhoas.config=,rhoas.secret= -``` +5. Deploy the helm chart with the appropriate values: + +`helm install` command is used to install a chart to the OpenShift cluster. +`Values` is a built-in object that provides access to values passed in the chart. + +The Helm chart uses the follwing values in the templates: + +`rhoas.config` - Name of the ConfigMap object containing configurations deployed in the OpenShift cluster +`rhoas.secret` - Name of the Secret object containing service-account credentials deployed in the OpenShift cluster + + + +There are various ways to provide values: + + 1. The default method is specifying values in the `values.yaml` file. + 2. Specifying a yaml file with defined values using the `--values` flag: + ``` + helm install . --generate-name --values my-values.yaml + ``` + 3. Passing values from the command line using the `--set-string` flag: + ``` + helm install . --generate-name --set-string rhoas.config=my-context-3-configuration + ``` To see how to use this code example follow the [guide](../../docs/rhoas/rhoas-helm-guide/). \ No newline at end of file From c9ec9533301683a63d86f745f1d7e122628b61ce Mon Sep 17 00:00:00 2001 From: Ramakrishna Pattnaik Date: Fri, 14 Oct 2022 12:54:12 +0530 Subject: [PATCH 2/2] fix: address review comments --- code-examples/helm-kafka-example/README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/code-examples/helm-kafka-example/README.md b/code-examples/helm-kafka-example/README.md index 091aad607..1cc731ac2 100644 --- a/code-examples/helm-kafka-example/README.md +++ b/code-examples/helm-kafka-example/README.md @@ -33,26 +33,34 @@ $ oc apply -f ./rhoas-secrets.yaml $ oc apply -f ./rhoas-services.yaml ``` -5. Deploy the helm chart with the appropriate values: +5. Deploy the Helm chart with the appropriate values: `helm install` command is used to install a chart to the OpenShift cluster. `Values` is a built-in object that provides access to values passed in the chart. The Helm chart uses the follwing values in the templates: -`rhoas.config` - Name of the ConfigMap object containing configurations deployed in the OpenShift cluster -`rhoas.secret` - Name of the Secret object containing service-account credentials deployed in the OpenShift cluster +* `rhoas.config` - Name of the ConfigMap object containing configurations deployed in the OpenShift cluster +* `rhoas.secret` - Name of the Secret object containing service-account credentials deployed in the OpenShift cluster There are various ways to provide values: - 1. The default method is specifying values in the `values.yaml` file. - 2. Specifying a yaml file with defined values using the `--values` flag: +* The default method is specifying values in the `values.yaml` file. An example is shown below: + +``` +## Example values.yaml file +rhoas: + config: my-service-context-configuration + secret: service-account-credentials +``` + +* Specifying a YAML file of another name using the the --values flag: ``` helm install . --generate-name --values my-values.yaml ``` - 3. Passing values from the command line using the `--set-string` flag: +* Passing values directly from the command line using the `--set-string` flag: ``` helm install . --generate-name --set-string rhoas.config=my-context-3-configuration ```