Skip to content

Add metadata to cluster properties that don't get restored after a whole cluster restore procedure #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JakeSCahill merged 3 commits into from
May 1, 2025
Merged

Add metadata to cluster properties that don't get restored after a whole cluster restore procedure #1095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c8f4cc
Add metadata to cluster properties that don't get restored after a wh…
JakeSCahill Apr 29, 2025
344170f
Make language consistent
JakeSCahill Apr 29, 2025
87d1b48
Apply suggestions from code review
JakeSCahill May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/reference/pages/properties/cluster-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,8 @@ Cluster identifier.

*Requires restart:* No

*Gets restored during cluster restore:* No

*Visibility:* `user`

*Type:* string
Expand Down
48 changes: 38 additions & 10 deletions modules/reference/pages/properties/object-storage-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Optional API endpoint. The only instance in which you must set this value is whe

*Requires restart:* No

*Gets restored during cluster restore:* No

*Optional:* Yes (if not using a custom domain)

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

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

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

*Requires restart*: Yes

*Gets restored during cluster restore:* No

*Type*: string

*Default*: null

*Restart required*: yes

*Supported versions*: Redpanda v23.1 or later

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

*Default*: null

*Restart required*: no
*Requires restart*: No

*Supported versions*: Redpanda v24.1 or later

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

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

*Requires restart*: Yes

*Gets restored during cluster restore:* No

*Type*: string

*Default*: null

*Restart required*: yes

*Supported versions*: Redpanda v23.1 or later

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

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

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

*Unit*: bytes

*Requires restart:* No

*Gets restored during cluster restore:* No

*Unit*: bytes

*Visibility:* `user`

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `tunable`

*Type:*
*Type:* string

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

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

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

*Accepted values*: `config_file`, `aws_instance_metadata`, `sts, gcp_instance_metadata`, `azure_vm_instance_metadata`, `azure_aks_oidc_federation`

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Accepted values*: `config_file`, `aws_instance_metadata`, `sts, gcp_instance_metadata`, `azure_vm_instance_metadata`, `azure_aks_oidc_federation`
Copy link
Copy Markdown
Contributor

@asimms41 asimms41 Apr 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accepted values appear in [] in other entries.


*Visibility:* `user`

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

*Type:* string
Expand Down Expand Up @@ -1407,6 +1431,8 @@ Cloud provider secret key.

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

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

*Requires restart:* Yes

*Gets restored during cluster restore:* No

*Visibility:* `user`

*Type:* string
Expand Down