diff --git a/content/operate/kubernetes/deployment/helm.md b/content/operate/kubernetes/deployment/helm.md new file mode 100644 index 000000000..d3bffe2f6 --- /dev/null +++ b/content/operate/kubernetes/deployment/helm.md @@ -0,0 +1,121 @@ +--- +Title: Install Redis Enterprise Helm chart +alwaysopen: false +categories: +- docs +- operate +- kubernetes +description: Install 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 the Redis operator are supported at this time. The steps for [creating the RedisEnterpriseCluster (REC)]({{}}) and other custom resources remain the same.{{}} + +## 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/). + +### Example values + +The steps below use the following placeholders to indicate command line parameters you must provide: + +- `` is the name of the repo holding your Helm chart (example: `redis`). +- `` is the name you give a specific installation of the Helm chart (example: `my-redis-enterprise-operator`) +- `` is the version of the Helm chart you are installing (example: `7.8.2-2`) +- `` is the name of the new namespace the Redis operator will run in (example: `ns1`) +- `` is the filepath to the Helm chart, if it is stored in a local directory (example: `/home/charts/redis-enterprise-operator`) + +## Install + +1. Add the Redis repository. + +```sh +helm repo add https://helm.redis.io/ +``` + +2. Install the Helm chart into a new namespace. + +```sh +helm install redis/redis-enterprise-operator \ + --version \ + --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 a few minutes to complete. + +### Install from local directory + +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. + +2. Install the Helm chart from your local directory. + +```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 a few minutes to complete. + +### Specify values during install + +1. View configurable values with `helm show values /`. + +2. Install the Helm chart, overriding specific value defaults using `--set`. + +```sh +helm install redis/redis-enterprise-operator \ + --version \ + --namespace \ + --create-namespace + --set = \ + --set = +``` + +### Install with values file + +1. View configurable values with `helm show values /`. + +2. Create a YAML file to specify the values you want to configure. + +3. Install the chart with the `--values` option. + +```sh +helm install redis/redis-enterprise-operator \ + --version \ + --namespace \ + --create-namespace \ + --values +``` + +## Uninstall + +1. Delete any custom resources managed by the operator. See [Delete custom resources]({{}}) for detailed steps. You must delete custom resources in the correct order to avoid errors. + +2. Uninstall the Helm chart. + +```sh +helm uninstall +``` + +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 remain 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