From 29bedf88909d9d8a657ea51aeee82aa0637286ad Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Thu, 5 Dec 2024 14:00:47 -0600 Subject: [PATCH 01/12] rough outline --- content/operate/kubernetes/deployment/helm.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 content/operate/kubernetes/deployment/helm.md diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md new file mode 100644 index 000000000..528de20c1 --- /dev/null +++ b/content/operate/kubernetes/deployment/helm.md @@ -0,0 +1,46 @@ +--- +Title: Install the Redis Enterprise Helm chart +alwaysopen: false +categories: +- docs +- operate +- kubernetes +description: Install the Redis Enterprise operator using helm charts. +linkTitle: Helm +weight: 11 +--- + +## Prerequisites +K8s 1.23 LINK TO SUPPORTED DISTROS, ADD SPECIFICS OF REQUIRED REDB, RHEL9 AND MODULE VERSIONS +HELM 3.10 + +## Install + +1. Add repo with `helm repo add` +1. Install chart with new namespace `helm install` +To install with Openshift, add --set openshift.mode=true +To monitor install use --debug flag + +To install from local directory: + +1. Download tgz file +1. helm install from local directory + +## Configuration + +Install with values file + +Install and override specific default values + +## Uninstall + + +1. Delete any custom resources managed by the operator in the following order. LINK TO UNINSTALL PAGE, POSSIBLY EMBED + ```sh + kubectl delete redb + kubectl delete rerc + kubectl delete reaadb + kubectl delete rec + ``` + +## Known limitations From e9ef41b36b9a271b401d6ca0757363bdd1311bc3 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Thu, 5 Dec 2024 14:45:56 -0600 Subject: [PATCH 02/12] intro, prereq, install --- content/operate/kubernetes/deployment/helm.md | 50 +++++++++++++------ 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 528de20c1..36c3c7266 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -1,39 +1,61 @@ --- -Title: Install the Redis Enterprise Helm chart +Title: Install Redis Enterprise Helm chart alwaysopen: false categories: - docs - operate - kubernetes -description: Install the Redis Enterprise operator using helm charts. +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/). + +{{}} This feature is currently in public preview and is not supported on production workloads. Only new installations of Redis operator are supported at this time. The steps to [create the RedisEnterpriseCluster (REC)]({{}}) and other custom resources remain the same.{{}} + ## Prerequisites -K8s 1.23 LINK TO SUPPORTED DISTROS, ADD SPECIFICS OF REQUIRED REDB, RHEL9 AND MODULE VERSIONS -HELM 3.10 + +- [Supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}) of Kubernetes +- Three or more 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 repo with `helm repo add` -1. Install chart with new namespace `helm install` -To install with Openshift, add --set openshift.mode=true -To monitor install use --debug flag +1. Add the `redis-enterprise-helm` repository. + + ```sh + helm repo add redis-enterprise-helm https://helm.redis.io/ + ``` + +1. Install the Helm chart in a new namespace. -To install from local directory: + ```sh + helm install redis-enterprise-helm/redis-enterprise-operator \ + -- version \ + -- namespace \ + -- create-namespace + ``` + +To install with Openshift, add `--set openshift.mode=true`. + +To monitor the install add the `--debug` flag. The installation runs several jobs synchonously and may take a minute or two to complete. -1. Download tgz file -1. helm install from local directory +### Install from local directory + +DOWNLOAD TGZ FILE +HELM INSTALL FROM LOCAL DIRECTORY ## Configuration -Install with values file +See [`values.yaml`](https://github.com/RedisLabs/redis-enterprise-operator/blob/master/deploy/helm/redis-enterprise-operator/values.yaml) for the default values. -Install and override specific default values +### Install with values file -## Uninstall +### Install and override specific default values +## Uninstall 1. Delete any custom resources managed by the operator in the following order. LINK TO UNINSTALL PAGE, POSSIBLY EMBED ```sh From df2aca9c62f342c89e2dbe5d81069cd6e0f324d8 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Thu, 5 Dec 2024 15:00:15 -0600 Subject: [PATCH 03/12] grammar edits and delete steps --- content/operate/kubernetes/deployment/helm.md | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 36c3c7266..2cbd5f3e9 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -12,14 +12,14 @@ 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/). -{{}} This feature is currently in public preview and is not supported on production workloads. Only new installations of Redis operator are supported at this time. The steps to [create the RedisEnterpriseCluster (REC)]({{}}) and other custom resources remain the same.{{}} +{{}} 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)]({{}}) and other custom resources remain the same.{{}} ## Prerequisites -- [Supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}) of Kubernetes -- Three or more worker nodes -- [Kubernetes client (kubectl)](https://kubernetes.io/docs/tasks/tools/) -- [Helm 3.10 or later](https://helm.sh/docs/intro/install/) +- 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 @@ -29,10 +29,10 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes helm repo add redis-enterprise-helm https://helm.redis.io/ ``` -1. Install the Helm chart in a new namespace. +1. Install the Helm chart into a new namespace. ```sh - helm install redis-enterprise-helm/redis-enterprise-operator \ + helm install redis-enterprise-helm/redis-enterprise-operator \ -- version \ -- namespace \ -- create-namespace @@ -40,7 +40,7 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes To install with Openshift, add `--set openshift.mode=true`. -To monitor the install add the `--debug` flag. The installation runs several jobs synchonously and may take a minute or two to complete. +To monitor the installation add the `--debug` flag. The installation runs several jobs synchonously and may take few minutes to complete. ### Install from local directory @@ -57,12 +57,14 @@ See [`values.yaml`](https://github.com/RedisLabs/redis-enterprise-operator/blob/ ## Uninstall -1. Delete any custom resources managed by the operator in the following order. LINK TO UNINSTALL PAGE, POSSIBLY EMBED +1. Delete any custom resources managed by the operator. See [Delete custom resources]({{}}) for detailed steps. Custom resources must be deleted in the correct order to avoid errors. + +1. Uninstall the helm chart. + ```sh - kubectl delete redb - kubectl delete rerc - kubectl delete reaadb - kubectl delete rec + helm uninstall ``` +This removes all Kubernetes resources associated with the chart and deletes the release. + ## Known limitations From 0abe592e5ec582982caae151ab36b5b9a3a3cea7 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Thu, 5 Dec 2024 15:12:43 -0600 Subject: [PATCH 04/12] install with values file --- content/operate/kubernetes/deployment/helm.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 2cbd5f3e9..e3a252fac 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -53,6 +53,20 @@ See [`values.yaml`](https://github.com/RedisLabs/redis-enterprise-operator/blob/ ### Install with values file +1. View configurable values with `helm show values`. + +2. Create a YAML file with the values you wish to configure. + +3. Install the chart with the `--values` option. + + ```sh + helm install redis-enterprise-helm/redis-enterprise-operator \ + -- version \ + -- namespace \ + -- create-namespace + -- values + ``` + ### Install and override specific default values ## Uninstall From 7d12a36c250d5f8619da67089c4496c79bf209a3 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Date: Fri, 6 Dec 2024 06:59:30 -0600 Subject: [PATCH 05/12] Apply suggestions from code review Co-authored-by: oshri barazani --- content/operate/kubernetes/deployment/helm.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index e3a252fac..66c63a905 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -23,7 +23,7 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes ## Install -1. Add the `redis-enterprise-helm` repository. +1. Add the `redis` repository. ```sh helm repo add redis-enterprise-helm https://helm.redis.io/ @@ -49,11 +49,11 @@ HELM INSTALL FROM LOCAL DIRECTORY ## Configuration -See [`values.yaml`](https://github.com/RedisLabs/redis-enterprise-operator/blob/master/deploy/helm/redis-enterprise-operator/values.yaml) for the default values. +helm show values redis/redis-enterprise-operator --version ### Install with values file -1. View configurable values with `helm show values`. +1. View configurable values with `helm show values redis/redis-enterprise-operator --version `. 2. Create a YAML file with the values you wish to configure. From f90991a985d94fd2d044e91f66dd9a7963551332 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Mon, 9 Dec 2024 13:14:20 -0600 Subject: [PATCH 06/12] wording edit --- content/operate/kubernetes/deployment/helm.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 66c63a905..a18744b70 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -55,18 +55,19 @@ helm show values redis/redis-enterprise-operator --version 1. View configurable values with `helm show values redis/redis-enterprise-operator --version `. -2. Create a YAML file with the values you wish to configure. +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. -3. Install the chart with the `--values` option. +1. Install the chart with the `--values` option. ```sh helm install redis-enterprise-helm/redis-enterprise-operator \ -- version \ -- namespace \ - -- create-namespace + -- create-namespace \ -- values ``` - + ### Install and override specific default values ## Uninstall From 31f69b7b8b086dbba426182817ff26e4370d3dd7 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael Date: Tue, 10 Dec 2024 14:38:33 -0600 Subject: [PATCH 07/12] finish draft --- content/operate/kubernetes/deployment/helm.md | 41 +++++++++++++++---- 1 file changed, 34 insertions(+), 7 deletions(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index a18744b70..c64ac66c6 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -40,16 +40,38 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes To install with Openshift, add `--set openshift.mode=true`. -To monitor the installation add the `--debug` flag. The installation runs several jobs synchonously and may take few minutes to complete. +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 -DOWNLOAD TGZ FILE -HELM 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. -## Configuration +1. Install the Helm chart from your local directory. -helm show values redis/redis-enterprise-operator --version + ```sh + helm install \ + -- namespace \ + -- 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 `. + +1. Install the Helm chart, overriding specific value defaults using `--set`. + + ```sh + helm install redis-enterprise-helm/redis-enterprise-operator \ + -- version \ + -- namespace \ + -- create-namespace + --set = \ + --set = + ``` ### Install with values file @@ -68,8 +90,6 @@ helm show values redis/redis-enterprise-operator --version -- values ``` -### Install and override specific default values - ## Uninstall 1. Delete any custom resources managed by the operator. See [Delete custom resources]({{}}) for detailed steps. Custom resources must be deleted in the correct order to avoid errors. @@ -82,4 +102,11 @@ helm show values redis/redis-enterprise-operator --version This removes all Kubernetes resources associated with the chart and deletes the release. +{{}}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`.{{}} + ## Known limitations + +- Only new installations of the Redis operator are supported at this time. The steps for [creating the RedisEnterpriseCluster (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. \ No newline at end of file From 969c2b1c03e08ad6e052312b5e88ef974ca11f32 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Date: Wed, 11 Dec 2024 10:59:34 -0600 Subject: [PATCH 08/12] Update content/operate/kubernetes/deployment/helm.md Co-authored-by: oshri barazani --- content/operate/kubernetes/deployment/helm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index c64ac66c6..7be7dbd75 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -26,7 +26,7 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes 1. Add the `redis` repository. ```sh - helm repo add redis-enterprise-helm https://helm.redis.io/ + helm repo add redis-enterprise https://helm.redis.io/ ``` 1. Install the Helm chart into a new namespace. From ae7153b14f3e56d6313d4c6f4cfaa8362ca98773 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Date: Wed, 11 Dec 2024 10:59:54 -0600 Subject: [PATCH 09/12] Update content/operate/kubernetes/deployment/helm.md Co-authored-by: oshri barazani --- content/operate/kubernetes/deployment/helm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 7be7dbd75..4e52f53e3 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -32,7 +32,7 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes 1. Install the Helm chart into a new namespace. ```sh - helm install redis-enterprise-helm/redis-enterprise-operator \ + helm install redis/redis-enterprise-operator \ -- version \ -- namespace \ -- create-namespace From 6d7bd52790899d76b34f9f76e6fa3860eb2862e6 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Date: Wed, 11 Dec 2024 11:00:43 -0600 Subject: [PATCH 10/12] Update content/operate/kubernetes/deployment/helm.md Co-authored-by: oshri barazani --- content/operate/kubernetes/deployment/helm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 4e52f53e3..9f8331235 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -60,7 +60,7 @@ To monitor the installation add the `--debug` flag. The installation runs severa ### Specify values during install -1. View configurable values with `helm show values redis/redis-enterprise-operator --version `. +1. View configurable values with `helm show values redis/redis --version `. 1. Install the Helm chart, overriding specific value defaults using `--set`. From 9a61eb476f49a61d6f403e19542ce5413217c634 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Date: Wed, 11 Dec 2024 11:00:55 -0600 Subject: [PATCH 11/12] Update content/operate/kubernetes/deployment/helm.md Co-authored-by: oshri barazani --- content/operate/kubernetes/deployment/helm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 9f8331235..9f4c86f24 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -65,7 +65,7 @@ To monitor the installation add the `--debug` flag. The installation runs severa 1. Install the Helm chart, overriding specific value defaults using `--set`. ```sh - helm install redis-enterprise-helm/redis-enterprise-operator \ + helm install redis/redis-enterprise-operator \ -- version \ -- namespace \ -- create-namespace From 18c641541732c1efa3e40cb5f3036382c8ca5604 Mon Sep 17 00:00:00 2001 From: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Date: Wed, 11 Dec 2024 11:01:05 -0600 Subject: [PATCH 12/12] Update content/operate/kubernetes/deployment/helm.md Co-authored-by: oshri barazani --- content/operate/kubernetes/deployment/helm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md index 9f4c86f24..85279faab 100644 --- a/content/operate/kubernetes/deployment/helm.md +++ b/content/operate/kubernetes/deployment/helm.md @@ -83,7 +83,7 @@ To monitor the installation add the `--debug` flag. The installation runs severa 1. Install the chart with the `--values` option. ```sh - helm install redis-enterprise-helm/redis-enterprise-operator \ + helm install redis/redis-enterprise-operator \ -- version \ -- namespace \ -- create-namespace \