Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 5.61 KB

README.md

File metadata and controls

121 lines (83 loc) · 5.61 KB
Raw

Deploying Redis Enterprise on Kubernetes

This page describes how to deploy Redis Enterprise on Kubernetes using the Redis Enterprise Operator. The Redis Enterprise Operator supports two Custom Resource Definitions (CRDs):

  • Redis Enterprise Cluster (REC): an API to create Redis Enterprise clusters. Note that only one cluster is supported per operator deployment.

  • Redis Enterprise Database (REDB): an API to create Redis databases running on the Redis Enterprise cluster. Note that the Redis Enterprise operator is namespaced. High level architecture and overview of the solution can be found HERE.

Quick start guide

This content has moved to the Redis Enterprise doc site, redis.io/docs.

Installation on OpenShift

This content has moved to the Redis Enterprise doc site, redis.io/docs.

Installation on VMWare Tanzu

This content has moved to the Redis Enterprise docs site.

Configuration

RedisEnterpriseCluster custom resource

The operator deploys a RedisEnterpriseCluster with default configurations values, but those can be customized in the RedisEnterpriseCluster spec as follow:

Some examples have moved to the Redis Enterprise doc site, redis.io/docs.

  • Cluster username (Default is [email protected])

    username: "[email protected]"

  • Extra Labels: Additional labels to tag the k8s resources created during deployment

      extraLabels:
    example1: "some-value"
    example2: "some-value"

  • UI service type: Load Balancer or cluster IP (default)

    uiServiceType: LoadBalancer

  • Database service type (optional): Service types for access to databases. Should be a comma separated list. The possible values are cluster_ip, headless, and load_balancer. Default value is cluster_ip,headless. For example, to create a load_balancer type database service, explicitly add the following declaration to the Redis Enterprise Cluster spec:

    servicesRiggerSpec:
  databaseServiceType: load_balancer

  • UI annotations: Add custom annotation to the UI service

      uiAnnotations:
    uiAnnotation1: 'UI-annotation1'
    uiAnnotation2: 'UI-Annotation2'

  • SideCar containers: images that will run along side the redis enterprise containers

      sideContainersSpec:
    - name: sidecar
      image: dockerhub_repo/repo:tag
      imagePullPolicy: IfNotPresent

  • IPV4 enforcement

    You might not have IPV6 support in your K8S cluster. In this case, you could enforce the use of IPV4, by adding the following attribute to the REC spec:

      enforceIPv4: true

    Note: Setting 'enforceIPv4' to 'true' is a requirement for running REC on PKS.

  • Full detail can be found in Redis Enterprise Cluster Custom Resource Specification.

Private Repositories

This content has moved to the Redis Enterprise doc site, redis.io/docs.

Pull secrets

This content has moved to the Redis Enterprise doc site, redis.io/docs.

Advanced Configuration

Connect to Redis Enterprise Software web console

This content has moved to the Redis Enterprise doc site, redis.io/docs.

Upgrade

This content has moved to the Redis Enterprise doc site, redis.io/docs.

Supported K8S Distributions

This content has moved to the Redis Enterprise doc site, redis.io/docs.