Skip to content

Commit 5d74ac8

Browse files
K8s: revise K8s index pages (#1863)
* remvoe 7.2.8-6 mentions * revise index pages * cleanup * reference custom resource info
1 parent 73dfa96 commit 5d74ac8

File tree

12 files changed

+404
-60
lines changed

12 files changed

+404
-60
lines changed

content/operate/kubernetes/_index.md

Lines changed: 96 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,104 @@ categories:
55
- docs
66
- operate
77
- kubernetes
8-
description: The Redis Enterprise operators allows you to use Redis Enterprise for
9-
Kubernetes.
10-
hideListLinks: false
8+
description: Deploy and manage Redis Enterprise on Kubernetes with the Redis Enterprise operator.
9+
hideListLinks: true
1110
linkTitle: Redis for Kubernetes
1211
weight: 30
1312
---
1413

15-
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.
14+
[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.
1615

16+
Redis Enterprise for Kubernetes provides all the enterprise features of Redis Software:
17+
18+
- Linear scalability with Redis clustering
19+
- High availability with automatic failover
20+
- Active-Active geo-distribution
21+
- Auto Tiering for cost optimization
22+
- Enterprise-grade security and encryption
23+
- 24/7 support
24+
25+
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.
26+
27+
## Get started
28+
29+
Deploy Redis Enterprise on your Kubernetes cluster and create your first database.
30+
31+
- [Quick start deployment]({{< relref "/operate/kubernetes/deployment/quick-start" >}})
32+
- [Deploy with Helm]({{< relref "/operate/kubernetes/deployment/helm" >}})
33+
- [Deploy on OpenShift]({{< relref "/operate/kubernetes/deployment/openshift" >}})
34+
- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}})
35+
36+
## Redis Enterprise clusters (REC)
37+
38+
Create and manage [Redis Enterprise clusters]({{< relref "/operate/kubernetes/re-clusters" >}}) on Kubernetes.
39+
40+
- [Connect to admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console" >}})
41+
- [Auto Tiering]({{< relref "/operate/kubernetes/re-clusters/auto-tiering" >}})
42+
- [Multi-namespace deployment]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}})
43+
- [Cluster recovery]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}})
44+
- [REC API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}})
45+
46+
## Redis Enterprise databases (REDB)
47+
48+
Create and manage [Redis Enterprise databases]({{< relref "/operate/kubernetes/re-databases" >}}) using Kubernetes resources.
49+
50+
- [Database controller]({{< relref "/operate/kubernetes/re-databases/db-controller" >}})
51+
- [Create replica databases]({{< relref "/operate/kubernetes/re-databases/replica-redb" >}})
52+
- [REDB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}})
53+
54+
## Active-Active databases
55+
56+
Set up globally distributed [Active-Active databases]({{< relref "/operate/kubernetes/active-active" >}}) across multiple Kubernetes clusters.
57+
58+
- [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters" >}})
59+
- [Create Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb" >}})
60+
- [Global configuration]({{< relref "/operate/kubernetes/active-active/global-config" >}})
61+
- [REAADB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}})
62+
- [Remote cluster API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}})
63+
64+
## Security
65+
66+
Manage [secure connections]({{< relref "/operate/kubernetes/security" >}}) and access control for your Redis Enterprise deployment.
67+
68+
- [Manage REC credentials]({{< relref "/operate/kubernetes/security/manage-rec-credentials" >}})
69+
- [Manage REC certificates]({{< relref "/operate/kubernetes/security/manage-rec-certificates" >}})
70+
- [Internode encryption]({{< relref "/operate/kubernetes/security/internode-encryption" >}})
71+
- [LDAP authentication]({{< relref "/operate/kubernetes/security/ldap" >}})
72+
73+
## Reference
74+
75+
Use the Kubernetes API and command-line tools to manage your Redis Enterprise deployment.
76+
77+
- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}})
78+
- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}})
79+
- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}})
80+
- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}})
81+
82+
## Logs & monitoring
83+
84+
Monitor and troubleshoot your Redis Enterprise deployment.
85+
86+
- [Collect logs]({{< relref "/operate/kubernetes/logs/collect-logs" >}})
87+
- [Connect to Prometheus operator]({{< relref "/operate/kubernetes/re-clusters/connect-prometheus-operator" >}})
88+
89+
## Upgrade
90+
91+
Keep your Redis Enterprise deployment up to date.
92+
93+
- [Upgrade Redis cluster]({{< relref "/operate/kubernetes/upgrade/upgrade-redis-cluster" >}})
94+
- [Upgrade with OpenShift CLI]({{< relref "/operate/kubernetes/upgrade/openshift-cli" >}})
95+
- [Upgrade with OLM]({{< relref "/operate/kubernetes/upgrade/upgrade-olm" >}})
96+
97+
## Release notes
98+
99+
Stay informed about new features, enhancements, and fixes.
100+
101+
- [Release notes]({{< relref "/operate/kubernetes/release-notes" >}})
102+
103+
## Related info
104+
105+
- [Redis Enterprise Software]({{< relref "/operate/rs" >}})
106+
- [Redis Cloud]({{< relref "/operate/rc" >}})
107+
- [Redis Open Source]({{< relref "/operate/oss_and_stack" >}})
108+
- [Glossary]({{< relref "/glossary" >}})

