Skip to content

K8s: revise K8s index pages #1863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 96 additions & 4 deletions content/operate/kubernetes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,104 @@ categories:
- docs
- operate
- kubernetes
description: The Redis Enterprise operators allows you to use Redis Enterprise for
Kubernetes.
hideListLinks: false
description: Deploy and manage Redis Enterprise on Kubernetes with the Redis Enterprise operator.
hideListLinks: true
linkTitle: Redis for Kubernetes
weight: 30
---

Kubernetes provides enterprise orchestration of containers and has been widely adopted. Redis Enterprise for Kubernetes provides a simple way to get a Redis Enterprise cluster on Kubernetes and enables more complex deployment scenarios.
[Redis Enterprise for Kubernetes](https://redis.io/kubernetes/) brings Redis Enterprise to Kubernetes environments through the Redis Enterprise operator. You can deploy, scale, and manage Redis Enterprise clusters and databases by using native Kubernetes resources and workflows.

Redis Enterprise for Kubernetes provides all the enterprise features of Redis Software:

- Linear scalability with Redis clustering
- High availability with automatic failover
- Active-Active geo-distribution
- Auto Tiering for cost optimization
- Enterprise-grade security and encryption
- 24/7 support

The Redis Enterprise operator simplifies deployment and management by providing custom resource definitions (CRDs) for Redis Enterprise clusters (REC) and databases (REDB). This approach enables GitOps workflows and Kubernetes-native operations.

## Get started

Deploy Redis Enterprise on your Kubernetes cluster and create your first database.

- [Quick start deployment]({{< relref "/operate/kubernetes/deployment/quick-start" >}})
- [Deploy with Helm]({{< relref "/operate/kubernetes/deployment/helm" >}})
- [Deploy on OpenShift]({{< relref "/operate/kubernetes/deployment/openshift" >}})
- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}})

## Redis Enterprise clusters (REC)

Create and manage [Redis Enterprise clusters]({{< relref "/operate/kubernetes/re-clusters" >}}) on Kubernetes.

- [Connect to admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console" >}})
- [Auto Tiering]({{< relref "/operate/kubernetes/re-clusters/auto-tiering" >}})
- [Multi-namespace deployment]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}})
- [Cluster recovery]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}})
- [REC API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}})

## Redis Enterprise databases (REDB)

Create and manage [Redis Enterprise databases]({{< relref "/operate/kubernetes/re-databases" >}}) using Kubernetes resources.

- [Database controller]({{< relref "/operate/kubernetes/re-databases/db-controller" >}})
- [Create replica databases]({{< relref "/operate/kubernetes/re-databases/replica-redb" >}})
- [REDB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}})

## Active-Active databases

Set up globally distributed [Active-Active databases]({{< relref "/operate/kubernetes/active-active" >}}) across multiple Kubernetes clusters.

- [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters" >}})
- [Create Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb" >}})
- [Global configuration]({{< relref "/operate/kubernetes/active-active/global-config" >}})
- [REAADB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}})
- [Remote cluster API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}})

## Security

Manage [secure connections]({{< relref "/operate/kubernetes/security" >}}) and access control for your Redis Enterprise deployment.

- [Manage REC credentials]({{< relref "/operate/kubernetes/security/manage-rec-credentials" >}})
- [Manage REC certificates]({{< relref "/operate/kubernetes/security/manage-rec-certificates" >}})
- [Internode encryption]({{< relref "/operate/kubernetes/security/internode-encryption" >}})
- [LDAP authentication]({{< relref "/operate/kubernetes/security/ldap" >}})

## Reference

Use the Kubernetes API and command-line tools to manage your Redis Enterprise deployment.

- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}})
- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}})
- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}})
- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}})

## Logs & monitoring

Monitor and troubleshoot your Redis Enterprise deployment.

- [Collect logs]({{< relref "/operate/kubernetes/logs/collect-logs" >}})
- [Connect to Prometheus operator]({{< relref "/operate/kubernetes/re-clusters/connect-prometheus-operator" >}})

## Upgrade

Keep your Redis Enterprise deployment up to date.

- [Upgrade Redis cluster]({{< relref "/operate/kubernetes/upgrade/upgrade-redis-cluster" >}})
- [Upgrade with OpenShift CLI]({{< relref "/operate/kubernetes/upgrade/openshift-cli" >}})
- [Upgrade with OLM]({{< relref "/operate/kubernetes/upgrade/upgrade-olm" >}})

## Release notes

Stay informed about new features, enhancements, and fixes.

- [Release notes]({{< relref "/operate/kubernetes/release-notes" >}})

## Related info

- [Redis Enterprise Software]({{< relref "/operate/rs" >}})
- [Redis Cloud]({{< relref "/operate/rc" >}})
- [Redis Open Source]({{< relref "/operate/oss_and_stack" >}})
- [Glossary]({{< relref "/glossary" >}})
6 changes: 4 additions & 2 deletions content/operate/kubernetes/active-active/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ categories:
- docs
- operate
- kubernetes
description: Content related to Active-Active Redis Enterprise databases for Kubernetes.
description: Create and manage Active-Active Redis Enterprise databases across multiple Kubernetes clusters.
hideListLinks: true
linkTitle: Active-Active databases
weight: 40
---

