Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
29bedf8
rough outline
kaitlynmichael Dec 5, 2024
e9ef41b
intro, prereq, install
kaitlynmichael Dec 5, 2024
df2aca9
grammar edits and delete steps
kaitlynmichael Dec 5, 2024
0abe592
install with values file
kaitlynmichael Dec 5, 2024
7d12a36
Apply suggestions from code review
kaitlynmichael Dec 6, 2024
f90991a
wording edit
kaitlynmichael Dec 9, 2024
31f69b7
finish draft
kaitlynmichael Dec 10, 2024
969c2b1
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Dec 11, 2024
ae7153b
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Dec 11, 2024
6d7bd52
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Dec 11, 2024
9a61eb4
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Dec 11, 2024
18c6415
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Dec 11, 2024
0b6b661
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Jan 16, 2025
adbbea5
some review feedback changes
kaitlynmichael Jan 16, 2025
7002540
clarify placeholder variables
kaitlynmichael Jan 27, 2025
9608943
fix relrefs
kaitlynmichael Jan 27, 2025
db95cd1
Merge branch 'main' into DOC-3433
kaitlynmichael Jan 27, 2025
5eef954
review changes
kaitlynmichael Jan 28, 2025
bf1b08c
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Feb 19, 2025
641d8c8
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Feb 19, 2025
02c947a
Apply suggestions from code review
kaitlynmichael Feb 19, 2025
92c53d1
Update content/operate/kubernetes/deployment/helm.md
kaitlynmichael Feb 19, 2025
f02eee8
RC: Create Pro database changes
cmilesb Mar 25, 2025
eebbde1
Merge pull request #1320 from redis/DOC-5016
cmilesb Mar 25, 2025
b7b4312
Merge branch 'main' into DOC-3433
kaitlynmichael Mar 26, 2025
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
40 changes: 26 additions & 14 deletions content/operate/kubernetes/deployment/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,38 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes
- [Kubernetes client (kubectl)](https://kubernetes.io/docs/tasks/tools/).
- [Helm 3.10 or later](https://helm.sh/docs/intro/install/).

### Example values

The steps below use the following placeholders to indicate values you must provide:

- `<repo-name>` is the name of repo holding your helm chart (example: `redis`).
- `<release-name>` is the name you give a specific installation of the Helm chart (example: ``)
- `<chart-version>` is the version of the Helm chart you are installing (example: `7.8.2-2`)
- `<namespace-name>` is the name of the new namespace the Redis operator will run in (example: `ns1`)
- `<path-to-chart>` is the filepath to the Helm chart, if it is stored in a local directory (exmaple: ``)

## Install

1. Add the `redis` repository.
1. Add the Redis repository.

```sh
helm repo add redis-enterprise https://helm.redis.io/
helm repo add <repo-name> https://helm.redis.io/
```


1. Install the Helm chart into a new namespace.
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't have to be a new namespace, so I'm not sure if we should mention that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm going to leave this as is, because it currently mirrors what we have in the other deployment guides.


```sh
helm install <operator-name> redis/redis-enterprise-operator \
-- version <release-name> \
-- namespace <namespace-name> \
-- create-namespace
helm install <release-name> redis/redis-enterprise-operator \
--version <chart-version> \
--namespace <namespace-name> \
--create-namespace
```

To install with Openshift, add `--set openshift.mode=true`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm definitely not a language authority, but is it "install with OpenShift" or "install to OpenShift" (or "install to an OpenShift cluster")?
Also - I believe it's OpenShift and not Openshift.


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


### Install from local directory

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

```sh
helm install <release-name> <path-to-chart> \
-- namespace <namespace-name> \
-- create-namespace
--namespace <namespace-name> \
--create-namespace
```

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

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

### Specify values during install

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

```sh
helm install <operator-name> redis/redis-enterprise-operator \
-- version <release-name> \
-- namespace <namespace-name> \
-- create-namespace
--version <release-name> \
--namespace <namespace-name> \
--create-namespace
--set <key1>=<value1> \
--set <key2>=<value2>
```
Expand All @@ -77,7 +89,6 @@ To monitor the installation add the `--debug` flag. The installation runs severa

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

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.

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


## Uninstall

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.
Expand Down
Loading