docs: update README of helm-example #591
Conversation
| ``` | ||
| $ helm install . --generate-name --set-string rhoas.config=<configmap-name>,rhoas.secret=<secret-name> | ||
| ``` | ||
| 5. Deploy the helm chart with the appropriate values: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Yes, that makes sense to me!
|
|
||
| `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 was a problem hiding this comment.
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. | ||
| 2. Specifying a yaml file with defined values using the `--values` flag: |
There was a problem hiding this comment.
Specifying a YAML file of another name using the the --values flag:
|
|
||
| There are various ways to provide values: | ||
|
|
||
| 1. The default method is specifying values in the `values.yaml` file. |
There was a problem hiding this comment.
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
| ``` | ||
| helm install . --generate-name --values my-values.yaml | ||
| ``` | ||
| 3. Passing values from the command line using the `--set-string` flag: |
There was a problem hiding this comment.
Passing values directly from the command line using the --set-string flag:
| ``` | ||
| $ helm install . --generate-name --set-string rhoas.config=<configmap-name>,rhoas.secret=<secret-name> | ||
| ``` | ||
| 5. Deploy the helm chart with the appropriate values: |
There was a problem hiding this comment.
Deploy the Helm chart.... (capitalize Helm)
There was a problem hiding this comment.
Updates, look good, @rkpattnaik780. Just a few things to suggest.
|
Thanks for the suggestions @jbyrne-redhat ! |
No description provided.