K8s: install helm chart #957
Conversation
Co-authored-by: oshri barazani <[email protected]>
| 1. Install the Helm chart from your local directory. | ||
|
|
||
| ```sh | ||
| helm install <release-name> <path-to-chart> \ |
There was a problem hiding this comment.
or
need to be consistent.
I think is better
Co-authored-by: oshri barazani <[email protected]>
Co-authored-by: oshri barazani <[email protected]>
Co-authored-by: oshri barazani <[email protected]>
Co-authored-by: oshri barazani <[email protected]>
Co-authored-by: oshri barazani <[email protected]>
| -- version <release-name> \ | ||
| -- namespace <namespace-name> \ | ||
| -- create-namespace |
There was a problem hiding this comment.
Need to remove the space between the -- and the flag name.
There was a problem hiding this comment.
This applies to all command examples throughout the document.
| 1. Install the Helm chart into a new namespace. | ||
|
|
||
| ```sh | ||
| helm install <operator-name> redis/redis-enterprise-operator \ |
There was a problem hiding this comment.
The first placeholder of this command should actually be <release-name> and not <operator-name>.
Confusingly, a "release" in Helm terminology is the user-defined name given a specific installation of the chart (e.g., you can install the same chart multiple times using different "release names").
Maybe we should also explain this briefly, or provide an example command that will convey the idea that could be anything the user wishes.
|
|
||
| ```sh | ||
| helm install <operator-name> redis/redis-enterprise-operator \ | ||
| -- version <release-name> \ |
There was a problem hiding this comment.
This placeholder should actually be <chart-version> and not <release-name>; Something like 7.8.2-2.
| 1. Install the Helm chart into a new namespace. | ||
|
|
||
| ```sh | ||
| helm install <operator-name> redis/redis-enterprise-operator \ |
There was a problem hiding this comment.
The redis/redis-enterprise-operator parameter is made up of <repo-name>/<chart-name>.
The is the same one we use in step (1) above (helm repo add <repo-name>). We should get it aligned to either redis or redis-enterprise.
| 1. Add the `redis` repository. | ||
|
|
||
| ```sh | ||
| helm repo add redis-enterprise https://helm.redis.io/ | ||
| ``` |
There was a problem hiding this comment.
Here too, we should use a single repo name in both the sentence "Add the <repo-name> repository" and the command example.
|
|
||
| ### Install from local directory | ||
|
|
||
| 1. Find the latest release on the [redis-enterprise-k8s-docs Github](https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases) and download the `tar.gz` source code into a local directory. |
There was a problem hiding this comment.
Can also consider this, I think it looks a little nicer when rendered:
- ...on the redis-enterprise-k8s-docs repo and...
- vs
- ...on the redis-enterprise-k8s-docs Github and...
| 1. Find the latest release on the [redis-enterprise-k8s-docs Github](https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases) and download the `tar.gz` source code into a local directory. | |
| 1. Find the latest release on the [redis-enterprise-k8s-docs](https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases) repo and download the `tar.gz` source code into a local directory. |
|
|
||
| ### Specify values during install | ||
|
|
||
| 1. View configurable values with `helm show values redis/redis --version <release-name>`. |
There was a problem hiding this comment.
The argument to helm show values is also a <repo-name>/<chart-name>.
The <chart-name> should be redis-enterprise-operator, and the <repo-name> should best align with whatever you pick in the install section above (either redis or redis-enterprise).
|
|
||
| ### Specify values during install | ||
|
|
||
| 1. View configurable values with `helm show values redis/redis --version <release-name>`. |
There was a problem hiding this comment.
Also - same comment about <chart-version> instead of <release-name>.
| --set <key2>=<value2> | ||
| ``` | ||
|
|
||
| ### Install with values file |
There was a problem hiding this comment.
This section is largely repeating the previous one, maybe we should just mention that the values may be overridden either by the --set flag or via --values file?
| 1. Create a YAML file containing the configuration values you want to set. | ||
| 1. Create a YAML file to specify the values you want to configure. |
There was a problem hiding this comment.
Only one of these should win.
DOC-3433
This content is for the Wisconsin release