Skip to content

Commit 31f69b7

Browse files
finish draft
1 parent f90991a commit 31f69b7

File tree

1 file changed

+34
-7
lines changed
  • content/operate/kubernetes/deployment

1 file changed

+34
-7
lines changed

content/operate/kubernetes/deployment/helm.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,38 @@ Helm charts provide a simple way to install the Redis Enterprise for Kubernetes
4040

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

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

4545
### Install from local directory
4646

47-
DOWNLOAD TGZ FILE
48-
HELM INSTALL FROM LOCAL DIRECTORY
47+
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.
4948

50-
## Configuration
49+
1. Install the Helm chart from your local directory.
5150

52-
helm show values redis/redis-enterprise-operator --version <release-name>
51+
```sh
52+
helm install <release-name> <path-to-chart> \
53+
-- namespace <namespace-name> \
54+
-- create-namespace
55+
```
56+
57+
To install with Openshift, add `--set openshift.mode=true`.
58+
59+
To monitor the installation add the `--debug` flag. The installation runs several jobs synchronously and may take few minutes to complete.
60+
61+
### Specify values during install
62+
63+
1. View configurable values with `helm show values redis/redis-enterprise-operator --version <release-name>`.
64+
65+
1. Install the Helm chart, overriding specific value defaults using `--set`.
66+
67+
```sh
68+
helm install <operator-name> redis-enterprise-helm/redis-enterprise-operator \
69+
-- version <release-name> \
70+
-- namespace <namespace-name> \
71+
-- create-namespace
72+
--set <key1>=<value1> \
73+
--set <key2>=<value2>
74+
```
5375

5476
### Install with values file
5577

@@ -68,8 +90,6 @@ helm show values redis/redis-enterprise-operator --version <release-name>
6890
-- values <path-to-values-file>
6991
```
7092

71-
### Install and override specific default values
72-
7393
## Uninstall
7494

7595
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.
@@ -82,4 +102,11 @@ helm show values redis/redis-enterprise-operator --version <release-name>
82102

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

105+
{{<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>}}
106+
85107
## Known limitations
108+
109+
- 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.
110+
- Upgrades and migrations are not supported.
111+
- The chart doesn't include configuration options for multiple namespaces, rack-awareness, and Vault integration. The steps for configuring these options remains the same.
112+
- The chart has had limited testing in advanced setups, including Active-Active configurations, air-gapped deployments, and IPv6/dual-stack environments.

0 commit comments

Comments
 (0)