Skip to content

Commit 7e34ba5

Browse files
committed
DOC-5590 RS: Deprecate setting cluster policy during bootstrap
1 parent 0ccca8e commit 7e34ba5

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@ A bootstrap configuration object.
1818
| action | 'create_cluster'<br />'join_cluster'<br />'recover_cluster' | Action to perform |
1919
| cluster | [cluster_identity]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/cluster_identity" >}}) object | Cluster to join or create |
2020
| cnm_https_port | integer | Port to join a cluster with non-default cnm_https port |
21-
| crdb_coordinator_port | integer, (range:&nbsp;1024-65535) (default:&nbsp;9081) | CRDB coordinator port |
21+
| crdb_coordinator_port | integer, (range: 1024-65535) (default: 9081) | CRDB coordinator port |
2222
| credentials | [credentials]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/credentials" >}}) object | Cluster admin credentials |
23-
| dns_suffixes | {{<code>}}
23+
| dns_suffixes | object | Explicit configuration of DNS suffixes<br />{{<code>}}
2424
[{
2525
"name": string,
2626
"cluster_default": boolean,
2727
"use_aaaa_ns": boolean,
2828
"use_internal_addr": boolean,
2929
"slaves": array
3030
}, ...]
31-
{{</code>}} | Explicit configuration of DNS suffixes<br />**name**: DNS suffix name<br />**cluster_default**: Should this suffix be the default cluster suffix<br />**use_aaaa_ns**: Should AAAA records be published for NS records<br />**use_internal_addr**: Should internal cluster IPs be published for databases<br />**slaves**: List of replica servers that should be published as NS and notified |
32-
| envoy_admin_port | integer, (range:&nbsp;1024-65535) | Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.|
33-
| envoy_mgmt_server_port | integer, (range:&nbsp;1024-65535) | Envoy management server port|
34-
| gossip_envoy_admin_port | integer, (range:&nbsp;1024-65535) | Gossip envoy admin port|
31+
{{</code>}}<br />**name**: DNS suffix name<br />**cluster_default**: Should this suffix be the default cluster suffix<br />**use_aaaa_ns**: Should AAAA records be published for NS records<br />**use_internal_addr**: Should internal cluster IPs be published for databases<br />**slaves**: List of replica servers that should be published as NS and notified |
32+
| envoy_admin_port | integer, (range: 1024-65535) | Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.|
33+
| envoy_mgmt_server_port | integer, (range: 1024-65535) | Envoy management server port|
34+
| gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port|
3535
| license | string | License string. If not provided, a trial license is set by default. |
3636
| max_retries | integer | Max number of retries in case of recoverable errors |
3737
| node | [node_identity]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/node_identity" >}}) object | Node description |
38-
| policy | [policy]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/policy" >}}) object | Policy object |
38+
| policy | [policy]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/policy" >}}) object | Policy object (deprecated; use [`PUT /v1/cluster/policy`]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) after cluster creation instead) |
3939
| recovery_filename | string | Name of backup file to recover from |
4040
| required_version | string | This node can only join the cluster if all nodes in the cluster have a version greater than the required_version (deprecated as of Redis Enterprise Software v7.8.6) |
4141
| retry_time | integer | Max waiting time between retries (in seconds) |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Redis Enterprise Software version 8.0 introduces the following breaking changes:
4545

4646
#### API deprecations
4747

48-
- TBA
48+
- Deprecated the `policy` field for [bootstrap]({{<relref "/operate/rs/references/rest-api/requests/bootstrap">}}) REST API requests. Use [`PUT /v1/cluster/policy`]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) to change cluster policies after cluster creation instead.
4949

5050
#### Internal monitoring and v1 Prometheus metrics deprecation
5151

content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-tba.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Redis Software version 8.0.x introduces the following breaking changes:
115115
116116
#### API deprecations
117117
118-
- TBA
118+
- Deprecated the `policy` field for [bootstrap]({{<relref "/operate/rs/references/rest-api/requests/bootstrap">}}) REST API requests. Use [`PUT /v1/cluster/policy`]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) to change cluster policies after cluster creation instead.
119119
120120
#### Internal monitoring and v1 Prometheus metrics deprecation
121121

0 commit comments

Comments
 (0)