You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
RS: Add REST API method to enable OSS Cluster API & rladmin tune db command to change preferred IP type (#1200)
* DOC-3885 RS: Add REST API method to enable OSS Cluster API & rladmin tune db command to change preferred IP type
* DOC-3885 Feedback update to add REST API option to the enable OSS cluster API intro
Copy file name to clipboardExpand all lines: content/operate/rs/databases/configure/oss-cluster-api.md
+32-3Lines changed: 32 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,11 +30,11 @@ The OSS Cluster API setting applies to individual databases instead of the entir
30
30
31
31
## Enable OSS Cluster API support
32
32
33
-
You can use the Cluster Manager UI or the `rladmin` utility to enable OSS Cluster API support for a database.
33
+
You can use the Cluster Manager UI, the `rladmin` utility, or the REST API to enable OSS Cluster API support for a database.
34
34
35
35
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.
36
36
37
-
### Cluster Manager UI
37
+
### Cluster Manager UI method
38
38
39
39
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" >}}).
40
40
@@ -54,7 +54,7 @@ To enable the OSS Cluster API for an existing database in the Cluster Manager UI
54
54
55
55
You can also use the Cluster Manager UI to enable the setting when creating a new database.
56
56
57
-
### Commandline (`rladmin`)
57
+
### Command-line method
58
58
59
59
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.
60
60
@@ -75,6 +75,25 @@ $ rladmin info db test | grep oss_cluster:
75
75
76
76
The OSS Cluster API setting applies to the specified database only; it does not apply to the cluster.
77
77
78
+
### REST API method
79
+
80
+
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:
81
+
82
+
```sh
83
+
POST /v1/bdbs
84
+
{
85
+
"oss_cluster": true,
86
+
// Other database configuration parameters
87
+
}
88
+
```
89
+
90
+
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:
91
+
92
+
```sh
93
+
PUT /v1/bdbs/<database-id>
94
+
{ "oss_cluster": true }
95
+
```
96
+
78
97
### Active-Active databases
79
98
80
99
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.
@@ -110,6 +129,16 @@ To enable the OSS Cluster API for an existing Active-Active database with `crdb-
110
129
--oss-cluster true
111
130
```
112
131
132
+
## Change preferred IP type
133
+
134
+
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.
135
+
136
+
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">}}) commandfor each affected database:
137
+
138
+
```sh
139
+
$ rladmin tune db db:<database-id> oss_cluster_api_preferred_ip_type external
140
+
```
141
+
113
142
## Turn off OSS Cluster API support
114
143
115
144
To deactivate OSS Cluster API support for a database, either:
0 commit comments