Skip to content

RS: Add REST API method to enable OSS Cluster API & rladmin tune db command to change preferred IP type #1200

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 3 commits into from
Mar 7, 2025
Merged

RS: Add REST API method to enable OSS Cluster API & rladmin tune db command to change preferred IP type #1200

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
65b5d68
DOC-3885 RS: Add REST API method to enable OSS Cluster API & rladmin …
rrelledge Feb 21, 2025
2a3c49f
Merge branch 'main' into DOC-3885
rrelledge Mar 7, 2025
7ab1d27
DOC-3885 Feedback update to add REST API option to the enable OSS clu…
rrelledge Mar 7, 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
35 changes: 32 additions & 3 deletions content/operate/rs/databases/configure/oss-cluster-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ 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.

### 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" >}}).

Expand All @@ -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.

Expand All @@ -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]({{<relref "/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v1">}}) 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]({{<relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs">}}) REST API request:

```sh
PUT /v1/bdbs/<database-id>
{ "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`]({{<relref "/operate/rs/references/cli-utilities/crdb-cli">}}) utility.
Expand Down Expand Up @@ -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`]({{<relref "/commands/cluster-slots">}}) and [`CLUSTER SHARDS`]({{<relref "/commands/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`]({{<relref "operate/rs/references/cli-utilities/rladmin/tune#tune-db">}}) command for each affected database:

```sh
$ rladmin tune db db:<database-id> oss_cluster_api_preferred_ip_type external
```

## Turn off OSS Cluster API support

To deactivate OSS Cluster API support for a database, either:
Expand Down