-
Notifications
You must be signed in to change notification settings - Fork 4
Document feature: Expose selected cluster configuration properties in cloud #295
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.
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
Changes from 7 commits
9eac1b7
fca34e8
d0ddf11
4d5c103
c630a98
5c54fab
368b2fa
7590b7e
782e92c
95813f1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,21 @@ | ||
| = Configure Cluster Properties | ||
| :description: Learn how to configure cluster properties to enable and manage features. | ||
|
|
||
| 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]. | ||
| Cluster configuration properties are set to their default values and automatically replicated across all brokers. | ||
|
|
||
| For a complete list of the cluster properties you can set in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties]. | ||
| 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]. | ||
|
|
||
| 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]. | ||
|
|
||
| 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. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we don't expose cluster_id so we should not mention that.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
|
|
||
| == Limitations | ||
|
|
||
| Cluster configuration is supported on BYOC and Dedicated clusters running on AWS and GCP. | ||
| Cluster properties are supported on BYOC and Dedicated clusters running on AWS and GCP. | ||
|
|
||
| - They are not available on BYOC and Dedicated clusters running on Azure. | ||
| - They are not available on Serverless clusters. | ||
|
|
||
| - It is not available on Serverless clusters. | ||
| - It is not available on BYOC and Dedicated clusters running on Azure. | ||
|
|
||
| == Set cluster configuration properties | ||
|
|
||
|
|
@@ -69,6 +74,57 @@ The xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`P | |
|
|
||
| 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. | ||
|
|
||
| -- | ||
| ====== | ||
|
|
||
| == View cluster property values | ||
|
|
||
| You can see the value of a cluster configuration property using `rpk` or the Cloud API. | ||
|
|
||
| [tabs] | ||
| ====== | ||
| `rpk`:: | ||
| + | ||
| -- | ||
| Use `rpk cluster config get` to view the current cluster property value. | ||
|
|
||
| For example, to view the current value of xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`], run: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| rpk cluster config get data_transforms_enabled | ||
| ---- | ||
|
|
||
|
|
||
| -- | ||
| Cloud API:: | ||
| + | ||
| -- | ||
| Use the Cloud API to get the value of a cluster property. | ||
|
|
||
| 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`]: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| # Store your cluster ID in a variable. | ||
| export RP_CLUSTER_ID=<cluster-id> | ||
|
|
||
| # Retrieve a Redpanda Cloud access token. | ||
| export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \ | ||
| -H "content-type: application/x-www-form-urlencoded" \ | ||
| -d "grant_type=client_credentials" \ | ||
| -d "client_id=<client-id>" \ | ||
| -d "client_secret=<client-secret>"` | ||
|
|
||
| # Get your cluster configuration property values. | ||
| curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X GET \ | ||
| "https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \ | ||
| -H 'accept: application/json'\ | ||
| -H 'content-type: application/json' \ | ||
| -d '{"cluster_configuration":{"computed_properties": {"data_transforms_enabled"}}}' | ||
|
||
| ---- | ||
|
|
||
|
|
||
| -- | ||
| ====== | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| = Object Storage Properties | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't understand what is this page about 🤔 Can I see it live somewhere?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @alenkacz in our self-managed docs, we have tiered storage cluster properties on a separate page. See https://docs.redpanda.com/current/reference/properties/. But we have an open doc issue to consolidate the cluster properties and the object storage properties, so when that happens, all these properties available in Cloud will be on one page. |
||
| :page-toclevels: 3 | ||
| :description: Reference of object storage properties. | ||
|
|
||
| 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[]. | ||
|
|
||
| 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. | ||
|
|
||
| == Cluster configuration | ||
|
|
||
| include::ROOT:reference:properties/object-storage-properties.adoc[tags=cloud_storage_azure_storage_account;cloud_storage_azure_container] | ||
Uh oh!
There was an error while loading. Please reload this page.