Skip to content

Commit 3fc401e

Browse files
authored
DOC-5216 RS: Added more details about bigstore_enabled to REST API reference (#1559)
1 parent e627600 commit 3fc401e

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ weight: $weight
1313

1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
16-
| bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated) |
17-
| bigstore_enabled | boolean | Bigstore enabled or disabled |
16+
| bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated, use the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}})'s `bigstore_driver` instead) |
17+
| bigstore_enabled | boolean (default: false) | If `true`, then flash storage is enabled on this node for [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) databases. Configurable during [bootstrapping]({{<relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap">}}). After bootstrapping, it is read-only. |
1818
| identity | [identity]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/identity" >}}) object | Node identity |
1919
| limits | [limits]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/limits" >}}) object | Node limits |
2020
| paths | [paths]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/paths" >}}) object | Storage paths object |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An API object that represents the cluster.
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| alert_settings | [alert_settings]({{< relref "/operate/rs/references/rest-api/objects/cluster/alert_settings" >}}) object | Cluster and node alert settings |
19-
| bigstore_driver | 'speedb'<br />'rocksdb' | Storage engine for Auto Tiering |
19+
| bigstore_driver | 'speedb'<br />'rocksdb' | Storage engine for [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) |
2020
| cluster_ssh_public_key | string | Cluster's autogenerated SSH public key |
2121
| cm_port | integer, (range:&nbsp;1024-65535) | UI HTTPS listening port |
2222
| <span class="break-all">cm_session_timeout_minutes</span> | integer (default:&nbsp;15) | The timeout (in minutes) for the session to the CM |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ An API object that represents a node in the cluster.
1919
| addr | string | Internal IP address of node |
2020
| architecture | string | Hardware architecture (read-only) |
2121
| bigredis_storage_path | string | Flash storage path (read-only) |
22-
| bigstore_driver | 'ibm-capi-ga1'<br />'ibm-capi-ga2'<br />'ibm-capi-ga4'<br />'speedb'<br />'rocksdb' | Bigstore driver name or none (deprecated as of Redis Enterprise v7.2, use the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}})'s bigstore_driver instead) |
23-
| bigstore_enabled | boolean | If true, bigstore is enabled (read-only) |
22+
| bigstore_driver | 'ibm-capi-ga1'<br />'ibm-capi-ga2'<br />'ibm-capi-ga4'<br />'speedb'<br />'rocksdb' | Bigstore driver name or none (deprecated as of Redis Enterprise v7.2, use the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}})'s `bigstore_driver` instead) |
23+
| bigstore_enabled | boolean | If `true`, then flash storage is enabled on this node for [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) databases. Configurable during [bootstrapping]({{<relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap">}}). After bootstrapping, it is read-only. |
2424
| bigstore_size | integer | Storage size of bigstore storage (read-only) |
2525
| cores | integer | Total number of CPU cores (read-only) |
2626
| ephemeral_storage_path | string | Ephemeral storage path (read-only) |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ POST /v1/bootstrap/create_cluster
173173
"ephemeral_path": "/path/to/ephemeral/storage",
174174
"bigstore_path": "/path/to/bigstore/storage"
175175
},
176-
"bigstore_driver": "speedb",
176+
"bigstore_enabled": true,
177177
"identity": {
178178
"addr":"1.2.3.4",
179179
"external_addr":["2001:0db8:85a3:0000:0000:8a2e:0370:7334", "3.4.5.6"]
@@ -204,7 +204,7 @@ POST /v1/bootstrap/create_cluster
204204
"addr":"1.2.3.4",
205205
"external_addr":["2001:0db8:85a3:0000:0000:8a2e:0370:7334", "3.4.5.6"]
206206
},
207-
"bigstore_driver": "rocksdb"
207+
"bigstore_enabled": true
208208
},
209209
"license": "----- LICENSE START -----\ndi+iK...KniI9\n----- LICENSE END -----\n",
210210
"credentials": {

0 commit comments

Comments
 (0)