Skip to content

Commit ed71daf

Browse files
committed
DOC-4978 RS: Updated bootstrap and node REST API references for two-dimensional rack awareness
1 parent 36328d1 commit ed71daf

File tree

4 files changed

+15
-7
lines changed

4 files changed

+15
-7
lines changed

content/operate/rs/references/rest-api/objects/bootstrap/identity.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ weight: $weight
2020
| name | string | Node's name |
2121
| override_rack_id | boolean | When replacing an existing node in a rack-aware cluster, allows the new node to be located in a different rack |
2222
| rack_id | string | Rack ID, overrides cloud config |
23+
| second_rack_id | string | Second rack ID where node is installed |
2324
| use_internal_ipv6 | boolean (default: false) | Node uses IPv6 for internal communication |

content/operate/rs/references/rest-api/objects/cluster_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Cluster resources management policy
4242
| max_saved_events_per_type | integer | Maximum saved events per event type |
4343
| max_simultaneous_backups | integer (default: 4) | Maximum number of backup processes allowed at the same time |
4444
| parallel_shards_upgrade | integer | Maximum number of shards to upgrade in parallel |
45+
| max_slave_full_syncs | integer (default: 0) | Maximum number of simultaneous replica full-syncs that may be running at any given time |
4546
| persistence_cleanup_scan_interval | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule |
4647
| persistent_node_removal | boolean | When removing a node, wait for persistence files to be created for all migrated shards |
4748
| rack_aware | boolean | Cluster operates in a rack-aware mode |

content/operate/rs/references/rest-api/objects/node.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ An API object that represents a node in the cluster.
3636
| public_addr | string | Public IP address of node (deprecated as of Redis Enterprise v4.3.3, use external_addr instead) |
3737
| rack_id | string | Rack ID where node is installed |
3838
| recovery_path | string | Recovery files path |
39+
| second_rack_id | string | Second rack ID where node is installed |
3940
| shard_count | integer | Number of shards on the node (read-only) |
4041
| shard_list | array of integers | Cluster unique IDs of all node shards |
4142
| software_version | string | Installed Redis Enterprise cluster software version (read-only) |

content/operate/rs/references/rest-api/requests/nodes/_index.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -168,13 +168,18 @@ Update a [node object]({{< relref "/operate/rs/references/rest-api/objects/node"
168168

169169
Currently, you can edit the following attributes:
170170

171-
- `addr`
172-
173-
- `external_addr`
174-
175-
- `recovery_path`
176-
177-
- `accept_servers`
171+
| Field | Type/Value | Description |
172+
|-------|------------|-------------|
173+
| accept_servers | boolean (default:&nbsp;true) | The node only accepts new shards if `accept_servers` is `true` |
174+
| addr | string | Internal IP address of node |
175+
| external_addr | complex object | External IP addresses of node. `GET /jsonschema` to retrieve the object's structure. |
176+
| max_listeners | integer | Maximum number of listeners on the node |
177+
| max_redis_forks | | |
178+
| max_redis_servers | integer | Maximum number of shards on the node |
179+
| max_slave_full_syncs | | |
180+
| rack_id | string | Rack ID where node is installed |
181+
| recovery_path | string | Recovery files path |
182+
| second_rack_id | string | Second rack ID where node is installed |
178183

179184
{{<note>}}
180185
You can only update the `addr` attribute for offline nodes. Otherwise, the request returns an error.

0 commit comments

Comments
 (0)