Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README of helm-example #591

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions code-examples/helm-kafka-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this a bullet list:

* `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=<configmap-name>,rhoas.secret=<secret-name>
## 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/).