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.

Sign up for GitHub

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

docs: update README of helm-example #591

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2c9bbf
docs: update README of helm-example
rkpattnaik780 Oct 11, 2022
c9ec953
fix: address review comments
rkpattnaik780 Oct 14, 2022
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
28 changes: 23 additions & 5 deletions code-examples/helm-kafka-example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<configmap-name>,rhoas.secret=<secret-name>
```
5. Deploy the helm chart with the appropriate values:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It made more sense to include more details in the step itself rather than having a separate sub-heading for it. Let me know if you feel if it should be moved to a higher level @jbyrne-redhat

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, that makes sense to me!

Copy link
Contributor

Choose a reason for hiding this comment

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

Deploy the Helm chart.... (capitalize Helm)


`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:

1. The default method is specifying values in the `values.yaml` file.
Copy link
Contributor

Choose a reason for hiding this comment

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

A couple of comments:

  • Make this a bullet list (*) rather than a numbered list
  • After the first item, maybe show an example of the values.yaml file you configured?

So, putting that all together:

* The default method is specifying values in a YAML file called `values.yaml`. An example is shown below.

## Example values.yaml file
rhoas: 
   config: my-service-context-configuration
   secret: service-account-credentials

2. Specifying a yaml file with defined values using the `--values` flag:
Copy link
Contributor

@jbyrne-redhat jbyrne-redhat Oct 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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:
Copy link
Contributor

Choose a reason for hiding this comment

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

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/).