Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
a095083
DOC-666 cluster config in Cloud
micheleRP Mar 28, 2025
813f1e9
minor edits
micheleRP Mar 28, 2025
c5a46da
add restart column + Wasm GA to what's new
micheleRP Mar 28, 2025
fda8126
move create/manage topic into Manage bucket
micheleRP Mar 28, 2025
5f154ad
fix typo
micheleRP Mar 28, 2025
a89d19d
update local playbook + ss schema ID validation
micheleRP Mar 31, 2025
ba35c5e
fix title
micheleRP Mar 31, 2025
45b02a1
fix playbook
micheleRP Apr 1, 2025
e806a58
Apply suggestions from code review
JakeSCahill Apr 1, 2025
330c9fc
Apply suggestions from code review
JakeSCahill Apr 1, 2025
802c567
Merge branch 'main' into DOC-666-Document-feature-Manage-form-factor-…
micheleRP Apr 1, 2025
e705fe7
single source audit logging + fix descriptions
micheleRP Apr 1, 2025
6c92116
update what's new
micheleRP Apr 2, 2025
4119118
single source data transforms
micheleRP Apr 2, 2025
e6bd28f
single source transforms SDK reference
micheleRP Apr 2, 2025
f1a8124
fix links
micheleRP Apr 2, 2025
4c1ca0c
include tagged cluster properties
micheleRP Apr 2, 2025
33f30f8
add SS + conditionalizing
micheleRP Apr 3, 2025
4a7c30e
clean up conditionalizing
micheleRP Apr 3, 2025
2762c7a
update What's New
micheleRP Apr 3, 2025
43b1ec2
remove tables, since links to properties are in
micheleRP Apr 3, 2025
e2f0e45
minor edit
micheleRP Apr 3, 2025
4d8e781
fix levels
micheleRP Apr 3, 2025
da55e46
conditionalize
micheleRP Apr 3, 2025
e23751a
test
micheleRP Apr 3, 2025
ebb2f40
add table back (until single sourcing works)
micheleRP Apr 3, 2025
8f3197b
add topic properties reference
micheleRP Apr 4, 2025
c4eb0c8
typo
micheleRP Apr 4, 2025
17480b6
take out note
micheleRP Apr 4, 2025
7275042
remove table (since properties single source now)
micheleRP Apr 4, 2025
6c1183f
update to properties supported as of 4/4
micheleRP Apr 4, 2025
311d697
remove schema ID validation + undo edits
micheleRP Apr 4, 2025
d6b98ef
minor edits
micheleRP Apr 4, 2025
710e626
Merge branch 'main' into DOC-666-Document-feature-Manage-form-factor-…
micheleRP Apr 4, 2025
f6d3042
Iceberg links (will resolve Monday)
micheleRP Apr 4, 2025
6d6f1e5
remove topic properties reference
micheleRP Apr 5, 2025
755c9a9
fix conditionals
micheleRP Apr 5, 2025
7796bce
fix conditionals
micheleRP Apr 6, 2025
ba210fc
rerun single sourcing
micheleRP Apr 6, 2025
10db5bb
fix audit_excluded_topics
micheleRP Apr 7, 2025
51da140
remove audit_enabled_event_types
micheleRP Apr 7, 2025
a351829
Merge branch 'main' into DOC-666-Document-feature-Manage-form-factor-…
micheleRP Apr 7, 2025
769a83d
change include::25.1@ROOT to include::ROOT:
micheleRP Apr 7, 2025
7137477
Update modules/manage/pages/iceberg/use-iceberg-catalogs.adoc
micheleRP Apr 7, 2025
37f361f
Merge branch 'main' into DOC-666-Document-feature-Manage-form-factor-…
micheleRP Apr 7, 2025
d697c8b
align auditing with SM directory structure
micheleRP Apr 8, 2025
bc11431
fix structure
micheleRP Apr 8, 2025
e4b214c
rerun
micheleRP Apr 8, 2025
832e944
rerun
micheleRP Apr 8, 2025
1fd2fe5
fix local-antora-playbook + serverless redirect
micheleRP Apr 8, 2025
075b1c3
minor edit
micheleRP Apr 8, 2025
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
27 changes: 24 additions & 3 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
**** xref:get-started:cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc[Enable Redpanda Connect on a BYOVPC Cluster on GCP]
*** xref:get-started:cluster-types/byoc/remote-read-replicas.adoc[]
** xref:get-started:cluster-types/create-dedicated-cloud-cluster.adoc[]
** xref:get-started:create-topic.adoc[Create a Topic]
** xref:get-started:config-topics.adoc[Manage Topics]