content/operate/kubernetes/active-active/_index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ categories:
55
- docs
66
- operate
77
- kubernetes
8-
description: Content related to Active-Active Redis Enterprise databases for Kubernetes.
8+
description: Create and manage Active-Active Redis Enterprise databases across multiple Kubernetes clusters.
99
hideListLinks: true
1010
linkTitle: Active-Active databases
1111
weight: 40
1212
---
1313

14-
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.
14+
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.
15+
16+
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.
1517

1618
## Active-Active setup methods
1719

content/operate/kubernetes/deployment/_index.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,57 @@ categories:
55
- docs
66
- operate
77
- kubernetes
8-
description: This section lists the different ways to set up and run Redis Enterprise
9-
for Kubernetes. You can deploy on variety of Kubernetes distributions both on-prem
10-
and in the cloud via our Redis Enterprise operator for Kubernetes.
11-
hideListLinks: false
8+
description: Deploy Redis Enterprise for Kubernetes using the Redis Enterprise operator on various Kubernetes distributions.
9+
hideListLinks: true
1210
linkTitle: Deployment
1311
weight: 11
1412
---
1513

16-
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.
14+
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.
15+
16+
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.
17+
18+
## Quick start
19+
20+
Get started quickly with a basic Redis Enterprise deployment:
21+
22+
- [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start" >}}) - Step-by-step guide for most Kubernetes distributions
23+
- [Deploy on OpenShift]({{< relref "/operate/kubernetes/deployment/openshift" >}}) - Specific instructions for OpenShift environments
24+
25+
## Deployment methods
26+
27+
Choose the deployment method that best fits your environment:
28+
29+
- [Deploy with Helm]({{< relref "/operate/kubernetes/deployment/helm" >}}) - Use Helm charts for simplified deployment and management
30+
- [Deploy with operator bundle]({{< relref "/operate/kubernetes/deployment/quick-start" >}}) - Direct deployment using kubectl and operator manifests
31+
32+
## Container images
33+
34+
Understand the container images used by the Redis Enterprise operator:
35+
36+
- [Container images]({{< relref "/operate/kubernetes/deployment/container-images" >}}) - Details about Redis Enterprise container images and registries
1737

1838
## Compatibility
1939

20-
Before installing, check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to see which Redis Enterprise operator version supports your Kubernetes distribution.
40+
Before installing, verify compatibility with your environment:
41+
42+
- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) - Check which Redis Enterprise operator version supports your Kubernetes distribution
43+
44+
## Prerequisites
45+
46+
Before deploying Redis Enterprise for Kubernetes, ensure you have:
47+
48+
- A Kubernetes cluster running a [supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}})
49+
- Minimum of three worker nodes for high availability
50+
- Kubernetes client (kubectl) configured to access your cluster
51+
- Access to container registries (DockerHub, Red Hat Container Catalog, or private registry)
52+
- Sufficient resources as outlined in [sizing recommendations]({{< relref "/operate/kubernetes/recommendations/sizing-on-kubernetes" >}})
53+
54+
## Next steps
2155

56+
After deployment, you can:
2257

