Skip to content

Commit adbbea5

Browse files
some review feedback changes
1 parent 0b6b661 commit adbbea5

File tree

1 file changed

+26
-14
lines changed
  • content/operate/kubernetes/deployment

1 file changed

+26
-14
lines changed

content/operate/kubernetes/deployment/helm.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,38 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes
2121
- [Kubernetes client (kubectl)](https://kubernetes.io/docs/tasks/tools/).
2222
- [Helm 3.10 or later](https://helm.sh/docs/intro/install/).
2323

24+
### Example values
25+
26+
The steps below use the following placeholders to indicate values you must provide:
27+
28+
- `<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: ``)
30+
- `<chart-version>` is the version of the Helm chart you are installing (example: `7.8.2-2`)
31+
- `<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: ``)
33+
2434
## Install
2535

26-
1. Add the `redis` repository.
36+
1. Add the Redis repository.
2737

2838
```sh
29-
helm repo add redis-enterprise https://helm.redis.io/
39+
helm repo add <repo-name> https://helm.redis.io/
3040
```
3141

42+
3243
1. Install the Helm chart into a new namespace.
3344

3445
```sh
35-
helm install <operator-name> redis/redis-enterprise-operator \
36-
-- version <release-name> \
37-
-- namespace <namespace-name> \
38-
-- create-namespace
46+
helm install <release-name> redis/redis-enterprise-operator \
47+
--version <chart-version> \
48+
--namespace <namespace-name> \
49+
--create-namespace
3950
```
4051

4152
To install with Openshift, add `--set openshift.mode=true`.
4253

43-
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take few minutes to complete.
54+
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take afew minutes to complete.
55+
4456

4557
### Install from local directory
4658

@@ -50,13 +62,13 @@ To monitor the installation add the `--debug` flag. The installation runs severa
5062

5163
```sh
5264
helm install <release-name> <path-to-chart> \
53-
-- namespace <namespace-name> \
54-
-- create-namespace
65+
--namespace <namespace-name> \
66+
--create-namespace
5567
```
5668

5769
To install with Openshift, add `--set openshift.mode=true`.
5870

59-
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take few minutes to complete.
71+
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take a few minutes to complete.
6072

6173
### Specify values during install
6274

@@ -66,9 +78,9 @@ To monitor the installation add the `--debug` flag. The installation runs severa
6678

6779
```sh
6880
helm install <operator-name> redis/redis-enterprise-operator \
69-
-- version <release-name> \
70-
-- namespace <namespace-name> \
71-
-- create-namespace
81+
--version <release-name> \
82+
--namespace <namespace-name> \
83+
--create-namespace
7284
--set <key1>=<value1> \
7385
--set <key2>=<value2>
7486
```
@@ -77,7 +89,6 @@ To monitor the installation add the `--debug` flag. The installation runs severa
7789

7890
1. View configurable values with `helm show values redis/redis-enterprise-operator --version <release-name>`.
7991

80-
1. Create a YAML file containing the configuration values you want to set.
8192
1. Create a YAML file to specify the values you want to configure.
8293

8394
1. Install the chart with the `--values` option.
@@ -90,6 +101,7 @@ To monitor the installation add the `--debug` flag. The installation runs severa
90101
-- values <path-to-values-file>
91102
```
92103

104+
93105
## Uninstall
94106

95107
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.

0 commit comments

Comments
 (0)