Skip to content

Commit 5dbe93c

Browse files
authored
DOC-1479 add rpk requirement for cluster config (#342)
* DOC-1479 add rpk requirement for cluster config * add steps to check Redpanda version with rpk or Cloud API * text edit * style edit
1 parent 620f561 commit 5dbe93c

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
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.
5-
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].
4+
Cluster configuration properties are set to their default values and are 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].
75

86
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].
97

108
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.
119

10+
== Prerequisites
11+
12+
* To configure clusters properties, a cluster must be running Redpanda version 25.1.2 or later. You can find the version on your cluster's Overview page in the Redpanda Cloud UI.
13+
14+
* To use `rpk` to configure cluster properties, you must be using `rpk` version 25.1.2 or later. To check your current version, see xref:manage:rpk/rpk-install.adoc[].
15+
1216
== Limitations
1317

1418
Cluster properties are supported on BYOC and Dedicated clusters running on AWS and GCP.
@@ -22,7 +26,7 @@ Cluster properties are supported on BYOC and Dedicated clusters running on AWS a
2226
You can set cluster configuration properties using the `rpk` command-line tool or the Cloud API.
2327

2428
[tabs]
25-
======
29+
====
2630
`rpk`::
2731
+
2832
--
@@ -98,14 +102,14 @@ curl -H "Authorization: Bearer <token>" -X PATCH \
98102
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.
99103
100104
--
101-
======
105+
====
102106

103107
== View cluster property values
104108

105109
You can see the value of a cluster configuration property using `rpk` or the Cloud API.
106110

107111
[tabs]
108-
======
112+
====
109113
`rpk`::
110114
+
111115
--
@@ -148,7 +152,7 @@ curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X GET \
148152
149153
150154
--
151-
======
155+
====
152156

153157
== Suggested reading
154158

0 commit comments

Comments
 (0)