58+
- [Create a Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/re-clusters" >}})
59+
- [Create Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/re-databases" >}})
60+
- [Configure networking]({{< relref "/operate/kubernetes/networking" >}})
61+
- [Set up security]({{< relref "/operate/kubernetes/security" >}})

content/operate/kubernetes/logs/_index.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
---
2-
Title: Redis Enterprise Software logs on Kubernetes
2+
Title: Logs
33
alwaysopen: false
44
categories:
55
- docs
66
- operate
77
- kubernetes
8-
description: This section provides information about how logs are stored and accessed.
8+
description: Access and manage Redis Enterprise logs on Kubernetes for monitoring and troubleshooting.
99
hideListLinks: true
1010
linkTitle: Logs
1111
weight: 60
1212
---
1313

14-
## Logs
14+
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.
1515

16-
Each redis-enterprise container stores its logs under `/var/opt/redislabs/log`.
17-
When using persistent storage this path is automatically mounted to the
18-
`redis-enterprise-storage` volume.
19-
This volume can easily be accessed by a sidecar, i.e. a container residing on the same pod.
16+
## Log collection and access
17+
18+
Learn how to collect and access logs from your Redis Enterprise deployment:
19+
20+
- [Collect logs]({{< relref "/operate/kubernetes/logs/collect-logs" >}}) - Methods for collecting logs from Redis Enterprise pods and containers
21+
22+
## Log storage and access
23+
24+
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.
2025

2126
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:
2227

content/operate/kubernetes/networking/_index.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,27 @@ categories:
55
- docs
66
- operate
77
- kubernetes
8-
description: null
8+
description: Configure networking and external access for Redis Enterprise clusters and databases on Kubernetes.
99
hideListLinks: true
1010
linkTitle: Networking
1111
weight: 40
1212
---
1313

14-
Redis Enterprise for Kubernetes supports several ways to route external traffic to your RedisEnterpriseCluster:
14+
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.
1515

16-
- Ingress controllers [HAProxy](https://haproxy-ingress.github.io/) and [NGINX](https://kubernetes.github.io/ingress-nginx/) require an `ingress` API resource.
17-
- [Istio](https://istio.io/latest/docs/setup/getting-started/) requires `Gateway` and `VirtualService` API resources.
18-
- OpenShift uses [routes]({{< relref "/operate/kubernetes/networking/routes" >}}) to route external traffic.
19-
- The RedisEnterpriseActiveActiveDatabase (REAADB) requires any of the above routing methods to be configured in the RedisEnterpriseCluster (REC) with the `ingressOrRouteSpec` field.
16+
## External routing methods
17+
18+
Choose the appropriate method for your environment to enable external access:
19+
20+
- [Ingress routing]({{< relref "/operate/kubernetes/networking/ingress" >}}) - Use NGINX or HAProxy ingress controllers with `ingress` API resources
21+
- [Istio ingress routing]({{< relref "/operate/kubernetes/networking/istio-ingress" >}}) - Use Istio service mesh with `Gateway` and `VirtualService` API resources
22+
- [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes" >}}) - Use OpenShift-specific route resources for external traffic
23+
24+
## Automatic ingress configuration
25+
26+
For Active-Active databases, configure automatic ingress creation:
27+
28+
- [REC external routing]({{< relref "/operate/kubernetes/networking/ingressorroutespec" >}}) - Use `ingressOrRouteSpec` field in RedisEnterpriseCluster (REC) for automatic ingress creation
2029

2130
## External routing using Redis Enterprise for Kubernetes
2231

content/operate/kubernetes/re-clusters/_index.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,46 @@ categories:
55
- docs
66
- operate
77
- kubernetes
8-
description: Articles to help you manage your Redis Enterprise clusters (REC).
9-
hideListLinks: false
8+
description: Create and manage Redis Enterprise clusters (REC) on Kubernetes using the Redis Enterprise operator.
9+
hideListLinks: true
1010
linkTitle: Redis Enterprise clusters (REC)
1111
weight: 30
1212
---
1313

14-
This section contains articles to help you manage your Redis Enterprise clusters (REC).
14+
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.
1515

16+
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).
1617

18+
## Cluster management
1719

20+
Manage your Redis Enterprise cluster lifecycle and configuration:
21+
22+
- [Connect to admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console" >}}) - Access the Redis Enterprise web UI for cluster management
23+
- [Multi-namespace deployment]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) - Deploy clusters across multiple Kubernetes namespaces
24+
- [Delete custom resources]({{< relref "/operate/kubernetes/re-clusters/delete-custom-resources" >}}) - Safely remove REC and related resources
25+
26+
## Storage and performance
27+
28+
Optimize storage and performance for your Redis Enterprise cluster:
29+
30+
- [Auto Tiering]({{< relref "/operate/kubernetes/re-clusters/auto-tiering" >}}) - Configure automatic data tiering between RAM and flash storage
31+
- [Expand PVC]({{< relref "/operate/kubernetes/re-clusters/expand-pvc" >}}) - Expand persistent volume claims for additional storage
32+
33+
## Monitoring and observability
34+
35+
Monitor cluster health and performance:
36+
37+
- [Connect to Prometheus operator]({{< relref "/operate/kubernetes/re-clusters/connect-prometheus-operator" >}}) - Integrate with Prometheus for metrics collection and monitoring
38+
39+
## Recovery and troubleshooting
40+
41+
Handle cluster recovery and troubleshooting scenarios:
42+
43+
- [Cluster recovery]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}}) - Recover from cluster failures and restore operations
44+
45+
## Related topics
46+
47+
- [Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/re-databases" >}}) - Create and manage databases on your cluster
48+
- [Security]({{< relref "/operate/kubernetes/security" >}}) - Configure security settings for your cluster
49+
- [Networking]({{< relref "/operate/kubernetes/networking" >}}) - Set up networking and ingress for cluster access
50+
- [REC API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) - Complete API specification for REC resources

0 commit comments

Comments
 (0)