Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion modules/get-started/pages/cloud-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,6 @@ Redpanda Cloud deployments do not support the following functionality available
- Kubernetes Helm chart and Redpanda Operator functionality.
- The following `rpk` commands:

** `rpk cluster config`
** `rpk cluster health`
** `rpk cluster license`
** `rpk cluster maintenance`
Expand Down
2 changes: 1 addition & 1 deletion modules/get-started/pages/whats-new-cloud.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Iceberg topics are supported for BYOC clusters in AWS and GCP.

=== Cluster configuration

You can now xref:manage:cluster-maintenance/config-cluster.adoc[configure certain cluster properties] with the Cloud API. For example, you can enable and manage 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]. Available properties are listed in xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties].
You can now xref:manage:cluster-maintenance/config-cluster.adoc[configure certain cluster properties] with `rpk cluster config` or with the Cloud API. For example, you can enable and manage 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]. Available properties are listed in xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties].

Iceberg topics properties are available for clusters running Redpanda version 25.1 or later.

Expand Down
63 changes: 57 additions & 6 deletions modules/manage/pages/cluster-maintenance/config-cluster.adoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,79 @@
= Configure Cluster Properties
:description: Learn how to configure cluster properties to enable and manage features.

Redpanda cluster configuration properties are automatically set to the default values and are replicated across all brokers. You can edit certain cluster configuration properties with the Cloud API. For example, you can enable and manage 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. 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 you can set in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties].

== Limitations

Cluster configuration with the Cloud API is supported on BYOC and Dedicated clusters running on AWS and GCP.
Cluster configuration is supported on BYOC and Dedicated clusters running on AWS and GCP.

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

== Set cluster configuration properties
== Set cluster configuration properties

You can set cluster configuration properties using the `rpk` command-line tool or the Cloud API.

[tabs]
======
`rpk`::
+
--
Comment on lines +22 to +23
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove stray + delimiter lines
Lines containing just + appear to be artifacts and will render incorrectly in Asciidoc. Remove these lines so the tab definitions aren't broken.

Example diff:

- +
- +

Committable suggestion skipped: line range outside the PR's diff.

Use `rpk cluster config` to set cluster properties.

For example, to enable data transforms, set xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`:

[source,bash]
----
rpk cluster config set data_transforms_enabled true
----

NOTE: Some properties require a rolling restart, and it can take several minutes for the update to complete. The `rpk cluster config set` command returns the operation ID.

You can set cluster configuration properties when you create a cluster, or you can edit an existing cluster.

--
Cloud API::
+
--
Use the Cloud API to set cluster properties:

* Create a cluster by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`] request. Edit `cluster_configuration` in the request body with a key-value pair for `custom_properties`.

* Update a cluster by making a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request, passing the cluster ID as a parameter. Include the properties to update in the request body.

For a complete list of the cluster configuration properties you can edit in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties].
For example, to set xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`:

[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>"`

# Update your cluster configuration to enable data transforms.
curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X PATCH \
"https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \
-H 'accept: application/json'\
-H 'content-type: application/json' \
-d '{"cluster_configuration":{"custom_properties": {"data_transforms_enabled":true}}}'
----

The xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /clusters/{cluster.id}`] request returns the ID of a long-running operation. You can check the status of the operation by polling the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /operations/\{id}`] endpoint.

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.

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.
--
======

== Suggested reading

* xref:manage:rpk/intro-to-rpk.adoc[]
* xref:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]
* xref:manage:api/cloud-api-quickstart.adoc[Redpanda Cloud API Quickstart]