Skip to content

Commit 2ebb9ce

Browse files
Add metadata to cluster properties that don't get restored after a whole cluster restore procedure (#1095)
Co-authored-by: Angela Simms <[email protected]>
1 parent bc1decc commit 2ebb9ce

File tree

2 files changed

+40
-10
lines changed

2 files changed

+40
-10
lines changed

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,8 @@ Cluster identifier.
302302

303303
*Requires restart:* No
304304

305+
*Gets restored during cluster restore:* No
306+
305307
*Visibility:* `user`
306308

307309
*Type:* string

modules/reference/pages/properties/object-storage-properties.adoc

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Optional API endpoint. The only instance in which you must set this value is whe
3535

3636
*Requires restart:* No
3737

38+
*Gets restored during cluster restore:* No
39+
3840
*Optional:* Yes (if not using a custom domain)
3941

4042
*Visibility:* `user`
@@ -83,6 +85,8 @@ If not set, this is automatically generated using `dfs.core.windows.net` and <<c
8385

8486
*Requires restart:* Yes
8587

88+
*Gets restored during cluster restore:* No
89+
8690
*Visibility:* `user`
8791

8892
*Type:* string
@@ -97,6 +101,8 @@ Azure Data Lake Storage v2 port override. See also: <<cloud_storage_azure_adls_e
97101

98102
*Requires restart:* Yes
99103

104+
*Gets restored during cluster restore:* No
105+
100106
*Visibility:* `user`
101107

102108
*Type:* integer
@@ -113,12 +119,14 @@ The name of the Azure container to use with Tiered Storage. If `null`, the prope
113119

114120
NOTE: The container must belong to <<cloud_storage_azure_storage_account,`cloud_storage_azure_storage_account`>>.
115121

122+
*Requires restart*: Yes
123+
124+
*Gets restored during cluster restore:* No
125+
116126
*Type*: string
117127

118128
*Default*: null
119129

120-
*Restart required*: yes
121-
122130
*Supported versions*: Redpanda v23.1 or later
123131

124132
---
@@ -153,7 +161,7 @@ The managed identity ID to use for access to the Azure storage account. To use A
153161

154162
*Default*: null
155163

156-
*Restart required*: no
164+
*Requires restart*: No
157165

158166
*Supported versions*: Redpanda v24.1 or later
159167

@@ -165,12 +173,14 @@ The account access key to be used for Azure Shared Key authentication with the A
165173

166174
NOTE: Redpanda expects this key string to be Base64 encoded.
167175

176+
*Requires restart*: Yes
177+
178+
*Gets restored during cluster restore:* No
179+
168180
*Type*: string
169181

170182
*Default*: null
171183

172-
*Restart required*: yes
173-
174184
*Supported versions*: Redpanda v23.1 or later
175185

176186
---
@@ -181,6 +191,8 @@ The name of the Azure storage account to use with Tiered Storage. If `null`, the
181191

182192
*Requires restart:* Yes
183193

194+
*Gets restored during cluster restore:* No
195+
184196
*Visibility:* `user`
185197

186198
*Type:* string
@@ -195,6 +207,8 @@ Optional object storage backend variant used to select API capabilities. If not
195207

196208
*Requires restart:* Yes
197209

210+
*Gets restored during cluster restore:* No
211+
198212
*Visibility:* `user`
199213

200214
*Accepted values:* [`unknown`, `aws`, `google_s3_compat`, `azure`, `minio`]
@@ -227,6 +241,8 @@ WARNING: Modifying this property after writing data to a bucket could cause data
227241

228242
*Requires restart:* Yes
229243

244+
*Gets restored during cluster restore:* No
245+
230246
*Visibility:* `user`
231247

232248
*Type:* string
@@ -331,10 +347,12 @@ This property works together with <<cloud_storage_cache_size_percent,`cloud_stor
331347

332348
- `cloud_storage_cache_size` cannot be `0` while `cloud_storage_cache_size_percent` is `null`.
333349

334-
*Unit*: bytes
335-
336350
*Requires restart:* No
337351

352+
*Gets restored during cluster restore:* No
353+
354+
*Unit*: bytes
355+
338356
*Visibility:* `user`
339357

340358
*Type:* integer
@@ -521,9 +539,11 @@ The hostname to connect to for retrieving role based credentials. Derived from <
521539

522540
*Requires restart:* Yes
523541

542+
*Gets restored during cluster restore:* No
543+
524544
*Visibility:* `tunable`
525545

526-
*Type:*
546+
*Type:* string
527547

528548
*Accepted values:* [`config_file`, `aws_instance_metadata`, `sts`, `gcp_instance_metadata`, `azure_aks_oidc_federation`, `azure_vm_instance_metadata`]
529549

@@ -538,10 +558,12 @@ Required for AWS or GCP authentication with IAM roles.
538558

539559
To authenticate using access keys, see <<cloud_storage_access_key,`cloud_storage_access_key`>>.
540560

541-
*Accepted values*: `config_file`, `aws_instance_metadata`, `sts, gcp_instance_metadata`, `azure_vm_instance_metadata`, `azure_aks_oidc_federation`
542-
543561
*Requires restart:* Yes
544562

563+
*Gets restored during cluster restore:* No
564+
565+
*Accepted values*: `config_file`, `aws_instance_metadata`, `sts, gcp_instance_metadata`, `azure_vm_instance_metadata`, `azure_aks_oidc_federation`
566+
545567
*Visibility:* `user`
546568

547569
*Default:* `config_file`
@@ -1357,6 +1379,8 @@ Cloud provider region that houses the bucket or container used for storage.
13571379

13581380
*Requires restart:* Yes
13591381

1382+
*Gets restored during cluster restore:* No
1383+
13601384
*Visibility:* `user`
13611385

13621386
*Type:* string
@@ -1407,6 +1431,8 @@ Cloud provider secret key.
14071431

14081432
*Requires restart:* Yes
14091433

1434+
*Gets restored during cluster restore:* No
1435+
14101436
*Visibility:* `user`
14111437

14121438
*Type:* string
@@ -1549,6 +1575,8 @@ Path to certificate that should be used to validate server certificate during TL
15491575

15501576
*Requires restart:* Yes
15511577

1578+
*Gets restored during cluster restore:* No
1579+
15521580
*Visibility:* `user`
15531581

15541582
*Type:* string

0 commit comments

Comments
 (0)