* xref:networking:index.adoc[Networking]
** xref:networking:cloud-security-network.adoc[Network Design, Ports, and Flows]
Expand Down Expand Up @@ -330,6 +328,8 @@

* xref:develop:index.adoc[Develop]
** xref:develop:kafka-clients.adoc[]
** xref:get-started:create-topic.adoc[Create a Topic]
** xref:get-started:config-topics.adoc[Manage Topics]
** xref:develop:produce-data/index.adoc[Produce Data]
*** xref:develop:produce-data/configure-producers.adoc[]
*** xref:develop:produce-data/idempotent-producers.adoc[Idempotent Producers]
Expand Down Expand Up @@ -358,10 +358,23 @@
*** xref:develop:managed-connectors/create-sqlserver-connector.adoc[SQL Server (Debezium) Source Connector]
*** xref:develop:managed-connectors/create-snowflake-connector.adoc[Snowflake Sink Connector]
** xref:develop:http-proxy.adoc[]
** xref:develop:data-transforms/index.adoc[]
*** xref:develop:data-transforms/how-transforms-work.adoc[Overview]
*** xref:develop:data-transforms/run-transforms.adoc[Data Transforms Quickstart]
*** xref:develop:data-transforms/build.adoc[Build]
*** xref:develop:data-transforms/configure.adoc[Configure]
*** xref:develop:data-transforms/deploy.adoc[Deploy]
*** xref:develop:data-transforms/test.adoc[Test]
*** xref:develop:data-transforms/monitor.adoc[Monitor]
*** xref:develop:data-transforms/data-transforms.adoc[Manage]
** xref:develop:transactions.adoc[]

* xref:manage:index.adoc[Manage]
** xref:manage:maintenance.adoc[]
** xref:manage:cluster-maintenance/index.adoc[Cluster Maintenance]
*** xref:manage:maintenance.adoc[]
*** xref:manage:cluster-maintenance/config-cluster.adoc[]
*** xref:manage:audit-logging.adoc[]
**** xref:manage:audit-logging/audit-log-samples.adoc[]
** xref:manage:monitor-cloud.adoc[]
** xref:manage:mountable-topics.adoc[]
** xref:manage:rpk/index.adoc[Redpanda CLI]
Expand Down Expand Up @@ -411,6 +424,14 @@
*** xref:api:ROOT:cloud-dataplane-api.adoc[]
*** xref:api:ROOT:pandaproxy-rest.adoc[]
*** xref:api:ROOT:pandaproxy-schema-registry.adoc[]
** xref:reference:properties/index.adoc[]
*** xref:reference:properties/cluster-properties.adoc[]
** xref:reference:data-transforms/sdks.adoc[]
*** xref:reference:data-transforms/golang-sdk.adoc[Golang]
*** xref:reference:data-transforms/rust-sdk.adoc[Rust]
*** xref:reference:data-transforms/js/index.adoc[JavaScript]
**** xref:reference:data-transforms/js/js-sdk.adoc[Data Transforms API]
**** xref:reference:data-transforms/js/js-sdk-sr.adoc[Schema Registry API]
** xref:reference:rpk/index.adoc[rpk Commands]
*** xref:reference:rpk/rpk-commands.adoc[rpk]
*** xref:reference:rpk/rpk-x-options.adoc[rpk -X]
Expand Down
5 changes: 5 additions & 0 deletions modules/develop/pages/data-transforms/build.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Develop Data Transforms
:description: Learn how to initialize a data transforms project and write transform functions in your chosen language.
:page-categories: Development, Stream Processing, Data Transforms

