redis-enterprise-k8s-docs | page describes how to deploy Redis Enterprise | DevOps library

The "Basic" installation deploys the operator (from the current release) from DockerHub and default settings. Recommended for KOPS, GKE, AKS, EKS, Rancher, VMWare Tanzu. This is the fastest way to get up and running with a new Redis Enterprise on Kubernetes.
Create a new namespace: Note: For the purpose of this doc, we'll use the name "demo" for our cluster's namespace. kubectl create namespace demo Switch context to the newly created namespace: kubectl config set-context --current --namespace=demo
Deploy the operator bundle To deploy the default installation with kubectl, the following command will deploy a bundle of all the yaml declarations required for the operator: kubectl apply -f bundle.yaml Alternatively, to run each of the declarations of the bundle individually, run the following commands instead of the bundle: kubectl apply -f role.yaml kubectl apply -f role_binding.yaml kubectl apply -f service_account.yaml kubectl apply -f crds/v1/rec_crd.yaml kubectl apply -f crds/v1alpha1/redb_crd.yaml kubectl apply -f admission-service.yaml kubectl apply -f operator.yaml Run kubectl get deployment and verify redis-enterprise-operator deployment is running. A typical response may look like this: NAME READY UP-TO-DATE AVAILABLE AGE redis-enterprise-operator 1/1 1 1 2m
Redis Enterprise Cluster custom resource - RedisEnterpriseCluster Create a RedisEnterpriseCluster(REC) using the default configuration, which is suitable for development type deployments and works in typical scenarios. The full list of attributes supported through the Redis Enterprise Cluster (REC) API can be found HERE. Some examples can be found in the examples folder. kubectl apply -f examples/v1/rec.yaml Note: The Operator can only manage one Redis Enterprise Cluster custom resource in a namespace. To deploy another Enterprise Clusters in the same Kubernetes cluster, deploy an Operator in an additional namespace for each additional Enterprise Cluster required. Note that each Enterprise Cluster can effectively host hundreds of Redis Database instances. Deploying multiple clusters is typically used for scenarios where complete operational isolation is required at the cluster level.
Run kubectl get rec and verify creation was successful. rec is a shortcut for RedisEnterpriseCluster. The cluster takes around 5-10 minutes to come up. A typical response may look like this: NAME AGE rec 5m Note: Once the cluster is up, the cluster GUI and API could be used to configure databases. It is recommended to use the K8s REDB API that is configured through the following steps. To configure the cluster using the cluster GUI/API, use the ui service created by the operator and the default credentials as set in a secret. The secret name is the same as the cluster name within the namespace.
Redis Enterprise Database (REDB) Admission Controller: The Admission Controlller is recommended for use. It uses the Redis Enterprise Cluster to dynamically validate that REDB resources as configured by the operator are valid. Steps to configure the Admission Controller: Note: Redis Labs' Redis Enterprise Operator can also be installed through the Gesher Admission Proxy Wait for the secret to be created: kubectl get secret admission-tls NAME TYPE DATA AGE admission-tls Opaque 2 2m43s Enable the Kubernetes webhook using the generated certificate Save the certificate into a local environmental variable CERT=`kubectl get secret admission-tls -o jsonpath='{.data.cert}'` Create a patch file sed 's/NAMESPACE_OF_SERVICE_ACCOUNT/demo/g' admission/webhook.yaml | kubectl create -f - cat > modified-webhook.yaml <<EOF webhooks: - name: redb.admission.redislabs clientConfig: caBundle: $CERT admissionReviewVersions: ["v1beta1"] EOF Patch the validating webhook with the certificate (caBundle) kubectl patch ValidatingWebhookConfiguration redb-admission --patch "$(cat modified-webhook.yaml)" Note: If you're not using multiple namespaces you may skip to "Verify the installation" step. Note: If you're not using multiple namespaces you may proceed to step 6. Limiting the webhook to the relevant namespaces: Unless limited, webhooks will intercept requests from all namespaces. In case you have several REC objects on your K8S cluster you need to limit the webhook to the relevant namespace. This is done by adding a namespaceSelector to the webhook spec that targets a label found on the namespace. First, make sure you have such a relevant label on the namespace and that it is unique for this namespace. e.g. apiVersion: v1 kind: Namespace metadata: labels: namespace-name: staging name: staging Then, patch the webhook with a namespaceSelector. See this example: cat > modified-webhook.yaml <<EOF webhooks: - name: redb.admission.redislabs namespaceSelector: matchLabels: namespace-name: staging EOF apply the patch: kubectl patch ValidatingWebhookConfiguration redb-admission --patch "$(cat modified-webhook.yaml)" Verify the installation In order to verify that the all the components of the Admission Controller are installed correctly, we will try to apply an invalid resource that should force the admission controller to reject it. If it applies succesfully, it means the admission controller has not been hooked up correctly. $ kubectl apply -f - << EOF apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: name: redis-enterprise-database spec: evictionPolicy: illegal EOF This must fail with an error output by the admission webhook redb.admisison.redislabs that is being denied because it can't get the login credentials for the Redis Enterprise Cluster as none were specified. Error from server: error when creating "STDIN": admission webhook "redb.admission.redislabs" denied the request: eviction_policy: u'illegal' is not one of [u'volatile-lru', u'volatile-ttl', u'volatile-random', u'allkeys-lru', u'allkeys-random', u'noeviction', u'volatile-lfu', u'allkeys-lfu'] Note: procedure to enable admission is documented with further detail here.
Redis Enterprise Database custom resource - RedisEnterpriseDatabase Create a RedisEnterpriseDatabase (REDB) by using Custom Resource. The Redis Enterprise Operator can be instructed to manage databases on the Redis Enterprise Cluster using the REDB custom resource. Example: cat << EOF > /tmp/redis-enterprise-database.yml apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: name: redis-enterprise-database spec: memorySize: 100MB EOF kubectl apply -f /tmp/redis-enterprise-database.yml Replace the name of the cluster with the one used on the current namespace. All REDB configuration options are documented here.
The "OpenShift" installation deploys the operator from the current release with the RHEL image from DockerHub and default OpenShift settings. This is the fastest way to get up and running with a new cluster on OpenShift 3.x. For OpenShift 4.x, you may choose to use OLM deployment from within your OpenShift cluster or follow the steps below. Other custom configurations are referenced in this repository. If you are running on OpenShift 3.x, use the bundle.yaml file located under openshift_3_x folder (see comment in step 4). That folder also contains the custom resource definitions compatible with OpenShift 3.x. Note: you will need to replace <my-project> with your project name.
Create a new project: oc new-project my-project
Perform the following commands (you need cluster admin permissions for your Kubernetes cluster): oc apply -f openshift/scc.yaml You should receive the following response: securitycontextconstraints.security.openshift.io "redis-enterprise-scc" configured
Provide the operator permissions for pods (substitute your project for "my-project"): oc adm policy add-scc-to-user redis-enterprise-scc system:serviceaccount:my-project:redis-enterprise-operator oc adm policy add-scc-to-user redis-enterprise-scc system:serviceaccount:my-project:rec Note - change rec in the suffix of the 2nd command with the name of the RedisEnterpriseCluster, if different (see step "Redis Enterprise Cluster custom resource" below).
Deploy the OpenShift operator bundle: NOTE: Update the storageClassName setting in openshift.bundle.yaml (by default its set to gp2). oc apply -f openshift.bundle.yaml Note: If you are running on OpenShift 3.x, use the bundle.yaml file located under openshift_3_x folder.
Redis Enterprise Cluster custom resource - RedisEnterpriseCluster Apply the RedisEnterpriseCluster resource with RHEL7 based images: oc apply -f openshift/rec_rhel.yaml
Redis Enterprise Database (REDB) Admission Controller: The Admission Controlller is recommended for use. It uses the Redis Enterprise Cluster to dynamically validate that REDB resources as configured by the operator are valid. Steps to configure the Admission Controller: Wait for the secret to be created by the operator bundle deployment kubectl get secret admission-tls NAME TYPE DATA AGE admission-tls Opaque 2 2m43s Enable the Kubernetes webhook using the generated certificate # save cert CERT=`kubectl get secret admission-tls -o jsonpath='{.data.cert}'` sed 's/NAMESPACE_OF_SERVICE_ACCOUNT/demo/g' admission/webhook.yaml | kubectl create -f - # create patch file cat > modified-webhook.yaml <<EOF webhooks: - admissionReviewVersions: clientConfig: caBundle: $CERT name: redb.admission.redislabs admissionReviewVersions: ["v1beta1"] EOF # patch webhook with caBundle oc patch ValidatingWebhookConfiguration redb-admission --patch "$(cat modified-webhook.yaml)" Note: If you're not using multiple namespaces you may skip to "Verify the installation" step. Limiting the webhook to the relevant namespaces: Unless limited, webhooks will intercept requests from all namespaces. In case you have several REC objects on your K8S cluster you need to limit the webhook to the relevant namespace. This is done by adding a namespaceSelector to the webhook spec that targets a label found on the namespace. First, make sure you have such a relevant label on the namespace and that it is unique for this namespace. e.g. apiVersion: v1 kind: Namespace metadata: labels: namespace-name: staging name: staging Then, patch the webhook with a namespaceSelector. See this example: cat > modified-webhook.yaml <<EOF webhooks: - name: redb.admission.redislabs namespaceSelector: matchLabels: namespace-name: staging EOF apply the patch: oc patch ValidatingWebhookConfiguration redb-admission --patch "$(cat modified-webhook.yaml)" Verify the installation In order to verify that the all the components of the Admission Controller are installed correctly, we will try to apply an invalid resource that should force the admission controller to reject it. If it applies succesfully, it means the admission controller has not been hooked up correctly. $ oc apply -f - << EOF apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: name: redis-enterprise-database spec: evictionPolicy: illegal EOF This must fail with an error output by the admission webhook redb.admisison.redislabs that is being denied because it can't get the login credentials for the Redis Enterprise Cluster as none were specified. Error from server: error when creating "STDIN": admission webhook "redb.admission.redislabs" denied the request: eviction_policy: u'illegal' is not one of [u'volatile-lru', u'volatile-ttl', u'volatile-random', u'allkeys-lru', u'allkeys-random', u'noeviction', u'volatile-lfu', u'allkeys-lfu'] Note: procedure to enable admission is documented with further detail [here](admission/README.md
Redis Enterprise Database custom resource - RedisEnterpriseDatabase Create a RedisEnterpriseDatabase (REDB) by using Custom Resource. The Redis Enterprise Operator can be instructed to manage databases on the Redis Enterprise Cluster using the REDB custom resource. Example: cat << EOF > /tmp/redis-enterprise-database.yml apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: name: redis-enterprise-database spec: memorySize: 100MB EOF oc apply -f /tmp/redis-enterprise-database.yml Replace the name of the cluster with the one used on the current namespace. All REDB configuration options are documented here.
Instruction on how to deploy the Operator on PKS can be found on the Redis Labs documentation Website.
The Operator automates and simplifies the upgrade process. The Redis Enterprise Cluster Software, and the Redis Enterprise Operator for Kubernetes versions are tightly coupled and should be upgraded together. It is recommended to use the bundle.yaml to upgrade, as it loads all the relevant CRD documents for this version. If the updated CRDs are not loaded, the operator might fail. There are two ways to upgrade - either set 'autoUpgradeRedisEnterprise' within the Redis Enterprise Cluster Spec to instruct the operator to automatically upgrade to the compatible version, or specify the correct Redis Enterprise image manually using the versionTag attribute. The Redis Enterprise Version compatible with this release is 6.2.8-64.