Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

K8s: install helm chart #957

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from
Draft
Changes from 7 commits
Commits
Show all changes
22 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
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
112 changes: 112 additions & 0 deletions content/operate/kubernetes/deployment/helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
Title: Install Redis Enterprise Helm chart
alwaysopen: false
categories:
- docs
- operate
- kubernetes
description: Install the Redis Enterprise for Kubernetes version 7.8.Wisconsin using helm charts.
linkTitle: Helm
weight: 11
---

Helm charts provide a simple way to install the Redis Enterprise for Kubernetes operator in just a few steps. For more information about Helm, go to [https://helm.sh/docs/](https://helm.sh/docs/).

{{<note>}} This feature is currently in public preview and is not supported on production workloads. Only new installations of the Redis operator are supported at this time. The steps for [creating the RedisEnterpriseCluster (REC)]({{<relref "operate/kubernetes/deployment/quick-start/#create-a-redis-enterprise-cluster-rec">}}) and other custom resources remain the same.{{</note>}}

## Prerequisites

- A [supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}) of Kubernetes.
- At least three worker nodes.
- [Kubernetes client (kubectl)](https://kubernetes.io/docs/tasks/tools/).
- [Helm 3.10 or later](https://helm.sh/docs/intro/install/).

## Install

1. Add the `redis` repository.

```sh
helm repo add redis-enterprise-helm 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-enterprise-helm/redis-enterprise-operator \
-- version <release-name> \
-- 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.

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

1. Install the Helm chart from your local directory.

```sh
helm install <release-name> <path-to-chart> \
-- 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.

### Specify values during install

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

1. Install the Helm chart, overriding specific value defaults using `--set`.

```sh
helm install <operator-name> redis-enterprise-helm/redis-enterprise-operator \
-- version <release-name> \
-- namespace <namespace-name> \
-- create-namespace
--set <key1>=<value1> \
--set <key2>=<value2>
```

### Install with values file

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.

```sh
helm install <operator-name> redis-enterprise-helm/redis-enterprise-operator \
-- version <release-name> \
-- namespace <namespace-name> \
-- create-namespace \
-- 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.

1. Uninstall the helm chart.

```sh
helm uninstall <release-name>
```

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

{{<note>}}Custom Resource Definitions (CRDs) installed by the chart are not removed during chart uninstallation. To remove them manually after uninstalling the chart, run `kubectl delete crds -l app=redis-enterprise`.{{</note>}}

## Known limitations

- Only new installations of the Redis operator are supported at this time. The steps for [creating the RedisEnterpriseCluster (REC)]({{<relref "operate/kubernetes/deployment/quick-start/#create-a-redis-enterprise-cluster-rec">}}) and other custom resources remain the same.
- Upgrades and migrations are not supported.
- The chart doesn't include configuration options for multiple namespaces, rack-awareness, and Vault integration. The steps for configuring these options remains the same.
- The chart has had limited testing in advanced setups, including Active-Active configurations, air-gapped deployments, and IPv6/dual-stack environments.
Loading