include::ROOT:develop:data-transforms/build.adoc[tag=single-source]
5 changes: 5 additions & 0 deletions modules/develop/pages/data-transforms/configure.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Configure Data Transforms
:description: pass:q[Learn how to configure data transforms in Redpanda, including editing the `transform.yaml` file, environment variables, and memory settings. This topic covers both the configuration of transform functions and the WebAssembly (Wasm) engine's environment.]
:page-categories: Development, Stream Processing, Data Transforms

include::ROOT:develop:data-transforms/configure.adoc[tag=single-source]
4 changes: 4 additions & 0 deletions modules/develop/pages/data-transforms/data-transforms.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= Manage Data Transforms
:description: You can monitor the status and performance metrics of your transform functions. You can also view detailed logs and delete transform functions when they are no longer needed.

include::ROOT:console:ui/data-transforms.adoc[tag=single-source]
5 changes: 5 additions & 0 deletions modules/develop/pages/data-transforms/deploy.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Deploy Data Transforms
:description: Learn how to build, deploy, share, and troubleshoot data transforms in Redpanda.
:page-categories: Development, Stream Processing, Data Transforms

include::ROOT:develop:data-transforms/deploy.adoc[tag=single-source]
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= How Data Transforms Work
:page-categories: Development, Stream Processing, Data Transforms
:description: Learn how Redpanda data transforms work.

include::ROOT:develop:data-transforms/how-transforms-work.adoc[tag=single-source]
3 changes: 3 additions & 0 deletions modules/develop/pages/data-transforms/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Data Transforms
:description: Learn about WebAssembly data transforms within Redpanda Cloud.
:page-layout: index
5 changes: 5 additions & 0 deletions modules/develop/pages/data-transforms/monitor.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Monitor Data Transforms
:description: This topic provides guidelines on how to monitor the health of your data transforms and view logs.
:page-categories: Development, Stream Processing, Data Transforms

include::ROOT:develop:data-transforms/monitor.adoc[tag=single-source]
5 changes: 5 additions & 0 deletions modules/develop/pages/data-transforms/run-transforms.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Data Transforms Quickstart
:description: Learn how to build and deploy your first transform functio..
:page-categories: Development, Stream Processing, Data Transforms

include::ROOT:develop:data-transforms/run-transforms.adoc[tag=single-source]
4 changes: 4 additions & 0 deletions modules/develop/pages/data-transforms/test.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= Write Integration Tests for Transform Functions
:description: pass:q[Learn how to write integration tests for data transform functions in Redpanda, including setting up unit tests and using testcontainers for integration tests.]

include::ROOT:develop:data-transforms/test.adoc[tag=single-source]
5 changes: 2 additions & 3 deletions modules/get-started/pages/cloud-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,7 @@ New clusters in Redpanda Cloud generally include functionality added in Self-Man

Redpanda Cloud deployments do not support the following functionality available in Redpanda Self-Managed deployments:

- Integration with Apache Iceberg. For private beta access on BYOC, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
- Data transforms. For private beta access, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
- Remote Read Replicas. This is in beta for Redpanda Cloud.
- Remote Read Replicas. This is in beta for Redpanda Cloud on AWS and GCP.
- Kafka API OIDC authentication. However, Redpanda Cloud does support xref:security:cloud-authentication.adoc#single-sign-on[SSO to the Redpanda Cloud UI].
- Admin API.
- FIPS-compliance mode.
Expand Down Expand Up @@ -277,6 +275,7 @@ The following features are currently in beta in Redpanda Cloud:
* Redpanda Connect for BYOVPC on GCP and Serverless
* Redpanda Terraform provider
* BYOVPC for AWS and Azure
* Integration with Apache Iceberg
* Remote Read Replicas for AWS and GCP

== Next steps
Expand Down
2 changes: 1 addition & 1 deletion modules/get-started/pages/cluster-types/serverless.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Serverless
:description: Learn how to create a Serverless cluster and start streaming.
:page-aliases: get-started:cluster-types/serverless-pro.adoc
:page-aliases: get-started:cluster-types/serverless-pro.adoc, ROOT:deploy:deployment-option/deploy/cloud/serverless.adoc


Serverless is the fastest and easiest way to start data streaming. With Serverless clusters, you host your data in Redpanda's VPC, and Redpanda handles automatic scaling, provisioning, operations, and maintenance. This is a production-ready deployment option with a cluster available instantly, and with pay-as-you-go billing, you only pay for what you consume. You can view detailed billing activity for each cluster and edit payment methods on the *Billing* page.
Expand Down
3 changes: 2 additions & 1 deletion modules/get-started/pages/config-topics.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Manage Topics
:page-categories: Clients, Development
:page-aliases: develop:config-topics.adoc, deploy:deployment-option/cloud/create-topic.adoc
:description: Learn how to create topics, update topic configurations, and delete topics or records.

include::ROOT:develop:config-topics.adoc[tag=single-source]
10 changes: 10 additions & 0 deletions modules/get-started/pages/whats-new-cloud.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,20 @@ The xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg integration for Redpan

Iceberg topics is supported 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].