On Kubernetes, Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases provide read and write access to the same dataset from different Kubernetes clusters.
Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases on Kubernetes provide read and write access to the same dataset from different Kubernetes clusters. This enables globally distributed applications with local read and write access, automatic conflict resolution, and seamless failover capabilities.

Active-Active databases use multi-master replication to keep data synchronized across participating clusters, allowing applications to read and write data locally while maintaining global consistency.

## Active-Active setup methods

Expand Down
51 changes: 45 additions & 6 deletions content/operate/kubernetes/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,57 @@ categories:
- docs
- operate
- kubernetes
description: This section lists the different ways to set up and run Redis Enterprise
for Kubernetes. You can deploy on variety of Kubernetes distributions both on-prem
and in the cloud via our Redis Enterprise operator for Kubernetes.
hideListLinks: false
description: Deploy Redis Enterprise for Kubernetes using the Redis Enterprise operator on various Kubernetes distributions.
hideListLinks: true
linkTitle: Deployment
weight: 11
---

This section lists the different ways to set up and run Redis Enterprise for Kubernetes. You can deploy on variety of Kubernetes distributions both on-prem and in the cloud via our Redis Enterprise operator for Kubernetes.
Deploy Redis Enterprise for Kubernetes by using the Redis Enterprise operator. The operator provides a simple way to deploy and manage Redis Enterprise clusters on various Kubernetes distributions, both on-premises and in the cloud.

The Redis Enterprise operator uses custom resource definitions (CRDs) to manage Redis Enterprise clusters (REC) and databases (REDB) as native Kubernetes resources. This approach enables GitOps workflows and Kubernetes-native operations.

## Quick start

Get started quickly with a basic Redis Enterprise deployment:

- [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start" >}}) - Step-by-step guide for most Kubernetes distributions
- [Deploy on OpenShift]({{< relref "/operate/kubernetes/deployment/openshift" >}}) - Specific instructions for OpenShift environments

## Deployment methods

Choose the deployment method that best fits your environment:

- [Deploy with Helm]({{< relref "/operate/kubernetes/deployment/helm" >}}) - Use Helm charts for simplified deployment and management
- [Deploy with operator bundle]({{< relref "/operate/kubernetes/deployment/quick-start" >}}) - Direct deployment using kubectl and operator manifests

## Container images

Understand the container images used by the Redis Enterprise operator:

- [Container images]({{< relref "/operate/kubernetes/deployment/container-images" >}}) - Details about Redis Enterprise container images and registries

## Compatibility

Before installing, check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to see which Redis Enterprise operator version supports your Kubernetes distribution.
Before installing, verify compatibility with your environment:

- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) - Check which Redis Enterprise operator version supports your Kubernetes distribution

## Prerequisites

Before deploying Redis Enterprise for Kubernetes, ensure you have:

- A Kubernetes cluster running a [supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}})
- Minimum of three worker nodes for high availability
- Kubernetes client (kubectl) configured to access your cluster
- Access to container registries (DockerHub, Red Hat Container Catalog, or private registry)
- Sufficient resources as outlined in [sizing recommendations]({{< relref "/operate/kubernetes/recommendations/sizing-on-kubernetes" >}})

## Next steps

After deployment, you can:

