diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index efca6c6ff..b9287687e 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -432,6 +432,7 @@ *** xref:api:ROOT:pandaproxy-schema-registry.adoc[] ** xref:reference:properties/index.adoc[] *** xref:reference:properties/cluster-properties.adoc[] +*** xref:reference:properties/object-storage-properties.adoc[] ** xref:reference:data-transforms/sdks.adoc[] *** xref:reference:data-transforms/golang-sdk.adoc[Golang] *** xref:reference:data-transforms/rust-sdk.adoc[Rust] diff --git a/modules/get-started/pages/whats-new-cloud.adoc b/modules/get-started/pages/whats-new-cloud.adoc index 042f98ad2..0be6d31b9 100644 --- a/modules/get-started/pages/whats-new-cloud.adoc +++ b/modules/get-started/pages/whats-new-cloud.adoc @@ -9,6 +9,10 @@ This page lists new features added to Redpanda Cloud. == May 2025 +=== Read-only cluster configuration properties + +You can now xref:manage:cluster-maintenance/config-cluster.adoc#view-cluster-property-values[view the value of read-only cluster configuration properties] with `rpk cluster config` or with the Cloud API. Available properties are listed in xref:reference:properties/cluster-properties.adoc[Cluster Properties] and xref:reference:properties/object-storage-properties.adoc[Object Storage Properties]. + === Iceberg topics in Azure (beta) xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics] are now supported for BYOC clusters in Azure. diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index bb0469856..2b718b8d6 100644 --- a/modules/manage/pages/cluster-maintenance/config-cluster.adoc +++ b/modules/manage/pages/cluster-maintenance/config-cluster.adoc @@ -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. == 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,56 @@ 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 current configuration property values for a cluster. + +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= + +# 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=" \ + -d "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' \ +---- + + -- ====== diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index c609fec33..ada5e2fac 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -2,12 +2,10 @@ :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[]. +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/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] \ No newline at end of file +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;data_transforms_per_function_memory_limit;data_transforms_binary_max_size;log_segment_ms;http_authentication;iceberg_catalog_base_location;default_topic_replications;minimum_topic_replications;oidc_discovery_url;oidc_principal_mapping;oidc_token_audience;sasl_mechanisms;tls_min_version;audit_log_num_partitions;data_transforms_per_core_memory_reservation] \ No newline at end of file diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc new file mode 100644 index 000000000..762aceb07 --- /dev/null +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -0,0 +1,11 @@ += Object Storage Properties +: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] \ No newline at end of file