=== Increased number of supported partitions

The number of partitions (pre-replication) Redpanda Cloud supports for each xref:reference:tiers/index.adoc[usage tier] has been doubled.

=== Data transforms: GA

WebAssembly xref:develop:data-transforms/index.adoc[data transforms] is now generally available in Redpanda Cloud. Data transforms let you run common data streaming tasks within Redpanda, like filtering, scrubbing, and transcoding.

=== AI agents: beta

Redpanda Cloud is starting to introduce beta versions of xref:develop:agents/about.adoc[AI agents] for enterprise agentic applications driven by a continuous data feed.
Expand Down
6 changes: 6 additions & 0 deletions modules/manage/pages/audit-logging.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Audit Logging
:description: Learn how to use Redpanda's audit logging capabilities.
:page-categories: Management, Security
:env-linux: true

include::ROOT:manage:audit-logging.adoc[tag=single-source]
5 changes: 5 additions & 0 deletions modules/manage/pages/audit-logging/audit-log-samples.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Sample Audit Log Messages
:description: Sample Redpanda audit log messages.
:page-categories: Management, Security

include::ROOT:manage:audit-logging/audit-log-samples.adoc[tag=single-source]
30 changes: 30 additions & 0 deletions modules/manage/pages/cluster-maintenance/config-cluster.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
= 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].

== Limitations

Cluster configuration with the Cloud API 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

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

* 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].

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:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]
* xref:manage:api/cloud-api-quickstart.adoc[Redpanda Cloud API Quickstart]
4 changes: 4 additions & 0 deletions modules/manage/pages/cluster-maintenance/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= Cluster Maintenance
:description: Learn about cluster maintenance and configuration properties.
:page-layout: index
:page-categories: Management
2 changes: 1 addition & 1 deletion modules/manage/pages/iceberg/about-iceberg-topics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
:page-beta: true
:env-cloud: true

include::25.1@ROOT:manage:partial$iceberg/about-iceberg-topics.adoc[]
include::ROOT:manage:partial$iceberg/about-iceberg-topics.adoc[]
2 changes: 1 addition & 1 deletion modules/manage/pages/iceberg/query-iceberg-topics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

When you access Iceberg topics from a data lakehouse or other Iceberg-compatible tools, how you consume the data depends on the xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Iceberg mode] you've chosen for a topic, and whether you've registered a schema for the topic in the xref:manage:schema-reg/schema-reg-overview.adoc[Redpanda Schema Registry]. You do not need to rely on complex ETL jobs or pipelines to access real-time data from Redpanda.

include::25.1@ROOT:manage:partial$iceberg/query-iceberg-topics.adoc[]
include::ROOT:manage:partial$iceberg/query-iceberg-topics.adoc[]
2 changes: 1 addition & 1 deletion modules/manage/pages/iceberg/use-iceberg-catalogs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:page-beta: true
:env-cloud: true

include::25.1@ROOT:manage:partial$iceberg/use-iceberg-catalogs.adoc[]
include::ROOT:manage:partial$iceberg/use-iceberg-catalogs.adoc[]

