|
1 | 1 | = Configure Cluster Properties |
2 | 2 | :description: Learn how to configure cluster properties to enable and manage features. |
3 | 3 |
|
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. |
5 | 5 |
|
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. |
7 | 11 |
|
8 | 12 | == Limitations |
9 | 13 |
|
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. |
11 | 18 |
|
12 | | -- It is not available on Serverless clusters. |
13 | | -- It is not available on BYOC and Dedicated clusters running on Azure. |
14 | 19 |
|
15 | 20 | == Set cluster configuration properties |
16 | 21 |
|
@@ -69,6 +74,56 @@ The xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`P |
69 | 74 |
|
70 | 75 | 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. |
71 | 76 |
|
| 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 | +
|
72 | 127 | -- |
73 | 128 | ====== |
74 | 129 |
|
|
0 commit comments