From 661affed4352b0e08dd163af6f1c9f1c308b3895 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Sun, 9 Aug 2026 06:40:16 +0100 Subject: [PATCH 1/2] feat: opt-in property references through the prop macro Registers the prop macro (docs-extensions-and-macros >= 5.7.0) with property-validate: warn and converts plain-backtick cluster property mentions in prose to prop macro calls, validated against the published redpanda-properties JSON. Marked properties get hover tooltips and, with link=true, links that resolve within this component's own property pages (the macro discovers which cloud page documents each property, borrowing the streaming docs only for properties cloud does not publish). --- local-antora-playbook.yml | 3 +++ .../create-mmaker-source-connector.adoc | 2 +- modules/develop/pages/topics/create-topic.adoc | 4 ++-- modules/get-started/pages/cloud-overview.adoc | 2 +- .../pages/cluster-types/byoc/aws/vpc-byo-aws.adoc | 2 +- .../cluster-types/byoc/remote-read-replicas.adoc | 4 ++-- modules/get-started/pages/whats-new-cloud.adoc | 12 ++++++------ .../pages/cluster-maintenance/config-cluster.adoc | 10 +++++----- modules/manage/pages/terraform-provider.adoc | 6 +++--- .../sql/sql-statements/create-redpanda-catalog.adoc | 2 +- 10 files changed, 25 insertions(+), 22 deletions(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 4bd92b979..f5bb6a943 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -32,11 +32,14 @@ ui: snapshot: true asciidoc: attributes: + # Report prop: macro targets missing from the published property JSON. + property-validate: warn extensions: - '@asciidoctor/tabs' - '@redpanda-data/docs-extensions-and-macros/macros/rp-connect-components' - '@redpanda-data/docs-extensions-and-macros/macros/glossary' - '@redpanda-data/docs-extensions-and-macros/macros/config-ref' + - '@redpanda-data/docs-extensions-and-macros/macros/prop' - '@redpanda-data/docs-extensions-and-macros/macros/badge' - '@redpanda-data/docs-extensions-and-macros/macros/helm-ref' - '@redpanda-data/docs-extensions-and-macros/asciidoc-extensions/add-line-numbers-highlights' diff --git a/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc b/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc index d0eef9611..0bcf10b0b 100644 --- a/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc +++ b/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc @@ -134,7 +134,7 @@ on the *Create Connector* page: | Class that defines the remote topic naming convention. Use IdentityReplicationPolicy to preserve topic names. DefaultReplicationPolicy prefixes the topic with the source cluster alias. | `Replication factor` -| `replication.factor` +| prop:replication.factor[] | Replication factor for newly created remote topics. Set -1 for cluster default. | `Refresh topics interval seconds` diff --git a/modules/develop/pages/topics/create-topic.adoc b/modules/develop/pages/topics/create-topic.adoc index fb6a5101c..e6ad2dcd0 100644 --- a/modules/develop/pages/topics/create-topic.adoc +++ b/modules/develop/pages/topics/create-topic.adoc @@ -44,12 +44,12 @@ 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 `max.message.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 prop:max.message.bytes[] topic property. | *Segment size* | The maximum size of a log segment. When a segment reaches this size, Redpanda closes it and starts a new one. -Redpanda Cloud sets the segment size for your cluster automatically. You can override it for a topic with the `segment.bytes` property. +Redpanda Cloud sets the segment size for your cluster automatically. You can override it for a topic with the prop:segment.bytes[] property. |=== == Next steps diff --git a/modules/get-started/pages/cloud-overview.adoc b/modules/get-started/pages/cloud-overview.adoc index 0708427f7..e83059bf8 100644 --- a/modules/get-started/pages/cloud-overview.adoc +++ b/modules/get-started/pages/cloud-overview.adoc @@ -350,7 +350,7 @@ xref:develop:data-transforms/how-transforms-work.adoc[Data transforms] (Wasm) pr == Redpanda Cloud vs Self-Managed feature compatibility -Because Redpanda Cloud is a fully-managed service that provides maintenance, data and partition balancing, upgrades, and recovery, much of the cluster maintenance required for Self-Managed users is not necessary for Redpanda Cloud users. Also, Redpanda Cloud is opinionated about Kafka configurations. For example, automatic topic creation is disabled. Some systems expect the Kafka service to automatically create topics when a message is produced to a topic that doesn't exist. (You can enable this for BYOC and Dedicated clusters with the `auto_create_topics_enabled` cluster property.) +Because Redpanda Cloud is a fully-managed service that provides maintenance, data and partition balancing, upgrades, and recovery, much of the cluster maintenance required for Self-Managed users is not necessary for Redpanda Cloud users. Also, Redpanda Cloud is opinionated about Kafka configurations. For example, automatic topic creation is disabled. Some systems expect the Kafka service to automatically create topics when a message is produced to a topic that doesn't exist. (You can enable this for BYOC and Dedicated clusters with the prop:auto_create_topics_enabled[] cluster property.) New clusters in Redpanda Cloud generally include functionality added in Self-Managed versions immediately. Existing clusters include new functionality when they get upgraded to the latest version. diff --git a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc index d630ec54a..aeb6f41cf 100644 --- a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc +++ b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc @@ -249,7 +249,7 @@ missing permissions are displayed in the output. * IAM instance profile: Checks that `agent_instance_profile`, `connectors_node_group_instance_profile`, `redpanda_node_group_instance_profile`, `redpanda_connect_node_group_instance_profile`, `utility_node_group_instance_profile`, and `k8s_cluster_role` have the minimum required permissions. Any missing permissions are displayed in the output. -* Storage: Checks that the `management_bucket` exists and is versioned, checks that the `cloud_storage_bucket` exists and is not versioned, and checks that the `dynamodb_table` exists. +* Storage: Checks that the `management_bucket` exists and is versioned, checks that the prop:cloud_storage_bucket[] exists and is not versioned, and checks that the `dynamodb_table` exists. * Network: Checks that the VPC exists, checks that the subnets exist and have the expected tags, and checks that the security groups exist and have the desired ingress and egress rules. diff --git a/modules/get-started/pages/cluster-types/byoc/remote-read-replicas.adoc b/modules/get-started/pages/cluster-types/byoc/remote-read-replicas.adoc index a98693125..e1533e81a 100644 --- a/modules/get-started/pages/cluster-types/byoc/remote-read-replicas.adoc +++ b/modules/get-started/pages/cluster-types/byoc/remote-read-replicas.adoc @@ -123,10 +123,10 @@ rpk topic create -c redpanda.remote.readreplica=`, use the same name as the original topic. -- For ``, use the bucket specified in the `cloud_storage_bucket` properties for the origin cluster. +- For ``, use the bucket specified in the prop:cloud_storage_bucket[] properties for the origin cluster. For standard BYOC clusters, the source cluster bucket name follows the pattern: `redpanda-cloud-storage-${SOURCE_CLUSTER_ID}` == Optional: Tune for live topics -For remote read replicas reading from a live topic (that is, a topic that's being actively written to by a source cluster), it may be advantageous to control how often segments are flushed to object storage. By default, this is set to 60 minutes. To tune `cloud_storage_segment_max_upload_interval_sec` on the source cluster, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^]. (For cold topics, where segments are closed and older than 60 minutes, this configuration is unnecessary: the data is already uploaded to object storage.) +For remote read replicas reading from a live topic (that is, a topic that's being actively written to by a source cluster), it may be advantageous to control how often segments are flushed to object storage. By default, this is set to 60 minutes. To tune prop:cloud_storage_segment_max_upload_interval_sec[] on the source cluster, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^]. (For cold topics, where segments are closed and older than 60 minutes, this configuration is unnecessary: the data is already uploaded to object storage.) diff --git a/modules/get-started/pages/whats-new-cloud.adoc b/modules/get-started/pages/whats-new-cloud.adoc index 02c012b51..59b325af3 100644 --- a/modules/get-started/pages/whats-new-cloud.adoc +++ b/modules/get-started/pages/whats-new-cloud.adoc @@ -21,11 +21,11 @@ Redpanda SQL is now available on BYOVPC clusters on AWS. Provision the required === Decode Iceberg keys, values, and headers independently -On BYOC and BYOVPC clusters with Iceberg-enabled topics, the `redpanda.iceberg.mode` topic property now accepts a section-based syntax that lets you independently control how Redpanda translates the record key, value, and headers into the Iceberg table. You can decode keys and header values using a schema or store them as UTF-8 strings, instead of the default raw bytes. See xref:manage:iceberg/specify-iceberg-schema.adoc#configure-key-value-and-header-translation[Configure key, value, and header translation]. +On BYOC and BYOVPC clusters with Iceberg-enabled topics, the prop:redpanda.iceberg.mode[] topic property now accepts a section-based syntax that lets you independently control how Redpanda translates the record key, value, and headers into the Iceberg table. You can decode keys and header values using a schema or store them as UTF-8 strings, instead of the default raw bytes. See xref:manage:iceberg/specify-iceberg-schema.adoc#configure-key-value-and-header-translation[Configure key, value, and header translation]. === Resolve Iceberg topic schemas within a Schema Registry context -On BYOC and BYOVPC clusters, you can now set the `redpanda.schema.registry.context` topic property on an Iceberg-enabled topic to resolve its schemas within a specific xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry context] instead of the default context. See xref:manage:iceberg/specify-iceberg-schema.adoc#resolve-schemas-within-a-context[Resolve schemas within a Schema Registry context]. +On BYOC and BYOVPC clusters, you can now set the prop:redpanda.schema.registry.context[] topic property on an Iceberg-enabled topic to resolve its schemas within a specific xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry context] instead of the default context. See xref:manage:iceberg/specify-iceberg-schema.adoc#resolve-schemas-within-a-context[Resolve schemas within a Schema Registry context]. === Expanded Kafka client validation @@ -97,7 +97,7 @@ BYOC clusters on GCP can now use GCP Lakehouse as an Iceberg REST catalog. See x === Customer-managed default topic settings -You can now set cluster-wide defaults for new topics on BYOC and Dedicated clusters. The xref:reference:properties/cluster-properties.adoc#default_topic_partitions[`default_topic_partitions`], xref:reference:properties/cluster-properties.adoc#log_retention_ms[`log_retention_ms`], and xref:reference:properties/cluster-properties.adoc#retention_bytes[`retention_bytes`] cluster properties are now customer-managed. The default topic retention period (`log_retention_ms`) previously could only be changed by Redpanda support. See xref:manage:cluster-maintenance/config-cluster.adoc[Configure Cluster Properties]. +You can now set cluster-wide defaults for new topics on BYOC and Dedicated clusters. The xref:reference:properties/cluster-properties.adoc#default_topic_partitions[`default_topic_partitions`], xref:reference:properties/cluster-properties.adoc#log_retention_ms[`log_retention_ms`], and xref:reference:properties/cluster-properties.adoc#retention_bytes[`retention_bytes`] cluster properties are now customer-managed. The default topic retention period (prop:log_retention_ms[]) previously could only be changed by Redpanda support. See xref:manage:cluster-maintenance/config-cluster.adoc[Configure Cluster Properties]. === Redpanda Connect updates @@ -173,7 +173,7 @@ You can now subscribe to Redpanda Cloud directly through Google Cloud Marketplac === Iceberg: Configurable table namespace -You can now set a custom namespace for Iceberg tables instead of the default `redpanda` namespace, using the `iceberg_default_catalog_namespace` cluster property. A custom namespace is useful when multiple clusters write to the same catalog provider (such as AWS Glue), because each cluster must use a distinct namespace to avoid table name collisions. This property must be set when you first enable Iceberg and cannot be changed afterward. See xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Enable Iceberg integration]. +You can now set a custom namespace for Iceberg tables instead of the default `redpanda` namespace, using the prop:iceberg_default_catalog_namespace[] cluster property. A custom namespace is useful when multiple clusters write to the same catalog provider (such as AWS Glue), because each cluster must use a distinct namespace to avoid table name collisions. This property must be set when you first enable Iceberg and cannot be changed afterward. See xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Enable Iceberg integration]. === Group-based access control (GBAC) @@ -347,7 +347,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 prop: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. @@ -421,7 +421,7 @@ The Redpanda Cloud Management MCP Server uses the Model Context Protocol (MCP) t === Automatic topic creation and topic limit -For BYOC and Dedicated clusters, you can now configure the `auto_create_topics_enabled` cluster property to automatically create a topic if a client produces to a non-existent topic. +For BYOC and Dedicated clusters, you can now configure the prop:auto_create_topics_enabled[] cluster property to automatically create a topic if a client produces to a non-existent topic. For all clusters: each cluster now has a limit of 40,000 topics. diff --git a/modules/manage/pages/cluster-maintenance/config-cluster.adoc b/modules/manage/pages/cluster-maintenance/config-cluster.adoc index 1b6004794..6fa05bd12 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 are automat 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. +NOTE: Some properties are read-only and cannot be changed. For example, prop:cluster_id[] is a read-only property that is automatically set when the cluster is created. == Prerequisites @@ -120,10 +120,10 @@ You can set cluster-wide defaults that apply to new topics: | Default number of partitions for new topics. | xref:reference:properties/cluster-properties.adoc#log_retention_ms[`log_retention_ms`] -| Default length of time to retain topic data before it becomes eligible for deletion. This sets the default topic retention period, which applies when a topic doesn't set its own `retention.ms`. +| Default length of time to retain topic data before it becomes eligible for deletion. This sets the default topic retention period, which applies when a topic doesn't set its own prop:retention.ms[]. | xref:reference:properties/cluster-properties.adoc#retention_bytes[`retention_bytes`] -| Default maximum size per partition before the oldest data becomes eligible for deletion. Applies when a topic doesn't set its own `retention.bytes`. +| Default maximum size per partition before the oldest data becomes eligible for deletion. Applies when a topic doesn't set its own prop:retention.bytes[]. |=== Set these properties using `rpk` or the Cloud API. For example, to set the default topic retention period to 24 hours: @@ -166,9 +166,9 @@ 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[]. +To control the maximum message size in Redpanda Cloud, set the prop: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`. +The cluster property prop: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 diff --git a/modules/manage/pages/terraform-provider.adoc b/modules/manage/pages/terraform-provider.adoc index e5ac4a685..efd22dec1 100644 --- a/modules/manage/pages/terraform-provider.adoc +++ b/modules/manage/pages/terraform-provider.adoc @@ -497,7 +497,7 @@ resource "redpanda_cluster" "test" { } ---- -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[]. +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, prop:kafka_batch_max_bytes[] cannot be set through the provider. To control the maximum message size, set the prop: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. @@ -959,7 +959,7 @@ resource "redpanda_schema" "user_events" { In this example: -* `cluster_id` identifies the Redpanda cluster where the schema is stored. +* prop:cluster_id[] identifies the Redpanda cluster where the schema is stored. * `subject` defines the logical name under which schema versions are registered. * `schema_type` specifies the serialization type (`AVRO`, `JSON`, or `PROTOBUF`). * `schema` provides the full schema definition, encoded with `jsonencode()`. @@ -1015,7 +1015,7 @@ resource "redpanda_schema_registry_acl" "allow_user_read" { In this example: -* `cluster_id` identifies the cluster that hosts the Schema Registry. +* prop:cluster_id[] identifies the cluster that hosts the Schema Registry. * `principal` specifies the user or service account (for example, `User:alice`). * `resource_type` determines whether the ACL applies to a specific `SUBJECT` or the entire `REGISTRY`. * `resource_name` defines the subject name (use `*` for wildcard). diff --git a/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc b/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc index 750a9ae1a..fb498dade 100644 --- a/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc +++ b/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc @@ -37,7 +37,7 @@ NOTE: Catalogs are created in the current schema (`public` by default). To creat |Yes |URL of the Schema Registry endpoint. -|`sasl_mechanism` +|prop:sasl_mechanism[] |STRING |No |SASL authentication mechanism. Only `SCRAM-SHA-256` and `SCRAM-SHA-512` are accepted. From 24764bb828ad07d50d1b7bf258c8732eb2790c42 Mon Sep 17 00:00:00 2001 From: Jake Cahill Date: Sun, 9 Aug 2026 09:15:26 +0100 Subject: [PATCH 2/2] fix: leave name-colliding identifiers unmarked Four prop: conversions marked identifiers that share a name with a Redpanda property but are not that property in context, so the tooltip would have described something unrelated: - create-redpanda-catalog.adoc: sasl_mechanism is a CREATE REDPANDA CATALOG option. The property of that name is a broker setting for the HTTP Proxy client's connection to the Kafka API. - terraform-provider.adoc (x2): cluster_id is a Terraform resource argument set from data.redpanda_cluster.byoc.id, not the read-only cluster_id cluster property. - vpc-byo-aws.adoc: cloud_storage_bucket is a BYOVPC resource name in a list with management_bucket and dynamodb_table, not a property being set. - create-mmaker-source-connector.adoc: replication.factor is the MirrorMaker connector config key, listed beside replication.policy.class and offset-syncs.topic.replication.factor. In each case the sibling identifiers were correctly left as plain code, so marking only these read as inconsistent as well as wrong. --- .../managed-connectors/create-mmaker-source-connector.adoc | 2 +- .../get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc | 2 +- modules/manage/pages/terraform-provider.adoc | 4 ++-- .../pages/sql/sql-statements/create-redpanda-catalog.adoc | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc b/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc index 0bcf10b0b..d0eef9611 100644 --- a/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc +++ b/modules/develop/pages/managed-connectors/create-mmaker-source-connector.adoc @@ -134,7 +134,7 @@ on the *Create Connector* page: | Class that defines the remote topic naming convention. Use IdentityReplicationPolicy to preserve topic names. DefaultReplicationPolicy prefixes the topic with the source cluster alias. | `Replication factor` -| prop:replication.factor[] +| `replication.factor` | Replication factor for newly created remote topics. Set -1 for cluster default. | `Refresh topics interval seconds` diff --git a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc index aeb6f41cf..d630ec54a 100644 --- a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc +++ b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc @@ -249,7 +249,7 @@ missing permissions are displayed in the output. * IAM instance profile: Checks that `agent_instance_profile`, `connectors_node_group_instance_profile`, `redpanda_node_group_instance_profile`, `redpanda_connect_node_group_instance_profile`, `utility_node_group_instance_profile`, and `k8s_cluster_role` have the minimum required permissions. Any missing permissions are displayed in the output. -* Storage: Checks that the `management_bucket` exists and is versioned, checks that the prop:cloud_storage_bucket[] exists and is not versioned, and checks that the `dynamodb_table` exists. +* Storage: Checks that the `management_bucket` exists and is versioned, checks that the `cloud_storage_bucket` exists and is not versioned, and checks that the `dynamodb_table` exists. * Network: Checks that the VPC exists, checks that the subnets exist and have the expected tags, and checks that the security groups exist and have the desired ingress and egress rules. diff --git a/modules/manage/pages/terraform-provider.adoc b/modules/manage/pages/terraform-provider.adoc index efd22dec1..8916c94cd 100644 --- a/modules/manage/pages/terraform-provider.adoc +++ b/modules/manage/pages/terraform-provider.adoc @@ -959,7 +959,7 @@ resource "redpanda_schema" "user_events" { In this example: -* prop:cluster_id[] identifies the Redpanda cluster where the schema is stored. +* `cluster_id` identifies the Redpanda cluster where the schema is stored. * `subject` defines the logical name under which schema versions are registered. * `schema_type` specifies the serialization type (`AVRO`, `JSON`, or `PROTOBUF`). * `schema` provides the full schema definition, encoded with `jsonencode()`. @@ -1015,7 +1015,7 @@ resource "redpanda_schema_registry_acl" "allow_user_read" { In this example: -* prop:cluster_id[] identifies the cluster that hosts the Schema Registry. +* `cluster_id` identifies the cluster that hosts the Schema Registry. * `principal` specifies the user or service account (for example, `User:alice`). * `resource_type` determines whether the ACL applies to a specific `SUBJECT` or the entire `REGISTRY`. * `resource_name` defines the subject name (use `*` for wildcard). diff --git a/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc b/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc index fb498dade..750a9ae1a 100644 --- a/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc +++ b/modules/reference/pages/sql/sql-statements/create-redpanda-catalog.adoc @@ -37,7 +37,7 @@ NOTE: Catalogs are created in the current schema (`public` by default). To creat |Yes |URL of the Schema Registry endpoint. -|prop:sasl_mechanism[] +|`sasl_mechanism` |STRING |No |SASL authentication mechanism. Only `SCRAM-SHA-256` and `SCRAM-SHA-512` are accepted.