Skip to content

Commit 4502204

Browse files
Document feature: Expose selected cluster configuration properties in cloud (#295)
* note prop is read-only in Cloud, + GET to cluster config page * add how to view cluster properties * add blurb to What's New * single source object properties from docs repo * add object storage properties links in other files * Update modules/reference/pages/properties/cluster-properties.adoc Co-authored-by: Jake Cahill <[email protected]> * fix API Get & remove cluster_id * revert playbook back to original * minor edit --------- Co-authored-by: Jake Cahill <[email protected]>
1 parent 54f43b9 commit 4502204

File tree

5 files changed

+78
-9
lines changed

5 files changed

+78
-9
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,7 @@
438438
*** xref:api:ROOT:pandaproxy-schema-registry.adoc[]
439439
** xref:reference:properties/index.adoc[]
440440
*** xref:reference:properties/cluster-properties.adoc[]
441+
*** xref:reference:properties/object-storage-properties.adoc[]
441442
** xref:reference:data-transforms/sdks.adoc[]
442443
*** xref:reference:data-transforms/golang-sdk.adoc[Golang]
443444
*** xref:reference:data-transforms/rust-sdk.adoc[Rust]

modules/get-started/pages/whats-new-cloud.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ This page lists new features added to Redpanda Cloud.
99

1010
== May 2025
1111

12+
=== Read-only cluster configuration properties
13+
14+
You can now xref:manage:cluster-maintenance/config-cluster.adoc#view-cluster-property-values[view the value of read-only cluster configuration properties] with `rpk cluster config` or with the Cloud API. Available properties are listed in xref:reference:properties/cluster-properties.adoc[Cluster Properties] and xref:reference:properties/object-storage-properties.adoc[Object Storage Properties].
15+
1216
=== Iceberg topics in Azure (beta)
1317

1418
xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics] are now supported for BYOC clusters in Azure.

modules/manage/pages/cluster-maintenance/config-cluster.adoc

Lines changed: 60 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
= Configure Cluster Properties
22
:description: Learn how to configure cluster properties to enable and manage features.
33

4-
Cluster configuration properties are set to their default values and automatically replicated across all brokers. You can use cluster properties to enable and manage features such as xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics], xref:develop:data-transforms/index.adoc[data transforms], and xref:manage:audit-logging.adoc[audit logging].
4+
Cluster configuration properties are set to their default values and automatically replicated across all brokers.
55

6-
For a complete list of the cluster properties you can set in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties].
6+
You can use cluster properties to enable and manage features such as xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics], xref:develop:data-transforms/index.adoc[data transforms], and xref:manage:audit-logging.adoc[audit logging].
7+
8+
For a complete list of the cluster properties available in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties] and xref:reference:properties/object-storage-properties.adoc[Object Storage Properties].
9+
10+
NOTE: Some properties are read-only and cannot be changed. For example, `cluster_id` is a read-only property that is automatically set when the cluster is created.
711

812
== Limitations
913

10-
Cluster configuration is supported on BYOC and Dedicated clusters running on AWS and GCP.
14+
Cluster properties are supported on BYOC and Dedicated clusters running on AWS and GCP.
15+
16+
- They are not available on BYOC and Dedicated clusters running on Azure.
17+
- They are not available on Serverless clusters.
1118

12-
- It is not available on Serverless clusters.
13-
- It is not available on BYOC and Dedicated clusters running on Azure.
1419

1520
== Set cluster configuration properties
1621

