diff --git a/content/operate/kubernetes/_index.md b/content/operate/kubernetes/_index.md index d0665bc519..ec07f093f9 100644 --- a/content/operate/kubernetes/_index.md +++ b/content/operate/kubernetes/_index.md @@ -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" >}}) \ No newline at end of file diff --git a/content/operate/kubernetes/active-active/_index.md b/content/operate/kubernetes/active-active/_index.md index dc77e649e7..791c178aca 100644 --- a/content/operate/kubernetes/active-active/_index.md +++ b/content/operate/kubernetes/active-active/_index.md @@ -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 diff --git a/content/operate/kubernetes/deployment/_index.md b/content/operate/kubernetes/deployment/_index.md index 5aee514767..1c15a39ee5 100644 --- a/content/operate/kubernetes/deployment/_index.md +++ b/content/operate/kubernetes/deployment/_index.md @@ -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" >}}) \ No newline at end of file diff --git a/content/operate/kubernetes/logs/_index.md b/content/operate/kubernetes/logs/_index.md index 73eada98c5..00ba60e2c6 100644 --- a/content/operate/kubernetes/logs/_index.md +++ b/content/operate/kubernetes/logs/_index.md @@ -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: diff --git a/content/operate/kubernetes/networking/_index.md b/content/operate/kubernetes/networking/_index.md index b529254aa8..ebf66949ed 100644 --- a/content/operate/kubernetes/networking/_index.md +++ b/content/operate/kubernetes/networking/_index.md @@ -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 diff --git a/content/operate/kubernetes/re-clusters/_index.md b/content/operate/kubernetes/re-clusters/_index.md index d083222257..e1019e181e 100644 --- a/content/operate/kubernetes/re-clusters/_index.md +++ b/content/operate/kubernetes/re-clusters/_index.md @@ -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 diff --git a/content/operate/kubernetes/re-databases/_index.md b/content/operate/kubernetes/re-databases/_index.md index f85e40e8d6..35ab03cece 100644 --- a/content/operate/kubernetes/re-databases/_index.md +++ b/content/operate/kubernetes/re-databases/_index.md @@ -5,13 +5,51 @@ categories: - docs - operate - kubernetes -description: Articles to help you manage your Redis Enterprise databases (REDBs). -hideListLinks: false +description: Create and manage Redis Enterprise databases (REDB) on Kubernetes using the Redis Enterprise operator. +hideListLinks: true linkTitle: Redis Enterprise databases (REDB) weight: 31 --- -This section contains articles to help you manage your Redis Enterprise databases (REDBs). +A Redis Enterprise database (REDB) is a custom Kubernetes resource that represents a Redis database running on a Redis Enterprise cluster. The Redis Enterprise operator manages REDB resources and handles database creation, configuration, scaling, and lifecycle operations. +REDB resources define database specifications including memory limits, persistence settings, security configurations, networking options, and Redis modules. You can deploy databases on existing Redis Enterprise clusters (REC) and manage them by using standard Kubernetes tools and workflows. +## Database management +Create and manage Redis Enterprise databases on your cluster: + +- [Database controller]({{< relref "/operate/kubernetes/re-databases/db-controller" >}}) - Understand how the database controller manages REDB resources and database lifecycle + +## Replication and high availability + +Set up database replication for high availability and disaster recovery: + +- [Create replica databases]({{< relref "/operate/kubernetes/re-databases/replica-redb" >}}) - Configure replica databases for read scaling and disaster recovery scenarios + +## Advanced database configurations + +Explore advanced database features and configurations: + +- [Active-Active databases]({{< relref "/operate/kubernetes/active-active" >}}) - Set up globally distributed Active-Active databases across multiple Kubernetes clusters + +## Database connectivity + +Connect applications to your Redis Enterprise databases: + +- [Networking]({{< relref "/operate/kubernetes/networking" >}}) - Configure ingress, routes, and service exposure for database access +- [Security]({{< relref "/operate/kubernetes/security" >}}) - Set up TLS, authentication, and access control for secure database connections + +## Monitoring and troubleshooting + +Monitor database performance and troubleshoot issues: + +- [Logs]({{< relref "/operate/kubernetes/logs" >}}) - Collect and analyze database logs for troubleshooting +- [Connect to Prometheus operator]({{< relref "/operate/kubernetes/re-clusters/connect-prometheus-operator" >}}) - Monitor database metrics with Prometheus + +## Related topics + +- [Redis Enterprise clusters (REC)]({{< relref "/operate/kubernetes/re-clusters" >}}) - Manage the underlying cluster infrastructure +- [REDB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}) - Complete API specification for REDB resources +- [Active-Active database API]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}}) - API reference for Active-Active databases +- [Remote cluster API]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}}) - API reference for remote cluster configurations diff --git a/content/operate/kubernetes/recommendations/_index.md b/content/operate/kubernetes/recommendations/_index.md index c7a59c2d1a..5980a3f20f 100644 --- a/content/operate/kubernetes/recommendations/_index.md +++ b/content/operate/kubernetes/recommendations/_index.md @@ -5,14 +5,29 @@ categories: - docs - operate - kubernetes -description: Settings and configuration recommendations for your Redis Enterprise - deployment. +description: Best practices and configuration recommendations for Redis Enterprise on Kubernetes deployments. hideListLinks: false linkTitle: Recommendations weight: 80 --- -This section contains recommended settings and configuration for your Redis Enterprise for Kubernetes deployment. +Follow these best practices and configuration recommendations to optimize your Redis Enterprise deployment on Kubernetes for performance, reliability, and scalability. +## Infrastructure recommendations +Configure your Kubernetes infrastructure for optimal Redis Enterprise performance: +- [Node resources]({{< relref "/operate/kubernetes/recommendations/node-resources" >}}) - CPU, memory, and resource allocation recommendations +- [Node selection]({{< relref "/operate/kubernetes/recommendations/node-selection" >}}) - Best practices for selecting and configuring Kubernetes nodes +- [Persistent volumes]({{< relref "/operate/kubernetes/recommendations/persistent-volumes" >}}) - Storage configuration and persistent volume recommendations + +## Deployment recommendations + +Optimize your Redis Enterprise deployment configuration: + +- [Sizing on Kubernetes]({{< relref "/operate/kubernetes/recommendations/sizing-on-kubernetes" >}}) - Guidelines for sizing clusters and databases +- [Pod stability]({{< relref "/operate/kubernetes/recommendations/pod-stability" >}}) - Ensure stable pod operations and prevent disruptions + +## Performance optimization + +Configure your deployment for optimal performance and reliability based on your workload requirements and infrastructure capabilities. diff --git a/content/operate/kubernetes/reference/_index.md b/content/operate/kubernetes/reference/_index.md index a72577160c..6a1196188c 100644 --- a/content/operate/kubernetes/reference/_index.md +++ b/content/operate/kubernetes/reference/_index.md @@ -5,14 +5,99 @@ categories: - docs - operate - kubernetes -description: Reference material for the operator, cluster, and database deployment - options. -hideListLinks: false +description: API reference and guides for managing Redis Enterprise custom resources on Kubernetes. +hideListLinks: true linkTitle: Reference weight: 89 --- -This section contains the API reference for Redis custom resources and supported distributions. +Reference documentation for Redis Enterprise custom resources, including API specifications and practical guides for creating, configuring, and managing Redis Enterprise deployments on Kubernetes. +## Working with custom resources +Redis Enterprise for Kubernetes uses custom resources to manage clusters and databases. You can create, modify, and delete these resources using standard Kubernetes tools. +### Creating custom resources + +Create custom resources using `kubectl apply` with YAML manifests: + +```bash +kubectl apply -f my-redis-cluster.yaml +kubectl apply -f my-redis-database.yaml +``` + +### Viewing custom resources + +List and inspect existing custom resources: + +```bash +# List Redis Enterprise clusters +kubectl get rec + +# List Redis Enterprise databases +kubectl get redb + +# List Active-Active databases +kubectl get reaadb + +# List remote clusters +kubectl get rerc + +# Get detailed information about a specific resource +kubectl describe rec my-cluster +kubectl describe redb my-database +``` + +### Modifying custom resources + +Update custom resources by editing the YAML manifest and reapplying: + +```bash +# Edit and apply updated manifest +kubectl apply -f updated-redis-cluster.yaml + +# Or edit directly (not recommended for production) +kubectl edit rec my-cluster +kubectl edit redb my-database +``` + +### Deleting custom resources + +Remove custom resources when no longer needed: + +```bash +kubectl delete redb my-database +kubectl delete rec my-cluster +``` + +**Important:** Always delete databases (REDB) before deleting the cluster (REC) to ensure proper cleanup. + +## API reference + +Complete API specifications for all Redis Enterprise custom resources: + +### Core resources + +- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) - Manage Redis Enterprise clusters +- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}) - Manage Redis databases + +### Active-Active resources + +- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}}) - Manage Active-Active databases +- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}}) - Configure remote cluster connections + +## Compatibility + +Information about supported Kubernetes distributions and versions: + +- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) - Compatible Kubernetes platforms and versions + +## Best practices + +When working with custom resources: + +- **Use version control**: Store your YAML manifests in version control systems +- **Validate before applying**: Use `kubectl apply --dry-run=client` to validate changes +- **Monitor resource status**: Check resource status after applying changes +- **Follow naming conventions**: Use consistent naming for easier management +- **Document configurations**: Add annotations and labels to describe resource purpose \ No newline at end of file diff --git a/content/operate/kubernetes/security/_index.md b/content/operate/kubernetes/security/_index.md index bfa38e1a6b..58462bf151 100644 --- a/content/operate/kubernetes/security/_index.md +++ b/content/operate/kubernetes/security/_index.md @@ -5,12 +5,31 @@ categories: - docs - operate - kubernetes -description: Security settings and configuration for Redis Enterprise for Kubernetes -hideListLinks: false +description: Configure security settings for Redis Enterprise clusters and databases on Kubernetes. +hideListLinks: true linkTitle: Security weight: 50 --- -This section contains security settings and configuration for Redis Enterprise for Kubernetes. +Configure security settings for your Redis Enterprise deployment on Kubernetes. Redis Enterprise for Kubernetes provides comprehensive security features including TLS encryption, authentication, access control, and certificate management. +## Credentials and authentication +Manage cluster credentials and authentication settings: + +- [Manage REC credentials]({{< relref "/operate/kubernetes/security/manage-rec-credentials" >}}) - Configure and manage Redis Enterprise cluster credentials +- [LDAP authentication]({{< relref "/operate/kubernetes/security/ldap" >}}) - Integrate with LDAP for centralized authentication + +## Certificates and encryption + +Configure TLS certificates and encryption for secure communications: + +- [Manage REC certificates]({{< relref "/operate/kubernetes/security/manage-rec-certificates" >}}) - Configure cluster certificates for TLS encryption +- [Add client certificates]({{< relref "/operate/kubernetes/security/add-client-certificates" >}}) - Set up client certificate authentication for databases +- [Internode encryption]({{< relref "/operate/kubernetes/security/internode-encryption" >}}) - Enable encryption between cluster nodes + +## Resource management + +Configure security-related resource settings: + +- [Allow resource adjustment]({{< relref "/operate/kubernetes/security/allow-resource-adjustment" >}}) - Enable automatic adjustment of system resources for security compliance diff --git a/content/operate/kubernetes/upgrade/_index.md b/content/operate/kubernetes/upgrade/_index.md index 11122f7c28..c45319c34c 100644 --- a/content/operate/kubernetes/upgrade/_index.md +++ b/content/operate/kubernetes/upgrade/_index.md @@ -5,23 +5,30 @@ categories: - docs - operate - kubernetes -description: Information about upgrading your Redis Enterprise cluster on Kubernetes. -hideListLinks: true +description: Upgrade Redis Enterprise operator, clusters, and databases on Kubernetes. +hideListLinks: false linkTitle: Upgrade weight: 15 --- -The upgrade process includes updating three components: +Keep your Redis Enterprise deployment up to date with the latest features, security patches, and bug fixes. The upgrade process involves updating three main components in sequence: the Redis Enterprise operator, Redis Enterprise clusters (REC), and Redis Enterprise databases (REDB). - 1. Upgrade the Redis Enterprise operator - 2. Upgrade the Redis Enterprise cluster (REC) - 3. Upgrade Redis Enterprise databases (REDB) +## Upgrade methods -If you installed using Helm charts, see [Upgrade the chart]({{}}) for Helm-specific upgrade instructions. +Choose the appropriate upgrade method for your deployment: -If you are using OpenShift, see [Upgrade Redis Enterprise with OpenShift CLI]({{}}) or [Upgrade Redis Enterprise with OpenShift OperatorHub]({{}}). +- [Upgrade Redis Enterprise for Kubernetes]({{}}) - Standard upgrade process for most Kubernetes distributions +- [Upgrade with OpenShift CLI]({{}}) - OpenShift-specific upgrade using CLI tools +- [Upgrade with OpenShift OperatorHub]({{}}) - Upgrade using OpenShift OperatorHub and OLM +- [Upgrade with Helm]({{}}) - Helm-specific upgrade instructions for chart-based deployments -For all other Kubernetes distributions, see [Upgrade Redis Enterprise for Kubernetes]({{}}). +## Upgrade process + +The upgrade process includes updating three components in order: + +1. **Upgrade the Redis Enterprise operator** - Update the operator to the latest version +2. **Upgrade the Redis Enterprise cluster (REC)** - Update cluster nodes and infrastructure +3. **Upgrade Redis Enterprise databases (REDB)** - Update database versions and configurations ## Upgrade compatibility diff --git a/content/operate/kubernetes/upgrade/upgrade-redis-cluster.md b/content/operate/kubernetes/upgrade/upgrade-redis-cluster.md index 746daeea68..03b17202f8 100644 --- a/content/operate/kubernetes/upgrade/upgrade-redis-cluster.md +++ b/content/operate/kubernetes/upgrade/upgrade-redis-cluster.md @@ -1,5 +1,5 @@ --- -Title: Upgrade Redis Enterprise for Kubernetes 7.8.2-6 +Title: Upgrade Redis Enterprise for Kubernetes alwaysopen: false categories: - docs @@ -19,25 +19,25 @@ Redis implements rolling updates for software upgrades in Kubernetes deployments ## Prerequisites -The following steps ensure you have the minimum versions of all components necessary to upgrade to 7.8.2-6. **Without these minimum versions, the upgrade will freeze and require manual recovery.** +Before upgrading, ensure you have the minimum versions of all components necessary for your target version. **Without these minimum versions, the upgrade may freeze and require manual recovery.** See the [troubleshooting](#troubleshooting) section for details on recovering a failed upgrade. ### Kubernetes version -Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported by 7.8.2-6. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. +Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported by your target Redis Enterprise operator version. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. ### Redis operator version -Your Redis Enterprise clusters must be running version 7.4.2-2 or later before upgrading to 7.8.2-6. See the [7.4 upgrade](https://redis.io/docs/latest/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster/) for detailed steps. +Check the [Redis Enterprise for Kubernetes release notes]({{}}) for the minimum operator version required for your target upgrade. Some versions may require intermediate upgrades. ### Redis database version -Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). +Check the release notes for your target version to determine the minimum Redis database version required. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). -### RHEL9-compatible modules +### Module compatibility -Upgrading to Redis operator version 7.8.2-6 involves migrating your Redis Enterprise nodes to RHEL9 from either Ubuntu 18 or RHEL8. If your databases use modules, you need to manually install modules compatible with RHEL9. +Some Redis Enterprise operator versions may require specific module versions or involve changes to the underlying operating system. If your databases use modules, check the release notes for your target version to determine if you need to manually install updated modules. To see which modules you have installed, run: @@ -70,7 +70,7 @@ helm upgrade redis/redis-enterprise-operator --version ``` For OpenShift installations, include the `openshift.mode=true` parameter: @@ -160,7 +160,7 @@ We recommend upgrading the REC as soon as possible after updating the operator. The Redis Enterprise cluster (REC) can be updated automatically or manually. To trigger automatic upgrade of the REC after the operator upgrade completes, specify `autoUpgradeRedisEnterprise: true` in your REC spec. If you don't have automatic upgrade enabled, follow the below steps for the manual upgrade. -Before beginning the upgrade of the Redis Enterprise cluster, check the [Redis Enterprise for Kubernetes release notes]({{}}) to find the Redis Enterprise image tag. +Before beginning the upgrade of the Redis Enterprise cluster, check the [Redis Enterprise for Kubernetes release notes]({{}}) to find the Redis Enterprise image tag for your target version. After the operator upgrade is complete, you can upgrade Redis Enterprise cluster (REC). @@ -216,7 +216,7 @@ kubectl rollout status sts ### Upgrade databases -After the cluster is upgraded, you can upgrade your databases. To upgrade your REDB, specify your new database version in the `spec.redisVersion` field in the REDB custom resources. Supported database versions for operator versions include `"7.2"` and `"7.4"` (note this value is a string). +After the cluster is upgraded, you can upgrade your databases. To upgrade your REDB, specify your new database version in the `spec.redisVersion` field in the REDB custom resources. Check the release notes for your operator version to see which database versions are supported (note this value is a string). To upgrade your REAADB, see [Upgrade an Active-Active database]({{}}) for details on the `rladmin` and `crdb-cli` commands required. Reach out to Redis support if you have additional questions.