Skip to content

Commit 00a5a0a

Browse files
committed
Merge branch 'release-rs-fuya-fuya' into DOC-4307
2 parents 7c3b601 + e156ffb commit 00a5a0a

File tree

4 files changed

+107
-26
lines changed

4 files changed

+107
-26
lines changed

content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md

Lines changed: 87 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ If you do not have a cluster that supports Redis Query Engine, [install Redis En
3434

3535
1. [Determine the query performance factor](#calculate-performance-factor) you want and the required number of CPUs. Unused CPUs, above the 20% necessary for Redis, can be used for the scalable Redis Query Engine.
3636

37-
1. Create a new Redis database with the number of CPUs configured for the Query performance factor.
37+
1. Create a new Redis database with the number of CPUs configured for the query performance factor.
3838

39-
## Calculate performance factor
39+
## Calculate query performance factor
4040

4141
### CPUs for query performance factor
4242

@@ -73,11 +73,92 @@ The following table shows the number of CPUs required for each performance facto
7373
| Scale factor | 4x |
7474
| Minimum CPUs required for scale factor | 6 |
7575

76-
## Configure query performance factor
76+
## Configure query performance factor manually
7777

78-
To configure the query performance factor in Redis Enterprise, use the [REST API]({{<relref "/operate/rs/references/rest-api">}}) to create a new database or update an existing database.
78+
To manually configure the query performance factor in Redis Enterprise Software:
7979

80-
### Create new database
80+
1. [Configure query performance factor parameters](#config-db-ui) when you create a new database or edit an existing database's configuration in the Cluster Manager UI.
81+
82+
1. If you configure the query performance factor for an existing database, you also need to [restart shards](#restart-shards). Newly created databases can skip this step.
83+
84+
### Configure query performance factor parameters in the Cluster Manager UI {#config-db-ui}
85+
86+
You can use the Cluster Manager UI to configure the query performance factor when you [create a new database]({{<relref "/operate/rs/databases/create">}}) or [edit an existing database]({{<relref "/operate/rs/databases/configure#edit-database-settings">}}) with search enabled.
87+
88+
1. In the **Capabilities** section of the database configuration screen, click **Parameters**.
89+
90+
1. If you are creating a new database, select **Search and query**.
91+
92+
1. Adjust the **RediSearch** parameters to include:
93+
94+
`MT_MODE MT_MODE_FULL WORKER_THREADS <NUMBER_OF_THREADS>`
95+
96+
See [Calculate query performance factor](#calculate-query-performance-factor) to determine the minimum CPUs required to use for `<NUMBER_OF_THREADS>`.
97+
98+
1. Expand the **Query Performance Factor** section and enter the following values:
99+
100+
- `mnp` for **Connections routing**
101+
102+
- `32` for **Connections limit**
103+
104+
{{<image filename="images/rs/screenshots/databases/rs-config-query-performance-factor.png" alt="Configure search parameters and query performance factor.">}}
105+
106+
1. Click **Done** to close the parameter editor.
107+
108+
1. Click **Create** or **Save**.
109+
110+
### Restart shards {#restart-shards}
111+
112+
After you update the query performance factor for an existing database, restart all shards to apply the new settings. You can migrate shards to restart them. Newly created databases can skip this step.
113+
114+
1. Use [`rladmin status shards db <db-name>`]({{<relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards">}}) to list all shards for your database:
115+
116+
```sh
117+
rladmin status shards db db-name
118+
```
119+
120+
Example output:
121+
122+
```sh
123+
SHARDS:
124+
DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
125+
db:2 db-name redis:1 node:1 master 0-16383 1.95MB OK
126+
db:2 db-name redis:2 node:2 slave 0-16383 1.95MB OK
127+
```
128+
129+
Note the following fields for the next steps:
130+
- `ID`: the Redis shard's ID.
131+
- `NODE`: the node on which the shard currently resides.
132+
- `ROLE`: `master` is a primary shard; `slave` is a replica shard.
133+
134+
1. For each replica shard, use [`rladmin migrate shard`]({{<relref "/operate/rs/references/cli-utilities/rladmin/migrate">}}) to move it to a different node and restart it:
135+
136+
```sh
137+
rladmin migrate shard <shard_id> target_node <node_id>
138+
```
139+
140+
1. After you migrate the replica shards, migrate the original primary shards.
141+
142+
1. Rerun `rladmin status shards db <db-name>` to verify the shards migrated to different nodes:
143+
144+
```sh
145+
rladmin status shards db db-name
146+
```
147+
148+
Example output:
149+
150+
```sh
151+
SHARDS:
152+
DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
153+
db:2 db-name redis:1 node:2 master 0-16383 1.95MB OK
154+
db:2 db-name redis:2 node:1 slave 0-16383 1.95MB OK
155+
```
156+
157+
## Configure query performance factor with the REST API
158+
159+
You can configure the query performance factor when you [create a new database](#create-db-rest-api) or [update an existing database](#update-db-rest-api) using the Redis Enterprise Software [REST API]({{<relref "/operate/rs/references/rest-api">}}).
160+
161+
### Create new database with the REST API {#create-db-rest-api}
81162
82163
To create a database and configure the query performance factor, use the [create database REST API endpoint]({{<relref "/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v1">}}) with a [BDB object]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}) that includes the following parameters:
83164
@@ -126,7 +207,7 @@ The following [cURL](https://curl.se/docs/) request creates a new database from
126207
curl -k -u "<user>:<password>" https://<host>:9443/v1/bdbs -H "Content-Type:application/json" -d @scalable-search-db.json
127208
```
128209
129-
### Update existing database
210+
### Update existing database with the REST API {#update-db-rest-api}
130211
131212
To configure the query performance factor for an existing database, use the following REST API requests:
132213

content/operate/rs/release-notes/rs-7-8-releases/_index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
Title: Redis Software release notes 7.8.0
2+
Title: Redis Software release notes 7.8.2
33
alwaysopen: false
44
categories:
55
- docs
@@ -8,12 +8,12 @@ categories:
88
compatibleOSSVersion: Redis 7.4.0
99
description: Client-side caching support. New APIs to check database availability, rebalance shards, fail over shards, and control database traffic. Cluster Manager UI enhancements for node actions, database tags, and database configuration. Log rotation based on both size and time. Module management enhancements. V2 Prometheus metrics. Configurable minimum password length. Configurable license expiration alert threshold.
1010
hideListLinks: true
11-
linkTitle: 7.8.0 releases
11+
linkTitle: 7.8.2 releases
1212
toc: 'true'
1313
weight: 69
1414
---
1515

16-
[​Redis Software version 7.8.0](https://redis.com/redis-enterprise-software/download-center/software/) is now available!
16+
[​Redis Software version 7.8.2](https://redis.com/redis-enterprise-software/download-center/software/) is now available!
1717

1818
## Highlights
1919

@@ -47,7 +47,7 @@ For more detailed release notes, select a build version from the following table
4747

4848
### Breaking changes
4949

50-
Redis Software version 7.8.0 introduces the following breaking changes:
50+
Redis Software version 7.8.2 introduces the following breaking changes:
5151

5252
- When you upgrade a database, the upgrade process also attempts to upgrade database modules by default.
5353

@@ -131,21 +131,21 @@ New Redis modules will not be available for download from the Redis download cen
131131

132132
#### Legacy UI not supported
133133

134-
The legacy UI was deprecated in favor of the new Cluster Manager UI in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.0.
134+
The legacy UI was deprecated in favor of the new Cluster Manager UI in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.2.
135135

136136
#### Redis 6.0 databases not supported
137137

138-
Redis database version 6.0 was deprecated in Redis Software version 7.4.2 and is no longer supported as of Redis Software version 7.8.0.
138+
Redis database version 6.0 was deprecated in Redis Software version 7.4.2 and is no longer supported as of Redis Software version 7.8.2.
139139

140-
To prepare for the removal of Redis database version 6.0 before you upgrade to Redis Software version 7.8.0:
140+
To prepare for the removal of Redis database version 6.0 before you upgrade to Redis Software version 7.8.2:
141141

142142
- For Redis Software 6.2.* clusters, upgrade Redis 6.0 databases to Redis 6.2. See the [Redis 6.2 release notes](https://raw.githubusercontent.com/redis/redis/6.2/00-RELEASENOTES) for the list of changes.
143143

144144
- For Redis Software 7.2.4 and 7.4.2 clusters, upgrade Redis 6.0 databases to Redis 7.2. Before you upgrade your databases, see the list of [Redis 7.2 breaking changes]({{< relref "/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-52#redis-72-breaking-changes" >}}) and update any applications that connect to your database to handle these changes.
145145

146146
#### Ubuntu 18.04 not supported
147147

148-
Ubuntu 18.04 was deprecated in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.0.
148+
Ubuntu 18.04 was deprecated in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.2.
149149

150150
### Upcoming changes
151151

content/operate/rs/release-notes/rs-7-8-releases/rs-7-8-0-tba.md renamed to content/operate/rs/release-notes/rs-7-8-releases/rs-7-8-2-tba.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
Title: Redis Software release notes 7.8.0-tba (October 2024)
2+
Title: Redis Software release notes 7.8.2-tba (October 2024)
33
alwaysopen: false
44
categories:
55
- docs
66
- operate
77
- rs
88
compatibleOSSVersion: Redis 7.4.0
99
description: Client-side caching support. New APIs to check database availability, rebalance shards, fail over shards, and control database traffic. Cluster Manager UI enhancements for node actions, database tags, and database configuration. Log rotation based on both size and time. Module management enhancements. V2 Prometheus metrics. Configurable minimum password length. Configurable license expiration alert threshold.
10-
linkTitle: 7.8.0-tba (October 2024)
10+
linkTitle: 7.8.2-tba (October 2024)
1111
weight: 90
1212
---
1313

14-
[​Redis Software version 7.8.0](https://redis.com/redis-enterprise-software/download-center/software/) is now available!
14+
[​Redis Software version 7.8.2](https://redis.com/redis-enterprise-software/download-center/software/) is now available!
1515

1616
## Highlights
1717

@@ -47,7 +47,7 @@ This version offers:
4747

4848
- For more information, see the [client-side caching introduction]({{<relref "/develop/connect/clients/client-side-caching">}}) and [client-side caching compatibility with Redis Software]({{<relref "/operate/rs/references/compatibility/client-side-caching">}}).
4949

50-
- [Database availability API](<!--TODO: Add link-->), which verifies whether a Redis Software database is available to peform read and write operations and can respond to queries from client applications. Load balancers and automated monitoring tools can use this API to monitor database availability.
50+
- [Database availability API]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability">}}), which verifies whether a Redis Software database is available to perform read and write operations and can respond to queries from client applications. Load balancers and automated monitoring tools can use this API to monitor database availability.
5151

5252
- [Rebalance shard placement REST API request](<!--TODO: Add REST API ref link-->), which distributes the database's shards across nodes based on the database's shard placement policy. See [Shard placement policy]({{<relref "/operate/rs/databases/memory-performance/shard-placement-policy">}}) for more information about shard placement and available policies.
5353

@@ -95,7 +95,7 @@ This version offers:
9595

9696
#### Redis module feature sets
9797

98-
Redis Software comes packaged with several modules. As of version 7.8.0, Redis Software includes three feature sets, compatible with different Redis database versions.
98+
Redis Software comes packaged with several modules. As of version 7.8.2, Redis Software includes three feature sets, compatible with different Redis database versions.
9999

100100
The following table shows which Redis modules are compatible with each Redis database version included in this release.
101101

@@ -153,7 +153,7 @@ The following table shows which Redis modules are compatible with each Redis dat
153153

154154
### Breaking changes
155155

156-
Redis Software version 7.8.0 introduces the following breaking changes:
156+
Redis Software version 7.8.2 introduces the following breaking changes:
157157

158158
- When you upgrade a database, the upgrade process also attempts to upgrade database modules by default.
159159

@@ -237,21 +237,21 @@ New Redis modules will not be available for download from the Redis download cen
237237

238238
#### Legacy UI not supported
239239

240-
The legacy UI was deprecated in favor of the new Cluster Manager UI in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.0.
240+
The legacy UI was deprecated in favor of the new Cluster Manager UI in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.2.
241241

242242
#### Redis 6.0 databases not supported
243243

244-
Redis database version 6.0 was deprecated in Redis Software version 7.4.2 and is no longer supported as of Redis Software version 7.8.0.
244+
Redis database version 6.0 was deprecated in Redis Software version 7.4.2 and is no longer supported as of Redis Software version 7.8.2.
245245

246-
To prepare for the removal of Redis database version 6.0 before you upgrade to Redis Software version 7.8.0:
246+
To prepare for the removal of Redis database version 6.0 before you upgrade to Redis Software version 7.8.2:
247247

248248
- For Redis Software 6.2.* clusters, upgrade Redis 6.0 databases to Redis 6.2. See the [Redis 6.2 release notes](https://raw.githubusercontent.com/redis/redis/6.2/00-RELEASENOTES) for the list of changes.
249249

250250
- For Redis Software 7.2.4 and 7.4.2 clusters, upgrade Redis 6.0 databases to Redis 7.2. Before you upgrade your databases, see the list of [Redis 7.2 breaking changes]({{< relref "/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-52#redis-72-breaking-changes" >}}) and update any applications that connect to your database to handle these changes.
251251

252252
#### Ubuntu 18.04 not supported
253253

254-
Ubuntu 18.04 was deprecated in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.0.
254+
Ubuntu 18.04 was deprecated in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.2.
255255

256256
### Upcoming changes
257257

@@ -300,7 +300,7 @@ The following table provides a snapshot of supported platforms as of this Redis
300300

301301
The following table shows the SHA256 checksums for the available packages:
302302

303-
| Package | SHA256 checksum (7.8.0-tba Oct release) |
303+
| Package | SHA256 checksum (7.8.2-tba Oct release) |
304304
|---------|---------------------------------------|
305305
| Ubuntu 20 | <span class="break-all"></span> |
306306
| Red Hat Enterprise Linux (RHEL) 8 | <span class="break-all"></span> |
@@ -335,7 +335,7 @@ As part of Redis's commitment to security, Redis Software implements the latest
335335

336336
Some CVEs announced for open source Redis do not affect Redis Software due to different or additional functionality available in Redis Software that is not available in open source Redis.
337337

338-
Redis Software 7.8.0-tba supports open source Redis 7.4, 7.2, and 6.2. Below is the list of open source Redis CVEs fixed by version.
338+
Redis Software 7.8.2-tba supports open source Redis 7.4, 7.2, and 6.2. Below is the list of open source Redis CVEs fixed by version.
339339

340340
Redis 7.2.x:
341341

112 KB
Loading

0 commit comments

Comments
 (0)