- [Create a Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/re-clusters" >}})
- [Create Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/re-databases" >}})
- [Configure networking]({{< relref "/operate/kubernetes/networking" >}})
- [Set up security]({{< relref "/operate/kubernetes/security" >}})
19 changes: 12 additions & 7 deletions content/operate/kubernetes/logs/_index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
---
Title: Redis Enterprise Software logs on Kubernetes
Title: Logs
alwaysopen: false
categories:
- docs
- operate
- kubernetes
description: This section provides information about how logs are stored and accessed.
description: Access and manage Redis Enterprise logs on Kubernetes for monitoring and troubleshooting.
hideListLinks: true
linkTitle: Logs
weight: 60
---

## Logs
Access and manage Redis Enterprise logs on Kubernetes for monitoring, troubleshooting, and debugging your Redis Enterprise deployment. Logs provide valuable insights into cluster operations, database performance, and system health.

Each redis-enterprise container stores its logs under `/var/opt/redislabs/log`.
When using persistent storage this path is automatically mounted to the
`redis-enterprise-storage` volume.
This volume can easily be accessed by a sidecar, i.e. a container residing on the same pod.
## Log collection and access

Learn how to collect and access logs from your Redis Enterprise deployment:

- [Collect logs]({{< relref "/operate/kubernetes/logs/collect-logs" >}}) - Methods for collecting logs from Redis Enterprise pods and containers

## Log storage and access

Each Redis Enterprise container stores its logs under `/var/opt/redislabs/log`. When using persistent storage, this path is automatically mounted to the `redis-enterprise-storage` volume, making logs accessible through sidecar containers or external log collection tools.

For example, in the REC (Redis Enterprise Cluster) spec you can add a sidecar container, such as a busybox, and mount the logs to there:

Expand Down
21 changes: 15 additions & 6 deletions content/operate/kubernetes/networking/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,27 @@ categories:
- docs
- operate
- kubernetes
description: null
description: Configure networking and external access for Redis Enterprise clusters and databases on Kubernetes.
hideListLinks: true
linkTitle: Networking
weight: 40
---

Redis Enterprise for Kubernetes supports several ways to route external traffic to your RedisEnterpriseCluster:
Configure networking and external access for your Redis Enterprise deployment on Kubernetes. By default, Kubernetes doesn't allow external access to your Redis databases. Redis Enterprise for Kubernetes provides several methods to route external traffic to your clusters and databases.

- Ingress controllers [HAProxy](https://haproxy-ingress.github.io/) and [NGINX](https://kubernetes.github.io/ingress-nginx/) require an `ingress` API resource.
- [Istio](https://istio.io/latest/docs/setup/getting-started/) requires `Gateway` and `VirtualService` API resources.
- OpenShift uses [routes]({{< relref "/operate/kubernetes/networking/routes" >}}) to route external traffic.
- The RedisEnterpriseActiveActiveDatabase (REAADB) requires any of the above routing methods to be configured in the RedisEnterpriseCluster (REC) with the `ingressOrRouteSpec` field.
## External routing methods

Choose the appropriate method for your environment to enable external access:

- [Ingress routing]({{< relref "/operate/kubernetes/networking/ingress" >}}) - Use NGINX or HAProxy ingress controllers with `ingress` API resources
- [Istio ingress routing]({{< relref "/operate/kubernetes/networking/istio-ingress" >}}) - Use Istio service mesh with `Gateway` and `VirtualService` API resources
- [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes" >}}) - Use OpenShift-specific route resources for external traffic

## Automatic ingress configuration

For Active-Active databases, configure automatic ingress creation:

- [REC external routing]({{< relref "/operate/kubernetes/networking/ingressorroutespec" >}}) - Use `ingressOrRouteSpec` field in RedisEnterpriseCluster (REC) for automatic ingress creation

## External routing using Redis Enterprise for Kubernetes

Expand Down
39 changes: 36 additions & 3 deletions content/operate/kubernetes/re-clusters/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,46 @@ categories:
- docs
- operate
- kubernetes
description: Articles to help you manage your Redis Enterprise clusters (REC).
hideListLinks: false
description: Create and manage Redis Enterprise clusters (REC) on Kubernetes using the Redis Enterprise operator.
hideListLinks: true
linkTitle: Redis Enterprise clusters (REC)
weight: 30
---

This section contains articles to help you manage your Redis Enterprise clusters (REC).
A Redis Enterprise cluster (REC) is a custom Kubernetes resource that represents a Redis Enterprise cluster deployment. The Redis Enterprise operator manages the lifecycle of REC resources, including deployment, scaling, upgrades, and recovery operations.

REC resources define the cluster configuration, including node specifications, storage requirements, security settings, and networking configuration. After you deploy the cluster, it provides a foundation for creating and managing Redis Enterprise databases (REDB).

## Cluster management

Manage your Redis Enterprise cluster lifecycle and configuration:

- [Connect to admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console" >}}) - Access the Redis Enterprise web UI for cluster management
- [Multi-namespace deployment]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) - Deploy clusters across multiple Kubernetes namespaces
- [Delete custom resources]({{< relref "/operate/kubernetes/re-clusters/delete-custom-resources" >}}) - Safely remove REC and related resources

## Storage and performance

Optimize storage and performance for your Redis Enterprise cluster:

- [Auto Tiering]({{< relref "/operate/kubernetes/re-clusters/auto-tiering" >}}) - Configure automatic data tiering between RAM and flash storage
- [Expand PVC]({{< relref "/operate/kubernetes/re-clusters/expand-pvc" >}}) - Expand persistent volume claims for additional storage

## Monitoring and observability

Monitor cluster health and performance:

- [Connect to Prometheus operator]({{< relref "/operate/kubernetes/re-clusters/connect-prometheus-operator" >}}) - Integrate with Prometheus for metrics collection and monitoring

## Recovery and troubleshooting

Handle cluster recovery and troubleshooting scenarios:

- [Cluster recovery]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}}) - Recover from cluster failures and restore operations

## Related topics

- [Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/re-databases" >}}) - Create and manage databases on your cluster
- [Security]({{< relref "/operate/kubernetes/security" >}}) - Configure security settings for your cluster
- [Networking]({{< relref "/operate/kubernetes/networking" >}}) - Set up networking and ingress for cluster access
- [REC API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) - Complete API specification for REC resources
Loading