== Next steps

Expand Down
3 changes: 2 additions & 1 deletion modules/manage/pages/mountable-topics.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Mountable Topics
:description: Safely attach and detach Tiered Storage topics to and from a cluster.

For topics with Tiered Storage enabled, you can unmount a topic to safely detach it from a cluster and keep the topic data in the cluster's object storage bucket or container. You can remount the detached topic to the origin cluster, allowing you to hibernate a topic and free up system resources taken up by the topic.

include::24.3@ROOT:manage:partial$mountable-topics.adoc[]
include::ROOT:manage:partial$mountable-topics.adoc[]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Edit Topic Configuration
:page-aliases: manage:console/edit-topic-configuration.adoc
:description: Use Redpanda Cloud to edit the configuration of existing topics in a cluster.

include::ROOT:manage:console/edit-topic-configuration.adoc[tag=single-source]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Programmable Push Filters
:page-aliases: console:features/programmable-push-filters.adoc, reference:console/programmable-push-filters.adoc
:description: Learn how to filter Kafka records in Redpanda Cloud based on your provided JavaScript code.

include::ROOT:reference:console/programmable-push-filters.adoc[tag=single-source]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Deserialization
:page-aliases: console:features/record-deserialization.adoc, manage:console/protobuf.adoc, reference:console/record-deserialization.adoc
:description: Learn how Redpanda Cloud deserializes messages.

include::ROOT:reference:console/record-deserialization.adoc[tag=single-source]
1 change: 1 addition & 0 deletions modules/manage/pages/schema-reg/schema-reg-ui.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Use Schema Registry
:page-categories: Management, Schema Registry
:page-aliases: deploy:deployment-option/cloud/schema-reg-cloud.adoc
:description: Perform common Schema Registry management operations in Redpanda Cloud.

include::ROOT:manage:schema-reg/schema-reg-ui.adoc[tag=single-source]
5 changes: 5 additions & 0 deletions modules/reference/pages/data-transforms/golang-sdk.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Golang SDK for Data Transforms
:description: Work with data transform APIs in Redpanda using Go.
:page-categories: Development, Stream Processing, Data Transforms

include::ROOT:reference:data-transforms/golang-sdk.adoc[tag=single-source]
3 changes: 3 additions & 0 deletions modules/reference/pages/data-transforms/js/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= JavaScript SDK for Data Transforms
:page-layout: index
:description: This page provides a list of API packages available in the JavaScript SDK for data transforms. Explore the functionalities and methods offered by each package to implement data transforms in your applications.
4 changes: 4 additions & 0 deletions modules/reference/pages/data-transforms/js/js-sdk-sr.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= JavaScript Schema Registry API for Data Transforms
:description: Work with Schema Registry in data transforms using JavaScript.

include::ROOT:reference:data-transforms/js/js-sdk-sr.adoc[tag=single-source]
4 changes: 4 additions & 0 deletions modules/reference/pages/data-transforms/js/js-sdk.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= JavaScript API for Data Transforms
:description: Work with data transforms using JavaScript.

include::ROOT:reference:data-transforms/js/js-sdk.adoc[tag=single-source]
4 changes: 4 additions & 0 deletions modules/reference/pages/data-transforms/rust-sdk.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= Rust SDK for Data Transforms
:description: Work with data transforms using Rust.

include::ROOT:reference:data-transforms/rust-sdk.adoc[tag=single-source]
3 changes: 3 additions & 0 deletions modules/reference/pages/data-transforms/sdks.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Data Transforms SDKs
:description: This page provides a link to all SDK reference docs for data transforms.
:page-layout: index
13 changes: 13 additions & 0 deletions modules/reference/pages/properties/cluster-properties.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
= Cluster Configuration Properties
:page-toclevels: 3
:description: Reference of cluster configuration properties.

Cluster configuration properties are the same for all brokers in a cluster, and are set at the cluster level.

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/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]
3 changes: 3 additions & 0 deletions modules/reference/pages/properties/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Properties
:page-layout: index
:description: Learn about the Redpanda properties you can configure.