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
* DOC-4927 Created placeholders for RS April release notes
* DOC-4930 Move resolved issues from Gilboa release notes draft to 7.22 release notes
* DOC-4920 RS: Add fields and descriptions returned by /v1/actions to REST API reference
* DOC-4917 Added reserved ports 9082 and 3351 to release notes draft and reserved ports table
* Removed RedisGraph from release notes draft's feature set table
* DOC-4916 Added 7.18 resolved issues to April release notes draft
* DOC-4935 Added 7.20 resolved issues to RS April release notes draft
* DOC-4917 Added port 3355 to release notes draft and reserved ports table
* DOC-4969 RS: Updated API docs with 7.12.0 changes
* DOC-4705 Added 7.12.0 new features/enhancements to RS April release notes draft
* Added default_oss_cluster to RS cluster_settings REST API reference
* DOC-4976 RS: Added sentinel service to optional services
* RS: Added replica_read_only to BDB REST API object
* DOC-4706 Added 7.14.0 new features/enhancements to RS April release notes draft
* Added robust_crdt_syncer to RS cluster REST API object
* DOC-4915 Added 7.18.0 new features/enhancements to RS April release notes draft
* DOC-4984 RS: Updated API docs with 7.20.0 changes
* DOC-4936 Added 7.20.0 new features/enhancements to RS April release notes draft
* Moved resolved issue RS147991 from April RS release notes draft to 7.8.6 release notes draft
* DOC-4984 RS: Updated API docs with 7.20.0 changes
* DOC-4936 Added 7.20.0 new features/enhancements to RS April release notes draft
* DOC-4920 Added more details about pending_ops structure and fields
* Added missing commas to JSON example
* DOC-4932 Added RS 7.22 to upgrade paths table
* DOC-4934 Added RS 7.22 placeholder to EOL schedule and added EOL for RS 7.8
* DOC-4931 Added RS 7.22 column to supported platforms table
* DOC-4933 Added RS 7.22.x to bundled DB versions table
* DOC-4812 RS: Added /v2/actions REST API reference
* Removed preview notes from metrics stream engine docs
* Added metrics stream engine GA to RS April release notes
* DOC-4980 Added deprecation for internal monitoring/v1 metrics to RS April release notes
* DOC-4932 Upgrading directly from RS 6.2.x to 7.22.x is not supported
* DOC-4920 Fixed pending_ops heartbeat and last_sample_time descriptions in action REST API reference
* DOC-4812 Feedback updates for creation_time, additional_info, heartbeat, and last_sample_time in v2 action REST API reference
* DOC-4812 Feedback update to change v2 actions status type/value to string
* DOC-4971 RS: Added usage_report REST API reference
* DOC-4970 RS: Added migration status REST API reference
* DOC-4970 Added roles to required permissions table for migrations API
* DOC-3959 RS: Added /bdbs/uid/actions/revamp REST API reference
* DOC-3959DOC-4980 RS: Deprecate optimize shard placement action in 7.22 release notes and REST API reference
* DOC-4978 RS: Updated bootstrap and node REST API references for two-dimensional rack awareness
* Add/edit mdescriptions for max_redis_forks and max_slave_full_syncs
* DOC-4978 RS: Updated rladmin reference for two-dimensional rack awareness
* DOC-4978 RS: Document two-dimensional rack awareness setup
* DOC-4978 Fixes and copy edits for two-dimensional rack-zone awareness
* DOC-4980 Copied optimize_shards_placement deprecation note to 7.22 release notes index
* DOC-4927 Removed unused placeholders from RS April release notes
* DOC-4973 RS: Added JSON active degramentation known limitation to RS April release notes
* DOC-4927 RS April release notes edits
* DOC-4937 Added 7.22.0 resolved issues to RS April release notes
* DOC-4937 Added relrefs to RS April release notes new features
* DOC-4978 Feedback update to add more info about when to use two-dimensional rack-zone awareness
* DOC-4927 AUpdated port reserved for authentication_service
* DOC-4927 Deprecated /v2/bdbs recovery_plan's data_files option in favor of the new original_bdb_shards option
* DOC-4927 Added performance improvements to 7.22 release notes
* DOC-4927 Added endpoint availability metrics known issue and workaround to 7.22 release notes
* DOC-4927 Added diagnostic logging service to 7.22 release notes and REST API reference
* DOC-4978 Removed misleading statement from two-dimensional rack-zone awareness description
* DOC-4927 Added FQDN validation method change to version changes in 7.22 release notes
* Fixed versioning mistake for port config change
* Added more detailed diagnostics REST API examples
* Apply suggestions from code review
Co-authored-by: mich-elle-luna <[email protected]>
* Fixed typo
* Update rs-7-22-x-tba.md
Edited wording of v2 actions API
* Update v1_monitoring.md
update wording of v1 monitoring system adding deprecation notice and recommendation to move to v2
* Release notes copy edits related to the new version of the actions API
* Made some formatting/style edits and added links to the v1 monitoring overview
* DOC-5068 RS: Created dedicated diagnostic logging page
* Removed metrics stream engine GA from RS April release notes
* Added preview notes back to metrics stream engine docs
* DOC-5068 Feedback update to clarify the diagnostic logs are overwritten at the scheduled collection interval
* DOC-4929 Added build number and checksums to RS 7.22 release notes
* Added known performance issue to RS 7.22 release notes
* Feedback update for v2 actions description in 7.22 release notes
* RS: Added call home client info to RS 7.22 release notes and REST API reference
* Remove Azure from RS migrations API reference
* Grouped call home and usage reports together in RS 7.22 release notes
* Feedback update - clarify migration API is for Replica Of migration status
* Added known issue RS156391 to 7.22 release notes
* Moved call home client details and config examples from 7.22 release notes into a dedicated page
* Removed RS156570 from 7.22 known issues
* DOC-5156 RS: Add CVE to 7.22 release notes draft
* DOC-5099 Added 7.22.0-34 resolved issue to 7.22 release notes draft
* Updated 7.22 GA build number in release notes draft
* Added more details about call home behavior and purpose
* Added an example of data collected for call home
* Fixed RS 7.22 port info
* Updated build number and month in 7.22 release notes draft
* Changed RS 7.22 release month from April to May in product lifecycle and supported platforms tables
* Added call home protocol and updated collected data example with additional fields
* Added resolved issue to RS 7.22 GA release notes
* RS: Added /v2/actions status values to REST API reference
* Moved RS156391 from known issues to resolved issues in RS 7.22 release notes
* Moved RS156391 back to known issues in RS 7.22 release notes
* Updated build number and checksums for RS 7.22 release
* Updated build number and checksums for RS 7.22 release
---------
Co-authored-by: mich-elle-luna <[email protected]>
Co-authored-by: Maayan Agranat <[email protected]>
Copy file name to clipboardExpand all lines: content/embeds/rs-upgrade-paths.md
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,12 @@
4
4
5
5
<spantitle="X icon">:x:</span> Not supported – You cannot upgrade directly from the current Redis Software cluster version. You must first upgrade to a supported intermediate version.
6
6
7
-
| Current Redis Software cluster version | Upgrade to Redis Software 6.2.x | Upgrade to Redis Software 6.4.x | Upgrade to Redis Software 7.2.x | Upgrade to Redis Software 7.4.x | Upgrade to Redis Software 7.8.x |
Copy file name to clipboardExpand all lines: content/embeds/supported-platforms-embed.md
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -7,23 +7,23 @@ Redis Enterprise Software is supported on several operating systems, cloud envi
7
7
8
8
<spantitle="Warning icon"class="font-serif">:warning:</span> Deprecation warning – The platform is still supported for this version of Redis Enterprise Software, but support will be removed in a future release.
|**Release date**| Nov 2024 | Feb 2024 | Aug 2023 | Feb 2023 | Aug 2021 |
13
-
|[**End-of-life date**]({{< relref "/operate/rs/installing-upgrading/product-lifecycle#endoflife-schedule" >}}) | Determined after<br />next major release | Nov 2026 | Feb 2026 | Aug 2025 | Feb 2025 |
1. <aname="table-note-1"></a>The RHEL-compatible distributions CentOS, CentOS Stream, Alma, and Rocky are supported if they have full RHEL compatibility. Oracle Linux running the Red Hat Compatible Kernel (RHCK) is supported, but the Unbreakable Enterprise Kernel (UEK) is not supported.
description: The call home client sends your Redis Enterprise Software cluster's daily usage statistics to Redis.
10
+
linkTitle: Call home client
11
+
weight: 80
12
+
---
13
+
14
+
The call home client collects data hourly and sends daily usage statistics to Redis with a POST request to `https://usage.redis.io/callHome`. Reports include memory usage, shard details, enabled features, and other operational metrics. To prevent increased load when multiple clusters are running, the daily report is sent at a random time.
15
+
16
+
These reports provide insights into license consumption, which helps Redis to ensure performance metrics align with contractual agreements, optimize service delivery, and offer proactive customer support.
17
+
18
+
We recommend contacting [Redis support](https://redis.io/support/) before making changes to call home behavior.
19
+
20
+
## Collected data
21
+
22
+
The following example shows the data collected hourly for each database:
23
+
24
+
```sh
25
+
{
26
+
"support_package": true,
27
+
"customer_name": "string",
28
+
"license_hash": "string",
29
+
"usage_data": [
30
+
{
31
+
"date": "2025-03-25T11:42:13.984Z",
32
+
"cluster_UUID": "string",
33
+
"cluster_name": "string",
34
+
"api_version": "string",
35
+
"software_version": "string",
36
+
"bdb_uid": "string",
37
+
"type": "string",
38
+
"shard_type": "string",
39
+
"dominant_shard_criteria": "string",
40
+
"provisioned_memory": 0,
41
+
"used_memory": 0,
42
+
"master_shards_count": 0,
43
+
"no_eviction": true,
44
+
"persistence": true,
45
+
"backup": true,
46
+
"using_redis_search": true,
47
+
"ops_sec": 0,
48
+
"replication": true,
49
+
"active_active": true
50
+
}
51
+
]
52
+
}
53
+
```
54
+
55
+
## Change data collection schedule
56
+
57
+
The cluster collects usage data hourly by default.
58
+
59
+
To change the data collection schedule, [update job scheduler settings]({{<relref "/operate/rs/references/rest-api/requests/job_scheduler#put-job-scheduler">}}) for `bdb_usage_report_job_settings` with a REST API request:
60
+
61
+
```sh
62
+
PUT /v1/job_scheduler
63
+
{
64
+
"bdb_usage_report_job_settings": {
65
+
"enabled": true,
66
+
"cron_expression": "*/60 * * * *"
67
+
}
68
+
}
69
+
```
70
+
71
+
Replace `cron_expression`'s value with a [`cron` expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the new data collection schedule.
72
+
73
+
## Turn off call home client
74
+
75
+
To stop the call home client from sending daily usage statistics to Redis, [update cluster services configuration]({{<relref "/operate/rs/references/rest-api/requests/cluster/services_configuration#put-cluster-services_config">}}) for `call_home_agent` with a REST API request:
Copy file name to clipboardExpand all lines: content/operate/rs/clusters/configure/rack-zone-awareness.md
+101-2Lines changed: 101 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Rack-zone awareness helps ensure high availability in the event of a rack or zon
15
15
16
16
When you enable rack-zone awareness in a Redis Enterprise Software cluster, you assign
17
17
a [rack-zone ID](#rack-zone-id-rules) to each node. This ID is used to map the node to a
18
-
physical rack or logical zone. The cluster can then ensure that master shards, corresponding replica shards, and associated endpoints are placed on [nodes in different racks or zones](#node-layout-guidelines).
18
+
physical rack or logical zone. The cluster can then ensure that primary shards, corresponding replica shards, and associated endpoints are placed on [nodes in different racks or zones](#node-layout-guidelines).
19
19
20
20
In the event of a rack or zone failure, the replicas and endpoints in the remaining racks and zones are promoted. This ensures high availability when a rack or zone fails.
21
21
@@ -84,6 +84,105 @@ If you did not configure rack-zone awareness during cluster creation, you can co
84
84
{ "rack_aware": true }
85
85
```
86
86
87
+
## Set up two-dimensional rack-zone awareness
88
+
89
+
As of Redis Enterprise Software version 7.22, you can assign a `second_rack_id` to set up two-dimensional rack-zone awareness.
90
+
91
+
You can use two-dimensional rack-zone awareness to create logical zones within a zone or rack.
92
+
93
+
### New clusters
94
+
95
+
To set up two-dimensional rack-zone awareness during cluster creation, assign a `second_rack_id` to each node in the cluster in addition to the `rack_id` using the [REST API]({{<relref "/operate/rs/references/rest-api">}}) or [rladmin]({{<relref "/operate/rs/references/cli-utilities/rladmin">}}).
96
+
97
+
#### REST API method
98
+
99
+
To create a new cluster with two-dimensional rack-zone awareness, you can use [bootstrap REST API requests]({{<relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap">}}):
100
+
101
+
1. Create the new cluster on the first node, set`rack_aware` to `true`, and assign a `rack_id` and `second_rack_id` to the first node:
102
+
103
+
```sh
104
+
POST /v1/bootstrap/create_cluster
105
+
{
106
+
"action": "create_cluster",
107
+
"cluster": {
108
+
"nodes": [],
109
+
"name": "<cluster.fqdn>"
110
+
},
111
+
"credentials": {
112
+
"username": "<admin-email>",
113
+
"password": "<admin-password>"
114
+
},
115
+
"node": {
116
+
"identity": {
117
+
"rack_id": "<availability-zone-ID>",
118
+
"second_rack_id": "<rack-ID>"
119
+
}
120
+
},
121
+
"policy": {
122
+
"rack_aware": true
123
+
}
124
+
}
125
+
```
126
+
127
+
1. Join each new node you want to add to the cluster and assign a different `rack_id` and `second_rack_id` to it:
128
+
129
+
```sh
130
+
POST /v1/bootstrap/join_cluster
131
+
{
132
+
"action": "join_cluster",
133
+
"cluster": {
134
+
"nodes": [],
135
+
"name": "<cluster.fqdn>"
136
+
},
137
+
"credentials": {
138
+
"username": "<admin-email>",
139
+
"password": "<admin-password>"
140
+
},
141
+
"node": {
142
+
"identity": {
143
+
"rack_id": "<availability-zone-ID>",
144
+
"second_rack_id": "<rack-ID>"
145
+
}
146
+
}
147
+
}
148
+
```
149
+
150
+
#### Command-line method
151
+
152
+
To create a new cluster with two-dimensional rack-zone awareness using the command line:
153
+
154
+
1. Run [`rladmin cluster create`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/create">}}) to create the initial cluster on one node, enable rack-zone awareness, and assign a `rack_id` and `second_rack_id`:
155
+
156
+
```sh
157
+
$ rladmin cluster create name <cluster-name> \
158
+
username <admin-email> \
159
+
password <admin-password> \
160
+
rack_aware \
161
+
rack_id <node-rack-ID> \
162
+
second_rack_id <second-node rack-ID>
163
+
```
164
+
165
+
1. Run [`rladmin cluster join`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/join">}}) for each new node you want to add to the cluster and assign a different `rack_id` and `second_rack_id`:
166
+
167
+
```sh
168
+
$ rladmin cluster join nodes <node-IP-address> \
169
+
username <admin-email> \
170
+
password <admin-password> \
171
+
rack_id <node-rack ID> \
172
+
second_rack_id <second-node-rack-ID>
173
+
```
174
+
175
+
### Existing clusters
176
+
177
+
You can configure two-dimensional rack-zone awareness for existing clusters using the [REST API]({{< relref "/operate/rs/references/rest-api">}}).
178
+
179
+
For each node in the cluster, assign a different `second_rack_id` using the REST API to [update the node]({{< relref "/operate/rs/references/rest-api/requests/nodes#put-node">}}):
180
+
181
+
```sh
182
+
PUT /v1/nodes/<node-ID>
183
+
{ "second_rack_id": "rack-ID" }
184
+
```
185
+
87
186
## Enable database rack-zone awareness
88
187
89
188
Before you can enable rack-zone awareness for a database, you must configure rack-zone awareness for the cluster and its nodes. For more information, see [set up rack-zone awareness](#set-up-rack-zone-awareness).
@@ -153,4 +252,4 @@ After you enable rack-zone awareness for an existing database, you should genera
153
252
154
253
## Shard placement without rack-zone awareness
155
254
156
-
Even if a database has rack-zone awareness turned off, the cluster still ensures that master and replica shards are placed on distinct nodes.
255
+
Even if a database has rack-zone awareness turned off, the cluster still ensures that primary and replica shards are placed on distinct nodes.
0 commit comments