diff --git a/code-examples/helm-kafka-example/README.md b/code-examples/helm-kafka-example/README.md index a34bf1958..1cc731ac2 100644 --- a/code-examples/helm-kafka-example/README.md +++ b/code-examples/helm-kafka-example/README.md @@ -33,10 +33,36 @@ $ oc apply -f ./rhoas-secrets.yaml $ oc apply -f ./rhoas-services.yaml ``` -5. Deploy the helm chart setting 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 + + + +There are various ways to provide values: + +* The default method is specifying values in the `values.yaml` file. An example is shown below: + ``` -$ helm install . --generate-name --set-string rhoas.config=,rhoas.secret= +## 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 + ``` +* Passing values directly 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