From 65b5d681821f11952b44d1919c9aec3bd029345f Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 21 Feb 2025 15:45:05 -0600 Subject: [PATCH 1/2] DOC-3885 RS: Add REST API method to enable OSS Cluster API & rladmin tune db command to change preferred IP type --- .../rs/databases/configure/oss-cluster-api.md | 33 +++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/content/operate/rs/databases/configure/oss-cluster-api.md b/content/operate/rs/databases/configure/oss-cluster-api.md index cd04e9f103..36839a2379 100644 --- a/content/operate/rs/databases/configure/oss-cluster-api.md +++ b/content/operate/rs/databases/configure/oss-cluster-api.md @@ -34,7 +34,7 @@ You can use the Cluster Manager UI or the `rladmin` utility to enable OSS Cluste When you enable OSS Cluster API support for an existing database, the change applies to new connections but does not affect existing connections. Clients must close existing connections and reconnect to apply the change. -### Cluster Manager UI +### Cluster Manager UI method When you use the Cluster Manager UI to enable the OSS Cluster API, it automatically configures the [prerequisites]({{< relref "/operate/rs/databases/configure/oss-cluster-api#prerequisites" >}}). @@ -54,7 +54,7 @@ To enable the OSS Cluster API for an existing database in the Cluster Manager UI You can also use the Cluster Manager UI to enable the setting when creating a new database. -### Command line (`rladmin`) +### Command-line method You can use the [`rladmin` utility]({{< relref "/operate/rs/references/cli-utilities/rladmin/" >}}) to enable the OSS Cluster API for Redis Enterprise Software databases, including Replica Of databases. @@ -75,6 +75,25 @@ $ rladmin info db test | grep oss_cluster: The OSS Cluster API setting applies to the specified database only; it does not apply to the cluster. +### REST API method + +You can enable the OSS Cluster API when you [create a database]({{}}) using the REST API: + +```sh +POST /v1/bdbs +{ + "oss_cluster": true, + // Other database configuration parameters +} +``` + +To enable the OSS Cluster API for an existing database, you can use an [update database configuration]({{}}) REST API request: + +```sh +PUT /v1/bdbs/ +{ "oss_cluster": true } +``` + ### Active-Active databases The OSS Cluster API setting applies to all instances of the Active-Active database across participating clusters. To enable the OSS Cluster API for Active-Active databases, use the [Cluster Manager UI](#cluster-manager-ui) or the [`crdb-cli`]({{}}) utility. @@ -110,6 +129,16 @@ To enable the OSS Cluster API for an existing Active-Active database with `crdb- --oss-cluster true ``` +## Change preferred IP type + +By default, using [`CLUSTER SLOTS`]({{}}) and [`CLUSTER SHARDS`]({{}}) in a Redis Enterprise Software cluster exposes the internal IP addresses for databases with the OSS Cluster API enabled. + +To use external IP addresses instead of internal IP addresses, run the following [`rladmin tune db`]({{}}) command for each affected database: + +```sh +$ rladmin tune db db: oss_cluster_api_preferred_ip_type external +``` + ## Turn off OSS Cluster API support To deactivate OSS Cluster API support for a database, either: From 7ab1d27dd35dd840837459f33aeda96d2dba8903 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 7 Mar 2025 13:30:51 -0500 Subject: [PATCH 2/2] DOC-3885 Feedback update to add REST API option to the enable OSS cluster API intro --- content/operate/rs/databases/configure/oss-cluster-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/rs/databases/configure/oss-cluster-api.md b/content/operate/rs/databases/configure/oss-cluster-api.md index 36839a2379..e32051aedd 100644 --- a/content/operate/rs/databases/configure/oss-cluster-api.md +++ b/content/operate/rs/databases/configure/oss-cluster-api.md @@ -30,7 +30,7 @@ The OSS Cluster API setting applies to individual databases instead of the entir ## Enable OSS Cluster API support -You can use the Cluster Manager UI or the `rladmin` utility to enable OSS Cluster API support for a database. +You can use the Cluster Manager UI, the `rladmin` utility, or the REST API to enable OSS Cluster API support for a database. When you enable OSS Cluster API support for an existing database, the change applies to new connections but does not affect existing connections. Clients must close existing connections and reconnect to apply the change.