diff --git a/modules/develop/pages/topics/create-topic.adoc b/modules/develop/pages/topics/create-topic.adoc index 9bc837556..c1c828260 100644 --- a/modules/develop/pages/topics/create-topic.adoc +++ b/modules/develop/pages/topics/create-topic.adoc @@ -44,7 +44,7 @@ The default is *infinite*. | *Message size* | The maximum size of a message or batch for a newly-created topic. -The default is *20 MiB* for BYOC and Dedicated clusters, and *8 MiB* for Serverless clusters. You can increase this value up to *32 MiB* for BYOC and Dedicated clusters, and *20 MiB* for Serverless clusters, with the `message.max.bytes` topic property. +The default is *20 MiB* for BYOC and Dedicated clusters, and *8 MiB* for Serverless clusters. You can increase this value up to *32 MiB* for BYOC and Dedicated clusters, and *20 MiB* for Serverless clusters, with the `max.message.bytes` topic property. |=== == Next steps diff --git a/modules/get-started/pages/whats-new-cloud.adoc b/modules/get-started/pages/whats-new-cloud.adoc index ccedee6ac..0cd66b617 100644 --- a/modules/get-started/pages/whats-new-cloud.adoc +++ b/modules/get-started/pages/whats-new-cloud.adoc @@ -267,7 +267,7 @@ You can view details about Kafka client connections using `rpk` or the Data Plan === Increased message size limit -Redpanda Cloud increased the xref:develop:topics/create-topic.adoc[message size limit] on newly-created topics. BYOC and Dedicated clusters have a default message size limit of 20 MiB with a maximum of 32 MiB. Serverless clusters have a default message size limit of 8 MiB with a maximum of 20 MiB. Configure the message size limit with the `max_message_bytes` topic property. +Redpanda Cloud increased the xref:develop:topics/create-topic.adoc[message size limit] on newly-created topics. BYOC and Dedicated clusters have a default message size limit of 20 MiB with a maximum of 32 MiB. Serverless clusters have a default message size limit of 8 MiB with a maximum of 20 MiB. Configure the message size limit with the `max.message.bytes` topic property. The message size setting on existing topics is not changed, but the message size limit on existing topics can only be updated to the new maximum. diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index b85cd747a..1b6004794 100644 --- a/modules/manage/pages/cluster-maintenance/config-cluster.adoc +++ b/modules/manage/pages/cluster-maintenance/config-cluster.adoc @@ -17,13 +17,15 @@ To verify that you're logged into the Redpanda control plane and have the correc == Limitations -Cluster properties are 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. +- They are not available on Serverless clusters. +Only the cluster properties listed in xref:reference:properties/cluster-properties.adoc[] and xref:reference:properties/object-storage-properties.adoc[] are configurable in Redpanda Cloud. Setting an unsupported property through the Cloud API or the xref:manage:terraform-provider.adoc[Redpanda Terraform provider] returns a `REASON_INVALID_INPUT` error indicating that the property is not allowed. To control the maximum message size, see <>. -== Set cluster configuration properties + +== Set cluster configuration properties You can set cluster configuration properties using the `rpk` command-line tool or the Cloud API. @@ -161,6 +163,13 @@ curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X PATCH \ -- ==== +[[max-message-size]] +== Configure the maximum message size + +To control the maximum message size in Redpanda Cloud, set the `max.message.bytes` property on each topic. The default is 20 MiB for BYOC and Dedicated clusters and 8 MiB for Serverless clusters. You can increase it up to 32 MiB for BYOC and Dedicated clusters and 20 MiB for Serverless clusters. To set this property, see xref:develop:topics/create-topic.adoc[]. + +The cluster property `kafka_batch_max_bytes` cannot be set through the Cloud API or the xref:manage:terraform-provider.adoc[Redpanda Terraform provider]. Attempting to set it returns `REASON_INVALID_INPUT` with the message `The properties [kafka_batch_max_bytes] are not allowed`. + == View cluster property values You can see the value of a cluster configuration property using `rpk` or the Cloud API. diff --git a/modules/manage/pages/terraform-provider.adoc b/modules/manage/pages/terraform-provider.adoc index 6d06cedfa..20cdaf397 100644 --- a/modules/manage/pages/terraform-provider.adoc +++ b/modules/manage/pages/terraform-provider.adoc @@ -308,6 +308,27 @@ resource "redpanda_user" "schema_user" { After running `terraform apply`, the provider sends the new password to Redpanda Cloud. Neither the old nor the new value is written to state. +== Configure cluster properties + +To set xref:reference:properties/cluster-properties.adoc[cluster configuration properties] on a BYOC or Dedicated cluster, add a `cluster_configuration` block to the `redpanda_cluster` resource and pass the properties as a JSON string with `custom_properties_json`: + +[source,hcl] +---- +resource "redpanda_cluster" "test" { + # ... other cluster arguments ... + + cluster_configuration = { + custom_properties_json = jsonencode({ + "audit_enabled" = true + }) + } +} +---- + +Only the properties listed in xref:reference:properties/cluster-properties.adoc[] and xref:reference:properties/object-storage-properties.adoc[] can be configured through the provider. Setting an unsupported property returns a `REASON_INVALID_INPUT` error indicating that the property is not allowed. For example, `kafka_batch_max_bytes` cannot be set through the provider. To control the maximum message size, set the `max.message.bytes` property on each topic instead. For more information, see xref:manage:cluster-maintenance/config-cluster.adoc[]. + +NOTE: Cluster properties are not available on Serverless clusters or on BYOC and Dedicated clusters running on Azure. + == Examples The following examples use the Redpanda Terraform provider to create and manage clusters. For descriptions of resources and data sources, see the https://registry.terraform.io/providers/redpanda-data/redpanda/latest/docs[Redpanda Terraform Provider documentation^].