From 9eac1b7f7aa0e05f28016b5c5178584d5e97e2c9 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Wed, 14 May 2025 12:37:15 -0600 Subject: [PATCH 1/9] note prop is read-only in Cloud, + GET to cluster config page --- .../pages/cluster-maintenance/config-cluster.adoc | 12 ++++++++++-- .../pages/properties/cluster-properties.adoc | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index bb0469856..c73a1f9fd 100644 --- a/modules/manage/pages/cluster-maintenance/config-cluster.adoc +++ b/modules/manage/pages/cluster-maintenance/config-cluster.adoc @@ -1,9 +1,17 @@ = 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]. + +To view read-only cluster configuration properties, run: + +``` +rpk cluster config get +``` + +For a complete list of the cluster properties available in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties]. == Limitations diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index c609fec33..8ac9e2476 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -10,4 +10,4 @@ NOTE: Some properties require a cluster restart for updates to take effect. This == 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;cluster_id;audit_excluded_topics;http_authentication;cloud_storage_azure_storage_account;cloud_storage_azure_container;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 From fca34e83a7122a1aa5f068155140561d4f6f5713 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Wed, 14 May 2025 15:55:15 -0600 Subject: [PATCH 2/9] add how to view cluster properties --- .../cluster-maintenance/config-cluster.adoc | 66 ++++++++++++++++--- .../pages/properties/cluster-properties.adoc | 2 +- 2 files changed, 58 insertions(+), 10 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index c73a1f9fd..90583f37d 100644 --- a/modules/manage/pages/cluster-maintenance/config-cluster.adoc +++ b/modules/manage/pages/cluster-maintenance/config-cluster.adoc @@ -5,20 +5,17 @@ Cluster configuration properties are set to their default values and automatical 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]. -To view read-only cluster configuration properties, run: - -``` -rpk cluster config get -``` - For a complete list of the cluster properties available in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration 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 @@ -77,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= + +# 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' \ + -d '{"cluster_configuration":{"computed_properties": {"data_transforms_enabled"}}}' +---- + + -- ====== diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index 8ac9e2476..f7a54ea08 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -10,4 +10,4 @@ NOTE: Some properties require a cluster restart for updates to take effect. This == 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;data_transforms_per_function_memory_limit;data_transforms_binary_max_size;log_segment_ms;cluster_id;audit_excluded_topics;http_authentication;cloud_storage_azure_storage_account;cloud_storage_azure_container;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 +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;cluster_id;http_authentication;cloud_storage_azure_storage_account;cloud_storage_azure_container;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 From d0ddf110b45ac50ef1d02bb23383c79e7d41a20a Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Wed, 14 May 2025 17:18:13 -0600 Subject: [PATCH 3/9] add blurb to What's New --- local-antora-playbook.yml | 2 +- modules/get-started/pages/whats-new-cloud.adoc | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 79bc362a8..444d8fb86 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -15,7 +15,7 @@ content: - url: . branches: HEAD - url: https://github.com/redpanda-data/documentation - branches: [main, v/*, api, shared, site-search] + branches: [DOC-1356-single-source-read-only-properties-in-cloud, v/*, api, shared, site-search] - url: https://github.com/redpanda-data/redpanda-labs branches: main start_paths: [docs,'*/docs'] diff --git a/modules/get-started/pages/whats-new-cloud.adoc b/modules/get-started/pages/whats-new-cloud.adoc index 64c06b011..9b7b3b583 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 the xref:reference:properties/cluster-properties.adoc[Cluster Properties Reference]. + === Support for additional region xref:reference:tiers/byoc-tiers.adoc#byoc-supported-regions[BYOC clusters] on GCP now support the us-west2 (Los Angeles) region. From 4d5c1031329159db3ddc2502e6ddbdbef7920f62 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Mon, 19 May 2025 09:03:01 -0600 Subject: [PATCH 4/9] single source object properties from docs repo --- .../pages/properties/cluster-properties.adoc | 4 +--- .../pages/properties/object-storage-properties.adoc | 11 +++++++++++ 2 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 modules/reference/pages/properties/object-storage-properties.adoc diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index f7a54ea08..dbed5809c 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -2,9 +2,7 @@ :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. 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..1f5727831 --- /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. + +== Cloud configuration + +include::ROOT:reference:properties/cluster-properties.adoc[tags=cloud_storage_azure_storage_account;cloud_storage_azure_container] \ No newline at end of file From c630a984ee5daea68bac002e105df6f8b2785f6b Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Mon, 19 May 2025 09:21:39 -0600 Subject: [PATCH 5/9] add object storage properties links in other files --- modules/ROOT/nav.adoc | 1 + modules/get-started/pages/whats-new-cloud.adoc | 2 +- modules/manage/pages/cluster-maintenance/config-cluster.adoc | 2 +- .../reference/pages/properties/object-storage-properties.adoc | 4 ++-- 4 files changed, 5 insertions(+), 4 deletions(-) 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 9b7b3b583..a054eab50 100644 --- a/modules/get-started/pages/whats-new-cloud.adoc +++ b/modules/get-started/pages/whats-new-cloud.adoc @@ -11,7 +11,7 @@ This page lists new features added to Redpanda Cloud. === 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 the xref:reference:properties/cluster-properties.adoc[Cluster Properties Reference]. +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 the xref:reference:properties/cluster-properties.adoc[Cluster Properties Reference] and xref:reference:properties/object-storage-properties.adoc[Object Storage Properties]. === Support for additional region diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index 90583f37d..44c5585d1 100644 --- a/modules/manage/pages/cluster-maintenance/config-cluster.adoc +++ b/modules/manage/pages/cluster-maintenance/config-cluster.adoc @@ -5,7 +5,7 @@ Cluster configuration properties are set to their default values and automatical 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]. +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. diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 1f5727831..762aceb07 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -6,6 +6,6 @@ Object storage properties are a type of cluster property. Cluster properties are 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. -== Cloud configuration +== Cluster configuration -include::ROOT:reference:properties/cluster-properties.adoc[tags=cloud_storage_azure_storage_account;cloud_storage_azure_container] \ No newline at end of file +include::ROOT:reference:properties/object-storage-properties.adoc[tags=cloud_storage_azure_storage_account;cloud_storage_azure_container] \ No newline at end of file From 368b2faaeec788e338fcc2274d84d22e4b27f867 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Mon, 19 May 2025 10:48:27 -0600 Subject: [PATCH 6/9] Update modules/reference/pages/properties/cluster-properties.adoc Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> --- modules/reference/pages/properties/cluster-properties.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index dbed5809c..5b296282d 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -8,4 +8,4 @@ NOTE: Some properties require a cluster restart for updates to take effect. This == 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;data_transforms_per_function_memory_limit;data_transforms_binary_max_size;log_segment_ms;cluster_id;http_authentication;cloud_storage_azure_storage_account;cloud_storage_azure_container;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 +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;cluster_id;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 From 7590b7e264de7479e3dcf53967985e8bf6b24866 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Tue, 20 May 2025 08:05:06 -0600 Subject: [PATCH 7/9] fix API Get & remove cluster_id --- modules/manage/pages/cluster-maintenance/config-cluster.adoc | 3 +-- modules/reference/pages/properties/cluster-properties.adoc | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index 44c5585d1..2b718b8d6 100644 --- a/modules/manage/pages/cluster-maintenance/config-cluster.adoc +++ b/modules/manage/pages/cluster-maintenance/config-cluster.adoc @@ -100,7 +100,7 @@ rpk cluster config get data_transforms_enabled Cloud API:: + -- -Use the Cloud API to get the value of a cluster property. +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`]: @@ -121,7 +121,6 @@ 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"}}}' ---- diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index 5b296282d..ada5e2fac 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -8,4 +8,4 @@ NOTE: Some properties require a cluster restart for updates to take effect. This == 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;data_transforms_per_function_memory_limit;data_transforms_binary_max_size;log_segment_ms;cluster_id;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 +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 From 782e92cfd39e5cc7ee9e37f04fcc1418f8606a0f Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Wed, 21 May 2025 09:22:18 -0600 Subject: [PATCH 8/9] revert playbook back to original --- local-antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 444d8fb86..79bc362a8 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -15,7 +15,7 @@ content: - url: . branches: HEAD - url: https://github.com/redpanda-data/documentation - branches: [DOC-1356-single-source-read-only-properties-in-cloud, v/*, api, shared, site-search] + branches: [main, v/*, api, shared, site-search] - url: https://github.com/redpanda-data/redpanda-labs branches: main start_paths: [docs,'*/docs'] From 95813f159e4a02fde46a7f471ec7536b3a144da7 Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Wed, 21 May 2025 09:24:40 -0600 Subject: [PATCH 9/9] minor edit --- modules/get-started/pages/whats-new-cloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/get-started/pages/whats-new-cloud.adoc b/modules/get-started/pages/whats-new-cloud.adoc index 3b900ff8b..0be6d31b9 100644 --- a/modules/get-started/pages/whats-new-cloud.adoc +++ b/modules/get-started/pages/whats-new-cloud.adoc @@ -11,7 +11,7 @@ This page lists new features added to Redpanda Cloud. === 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 the xref:reference:properties/cluster-properties.adoc[Cluster Properties Reference] and xref:reference:properties/object-storage-properties.adoc[Object Storage 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)