Skip to content

Commit a6a5785

Browse files
authored
RS: DB config doc fixes that apply to 7.4.x (#596)
* DOC-4174 Remove legacy UI instruction for configuring A-A DBs * DOC-4174 Fix the clustering section of DB config to match the new UI * DOC-4174 Add database version to DB config to match the new UI
1 parent 12fc404 commit a6a5785

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

content/operate/rs/databases/configure/_index.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ To edit the configuration of a database using the Cluster Manager UI:
3939
1. Change any [configurable database settings](#config-settings).
4040

4141
{{< note >}}
42-
For [Active-Active database instances]({{< relref "/operate/rs/databases/active-active" >}}), most database settings only apply to the instance that you are editing. To manage Active-Active databases, use the legacy UI.
42+
For [Active-Active database instances]({{< relref "/operate/rs/databases/active-active" >}}), most database settings only apply to the instance that you are editing.
4343
{{< /note >}}
4444

4545
1. Select **Save**.
4646

4747
## Configuration settings {#config-settings}
4848

49+
- **Database version** - Select the Redis version when you create a database.
50+
4951
- **Name** - The database name requirements are:
5052

5153
- Maximum of 63 characters
@@ -102,30 +104,34 @@ You cannot enable them after database creation.
102104

103105
### Clustering
104106

105-
- **Database clustering** - You can either:
106-
- Enable [database clustering]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) and select the number of database shards.
107+
- **Sharding** - You can either:
108+
- Turn on **Sharding** to enable [database clustering]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) and select the number of database shards.
107109

108110
When database clustering is enabled, databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}).
109111
110112
You can increase the number of shards in the database at any time.
111113

112114
You can accept the [standard hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#standard-hashing-policy" >}}), which is compatible with Redis Community Edition, or define a [custom hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#custom-hashing-policy" >}}) to define where keys are located in the clustered database.
113115

114-
- Clear the **Database clustering** option to use only one shard so that you can use [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) without the limitations.
116+
- Turn off **Sharding** to use only one shard so that you can use [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) without the limitations.
115117

116-
- Sharding
118+
- [**OSS Cluster API**]({{< relref "/operate/rs/databases/configure/oss-cluster-api.md" >}}) - The OSS Cluster API configuration allows access to multiple endpoints for increased throughput.
117119

118-
- [**OSS Cluster API**]({{< relref "/operate/rs/databases/configure/oss-cluster-api.md" >}}) - {{< embed-md "oss-cluster-api-intro.md" >}}
120+
This configuration requires clients to connect to the primary node to retrieve the cluster topology before they can connect directly to proxies on each node.
121+
122+
When you enable the OSS Cluster API, shard placement changes to _Sparse_, and the database proxy policy changes to _All primary shards_ automatically.
119123

120-
If you enable the OSS Cluster API, the shards placement policy and database proxy policy automatically change to _Sparse_ and _All master shards_.
124+
{{<note>}}
125+
You must use a client that supports the cluster API to connect to a database that has the cluster API enabled.
126+
{{</note>}}
121127

122-
- [**Shards placement policy**]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) - Determines how to distribute database shards across nodes in the cluster.
128+
- [**Shards placement**]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) - Determines how to distribute database shards across nodes in the cluster.
123129

124130
- _Dense_ places shards on the smallest number of nodes.
125131

126132
- _Sparse_ spreads shards across many nodes.
127133

128-
- [**Database proxy policy**]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) - Determines the number and location of active proxies, which manage incoming database operation requests.
134+
- [**Database proxy**]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) - Determines the number and location of active proxies, which manage incoming database operation requests.
129135

130136
### Replica Of
131137

content/operate/rs/databases/configure/db-defaults.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ To configure default shard placement, use one of the following methods:
124124
125125
### Database version
126126
127-
When you create a new database, it uses the default Redis version (**Database version**) unless you specify the database version explicitly with `redis_version` in the [REST API]({{< relref "/operate/rs/references/rest-api/requests/bdbs" >}}).
127+
New databases use the default Redis database version unless you select a different **Database version** when you [create a database]({{<relref "/operate/rs/databases/create">}}) in the Cluster Manager UI or specify the `redis_version` in a [create database REST API request]({{< relref "/operate/rs/references/rest-api/requests/bdbs" >}}).
128128
129129
To configure the Redis database version, use one of the following methods:
130130

0 commit comments

Comments
 (0)