Skip to content

Commit 7002540

Browse files
clarify placeholder variables
1 parent adbbea5 commit 7002540

File tree

1 file changed

+42
-45
lines changed
  • content/operate/kubernetes/deployment

1 file changed

+42
-45
lines changed

content/operate/kubernetes/deployment/helm.md

Lines changed: 42 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -26,91 +26,88 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes
2626
The steps below use the following placeholders to indicate values you must provide:
2727

2828
- `<repo-name>` is the name of repo holding your helm chart (example: `redis`).
29-
- `<release-name>` is the name you give a specific installation of the Helm chart (example: ``)
29+
- `<release-name>` is the name you give a specific installation of the Helm chart (example: `my-redis-enterprise-operator`)
3030
- `<chart-version>` is the version of the Helm chart you are installing (example: `7.8.2-2`)
3131
- `<namespace-name>` is the name of the new namespace the Redis operator will run in (example: `ns1`)
32-
- `<path-to-chart>` is the filepath to the Helm chart, if it is stored in a local directory (exmaple: ``)
32+
- `<path-to-chart>` is the filepath to the Helm chart, if it is stored in a local directory (exmaple: `/home/charts/redis-enterprise-operato`)
3333

3434
## Install
3535

3636
1. Add the Redis repository.
3737

38-
```sh
39-
helm repo add <repo-name> https://helm.redis.io/
40-
```
38+
```sh
39+
helm repo add <repo-name> https://helm.redis.io/
40+
```
4141

42+
2. Install the Helm chart into a new namespace.
4243

43-
1. Install the Helm chart into a new namespace.
44-
45-
```sh
46-
helm install <release-name> redis/redis-enterprise-operator \
47-
--version <chart-version> \
48-
--namespace <namespace-name> \
49-
--create-namespace
50-
```
44+
```sh
45+
helm install <release-name> redis/redis-enterprise-operator \
46+
--version <chart-version> \
47+
--namespace <namespace-name> \
48+
--create-namespace
49+
```
5150

5251
To install with Openshift, add `--set openshift.mode=true`.
5352

5453
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take afew minutes to complete.
5554

56-
5755
### Install from local directory
5856

5957
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.
6058

61-
1. Install the Helm chart from your local directory.
59+
2. Install the Helm chart from your local directory.
6260

63-
```sh
64-
helm install <release-name> <path-to-chart> \
65-
--namespace <namespace-name> \
66-
--create-namespace
67-
```
61+
```sh
62+
helm install <release-name> <path-to-chart> \
63+
--namespace <namespace-name> \
64+
--create-namespace
65+
```
6866

6967
To install with Openshift, add `--set openshift.mode=true`.
7068

7169
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take a few minutes to complete.
7270

7371
### Specify values during install
7472

75-
1. View configurable values with `helm show values redis/redis --version <release-name>`.
73+
1. View configurable values with `helm show values <repo-name>/<chart-name>`.
7674

77-
1. Install the Helm chart, overriding specific value defaults using `--set`.
75+
2. Install the Helm chart, overriding specific value defaults using `--set`.
7876

79-
```sh
80-
helm install <operator-name> redis/redis-enterprise-operator \
81-
--version <release-name> \
82-
--namespace <namespace-name> \
83-
--create-namespace
84-
--set <key1>=<value1> \
85-
--set <key2>=<value2>
86-
```
77+
```sh
78+
helm install <operator-name> redis/redis-enterprise-operator \
79+
--version <release-name> \
80+
--namespace <namespace-name> \
81+
--create-namespace
82+
--set <key1>=<value1> \
83+
--set <key2>=<value2>
84+
```
8785

8886
### Install with values file
8987

90-
1. View configurable values with `helm show values redis/redis-enterprise-operator --version <release-name>`.
91-
92-
1. Create a YAML file to specify the values you want to configure.
88+
1. View configurable values with `helm show values <repo-name>/<chart-name>`.
9389

94-
1. Install the chart with the `--values` option.
90+
2. Create a YAML file to specify the values you want to configure.
9591

96-
```sh
97-
helm install <operator-name> redis/redis-enterprise-operator \
98-
-- version <release-name> \
99-
-- namespace <namespace-name> \
100-
-- create-namespace \
101-
-- values <path-to-values-file>
102-
```
92+
3. Install the chart with the `--values` option.
10393

94+
```sh
95+
helm install <operator-name> redis/redis-enterprise-operator \
96+
-- version <release-name> \
97+
-- namespace <namespace-name> \
98+
-- create-namespace \
99+
-- values <path-to-values-file>
100+
```
104101

105102
## Uninstall
106103

107104
1. Delete any custom resources managed by the operator. See [Delete custom resources]({{<relref "content/operate/kubernetes/re-clusters/delete-custom-resources.md">}}) for detailed steps. Custom resources must be deleted in the correct order to avoid errors.
108105

109-
1. Uninstall the helm chart.
106+
2. Uninstall the helm chart.
110107

111-
```sh
112-
helm uninstall <release-name>
113-
```
108+
```sh
109+
helm uninstall <release-name>
110+
```
114111

115112
This removes all Kubernetes resources associated with the chart and deletes the release.
116113

0 commit comments

Comments
 (0)