Skip to content

RC: OSS Cluster API Changes #2222

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.

Sign up for GitHub

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 2 commits into from
Oct 23, 2025
+8 −8
Merged

RC: OSS Cluster API Changes #2222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
809c524
OSS Cluster API Changes
cmilesb Oct 8, 2025
3f52bcc
Apply suggestions from code review
cmilesb Oct 8, 2025
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
4 changes: 0 additions & 4 deletions content/embeds/oss-cluster-api-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,3 @@ and then they connect directly to the Redis proxy on each node that hosts a mast
You must use a client that supports the cluster API to connect to a database
that has the cluster API enabled.
{{< /note >}}

{{< warning >}}
Kubernetes limitation: OSS Cluster API can only be used by clients running within the same Kubernetes cluster as the Redis Enterprise pods. External clients cannot use OSS Cluster API due to pod IP address accessibility limitations.
{{< /warning >}}
8 changes: 4 additions & 4 deletions content/operate/rc/databases/configuration/clustering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,14 @@ These changes include:
- **PCRE_ANCHORED:** the pattern is constrained to match only at
the start of the string which is being searched.

## Cluster API {#oss-cluster-api}
## OSS Cluster API {#oss-cluster-api}

{{< embed-md "oss-cluster-api-intro.md" >}}

The Cluster API is only supported on Redis Cloud Pro databases. You can enable it in the Performance section of the configuration screen.
The OSS Cluster API is only supported on Redis Cloud Pro databases. You can enable it in the **Performance** section of the configuration screen.

After you select OSS Cluster API, you can select **Use external endpoint** if you want to use the external endpoint for the database. Selecting **Use external endpoint** will block the private endpoint for this database.

The Redis Cluster API is supported only when a database uses the [standard hashing policy](#standard-hashing-policy) and does not use Search and Query or Time Series advanced capabilities.
The OSS Cluster API is supported only when a database uses the [standard hashing policy](#standard-hashing-policy).

Review [Redis Cluster API architecture]({{< relref "/operate/rs/clusters/optimize/oss-cluster-api" >}}) to determine if you should enable this feature for your database.
Review [OSS Cluster API architecture]({{< relref "/operate/rs/clusters/optimize/oss-cluster-api" >}}) to determine if you should enable this feature for your database.
4 changes: 4 additions & 0 deletions content/operate/rs/clusters/optimize/oss-cluster-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ weight: $weight
---
{{< embed-md "oss-cluster-api-intro.md" >}}

{{< warning >}}
Kubernetes limitation: OSS Cluster API can only be used by clients running within the same Kubernetes cluster as the Redis Enterprise pods. External clients cannot use OSS Cluster API due to pod IP address accessibility limitations.
{{< /warning >}}

You can use the Redis OSS Cluster API along with other Redis Enterprise Software high availability
to get high performance with low latency
and let applications stay current with cluster topology changes, including add node, remove node, and node failover.
Expand Down