@@ -69,6 +74,56 @@ The xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`P
6974
7075
NOTE: Some properties require a rolling restart for the update to take effect. This triggers a xref:manage:api/cloud-byoc-controlplane-api.adoc#lro[long-running operation] that can take several minutes to complete.
7176
77+
--
78+
======
79+
80+
== View cluster property values
81+
82+
You can see the value of a cluster configuration property using `rpk` or the Cloud API.
83+
84+
[tabs]
85+
======
86+
`rpk`::
87+
+
88+
--
89+
Use `rpk cluster config get` to view the current cluster property value.
90+
91+
For example, to view the current value of xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`], run:
92+
93+
[source,bash]
94+
----
95+
rpk cluster config get data_transforms_enabled
96+
----
97+
98+
99+
--
100+
Cloud API::
101+
+
102+
--
103+
Use the Cloud API to get the current configuration property values for a cluster.
104+
105+
Make a xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /clusters/{cluster.id}`] request, passing the cluster ID as a parameter. The response body contains the current `computed_properties` values. For example, to get the current value of xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`]:
106+
107+
[source,bash]
108+
----
109+
# Store your cluster ID in a variable.
110+
export RP_CLUSTER_ID=<cluster-id>
111+
112+
# Retrieve a Redpanda Cloud access token.
113+
export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \
114+
-H "content-type: application/x-www-form-urlencoded" \
115+
-d "grant_type=client_credentials" \
116+
-d "client_id=<client-id>" \
117+
-d "client_secret=<client-secret>"`
118+
119+
# Get your cluster configuration property values.
120+
curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X GET \
121+
"https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \
122+
-H 'accept: application/json'\
123+
-H 'content-type: application/json' \
124+
----
125+
126+
72127
--
73128
======
74129

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22
:page-toclevels: 3
33
:description: Reference of cluster configuration properties.
44

5-
Cluster configuration properties are the same for all brokers in a cluster, and are set at the cluster level.
6-
7-
For information on how to edit cluster properties, see xref:manage:cluster-maintenance/config-cluster.adoc[].
5+
Cluster properties are configuration settings that control the behavior of a Redpanda cluster at a global level. Configuring cluster properties allows you to adapt Redpanda to specific workloads, optimize resource usage, and enable or disable features. For information on how to edit cluster properties, see xref:manage:cluster-maintenance/config-cluster.adoc[].
86

97
NOTE: Some properties require a cluster restart for updates to take effect. This triggers a xref:manage:api/cloud-byoc-controlplane-api.adoc#lro[long-running operation] that can take several minutes to complete.
108

119
== Cluster configuration
1210

13-
include::ROOT:reference:properties/cluster-properties.adoc[tags=audit_enabled;audit_excluded_principals;audit_excluded_topics;data_transforms_enabled;data_transforms_logging_line_max_bytes;iceberg_catalog_type;iceberg_delete;iceberg_enabled;iceberg_rest_catalog_client_id;iceberg_rest_catalog_client_secret;iceberg_rest_catalog_token;iceberg_rest_catalog_authentication_mode;iceberg_rest_catalog_endpoint;iceberg_rest_catalog_oauth2_server_uri;iceberg_rest_catalog_prefix;iceberg_rest_catalog_request_timeout_ms;iceberg_default_partition_spec;iceberg_invalid_record_action;iceberg_target_lag_ms;iceberg_rest_catalog_trust;iceberg_rest_catalog_crl]
11+
include::ROOT:reference:properties/cluster-properties.adoc[tags=audit_enabled;audit_excluded_principals;audit_excluded_topics;data_transforms_enabled;data_transforms_logging_line_max_bytes;iceberg_catalog_type;iceberg_delete;iceberg_enabled;iceberg_rest_catalog_client_id;iceberg_rest_catalog_client_secret;iceberg_rest_catalog_token;iceberg_rest_catalog_authentication_mode;iceberg_rest_catalog_endpoint;iceberg_rest_catalog_oauth2_server_uri;iceberg_rest_catalog_prefix;iceberg_rest_catalog_request_timeout_ms;iceberg_default_partition_spec;iceberg_invalid_record_action;iceberg_target_lag_ms;iceberg_rest_catalog_trust;iceberg_rest_catalog_crl;data_transforms_per_function_memory_limit;data_transforms_binary_max_size;log_segment_ms;http_authentication;iceberg_catalog_base_location;default_topic_replications;minimum_topic_replications;oidc_discovery_url;oidc_principal_mapping;oidc_token_audience;sasl_mechanisms;tls_min_version;audit_log_num_partitions;data_transforms_per_core_memory_reservation]
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Object Storage Properties
2+
:page-toclevels: 3
3+
:description: Reference of object storage properties.
4+
5+
Object storage properties are a type of cluster property. Cluster properties are configuration settings that control the behavior of a Redpanda cluster at a global level. Configuring cluster properties allows you to adapt Redpanda to specific workloads, optimize resource usage, and enable or disable features. For information on how to edit cluster properties, see xref:manage:cluster-maintenance/config-cluster.adoc[].
6+
7+
NOTE: Some properties require a cluster restart for updates to take effect. This triggers a xref:manage:api/cloud-byoc-controlplane-api.adoc#lro[long-running operation] that can take several minutes to complete.
8+
9+
== Cluster configuration
10+
11+
include::ROOT:reference:properties/object-storage-properties.adoc[tags=cloud_storage_azure_storage_account;cloud_storage_azure_container]

0 commit comments

Comments
 (0)