From 5539f42c2f4909ee69fa4e5c110cf038f6b3ac9b Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 12 May 2026 12:07:01 +0100 Subject: [PATCH 01/20] Rename ROOT component to streaming and add unified navigation metadata - Changed component name from ROOT to streaming - Expanded page-header-data with full metadata for unified navigation: - title: Streaming - section: Data Platform - parent-component: self-managed - description: Redpanda broker and rpk CLI - icon: activity - This is for main branch (26.1) which is 'latest' for cloud-docs includes --- antora.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/antora.yml b/antora.yml index fa9fb82423..0e94024989 100644 --- a/antora.yml +++ b/antora.yml @@ -1,4 +1,4 @@ -name: ROOT +name: streaming title: Self-Managed version: 26.1 start_page: home:index.adoc @@ -10,8 +10,13 @@ asciidoc: page-release-date: 2026-03-31 # Only used in the main branch (latest version) page-header-data: + title: "Streaming" + section: "Data Platform" + parent-component: "self-managed" + description: "Redpanda broker and rpk CLI for self-managed deployments." + color: "#107569" order: 2 - color: '#107569' + icon: "activity" # Name of the Redpanda UI used in single-sourced content with Redpanda Cloud. ui: Redpanda Console@ # Fallback versions From 13415591498cc1cb0910a962f054b5194f49b65c Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 12 May 2026 12:14:49 +0100 Subject: [PATCH 02/20] Update all component xrefs for unified navigation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Updated xrefs: redpanda-connect β†’ connect - Updated xrefs: redpanda-cloud β†’ cloud-data-platform - Updated xrefs: redpanda-labs β†’ labs - Updated self-references: ROOT β†’ streaming - Updated context-switcher attributes - Updated image references This ensures all cross-component references work after component renames. --- modules/ROOT/nav.adoc | 4 ++-- .../console/pages/config/configure-console.adoc | 2 +- .../console/pages/config/connect-to-redpanda.adoc | 2 +- modules/console/pages/config/deserialization.adoc | 2 +- .../console/pages/config/enterprise-license.adoc | 2 +- .../console/pages/config/http-path-rewrites.adoc | 2 +- modules/console/pages/config/kafka-connect.adoc | 2 +- .../pages/config/security/authentication.adoc | 2 +- .../pages/config/security/authorization.adoc | 2 +- modules/console/pages/config/security/index.adoc | 2 +- .../pages/config/security/tls-termination.adoc | 2 +- .../console/pages/config/topic-documentation.adoc | 2 +- modules/console/pages/index.adoc | 2 +- modules/console/pages/ui/add-license.adoc | 2 +- modules/console/pages/ui/check-license.adoc | 2 +- modules/console/pages/ui/data-transforms.adoc | 2 +- .../console/pages/ui/edit-topic-configuration.adoc | 2 +- modules/console/pages/ui/generate-bundle.adoc | 2 +- .../pages/ui/programmable-push-filters.adoc | 4 ++-- .../console/pages/ui/record-deserialization.adoc | 2 +- modules/console/pages/ui/schema-reg.adoc | 2 +- .../pages/kafka-connect/deploy-kafka-connect.adoc | 2 +- modules/deploy/pages/kafka-connect/index.adoc | 2 +- .../kafka-connect/k-deploy-kafka-connect.adoc | 2 +- .../partials/kubernetes/guides/next-steps.adoc | 2 +- .../pages/consume-data/follower-fetching.adoc | 2 +- .../pages/data-transforms/how-transforms-work.adoc | 2 +- .../develop/pages/manage-topics/cloud-topics.adoc | 6 +++--- modules/develop/partials/http-proxy.adoc | 2 +- modules/get-started/pages/intro-to-events.adoc | 2 +- modules/get-started/pages/licensing/overview.adoc | 14 +++++++------- modules/get-started/pages/quick-start.adoc | 4 ++-- .../get-started/pages/release-notes/redpanda.adoc | 4 ++-- .../get-started/partials/install-rpk-linux.adoc | 2 +- .../pages/iceberg/migrate-to-iceberg-topics.adoc | 2 +- .../pages/kubernetes/k-manage-connectors.adoc | 2 +- modules/migrate/pages/kubernetes/strimzi.adoc | 2 +- .../pages/rpk/rpk-connect/rpk-connect-streams.adoc | 2 +- .../pages/rpk/rpk-connect/rpk-connect-test.adoc | 2 +- .../pages/rpk/rpk-connect/rpk-connect.adoc | 2 +- .../reference/partials/rpk-cloud-byoc-concept.adoc | 2 +- .../shared/partials/community-supported-kc.adoc | 2 +- 42 files changed, 54 insertions(+), 54 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index ee8e828c6c..bb139d7cb9 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -97,7 +97,7 @@ *** xref:deploy:console/linux/index.adoc[Linux] **** xref:deploy:console/linux/requirements.adoc[Requirements] **** xref:deploy:console/linux/deploy.adoc[Deploy on Linux] -** xref:redpanda-connect:home:index.adoc[Redpanda Connect] +** xref:connect:home:index.adoc[Redpanda Connect] ** xref:deploy:kafka-connect/index.adoc[Kafka Connect] *** xref:deploy:kafka-connect/k-deploy-kafka-connect.adoc[Deploy on Kubernetes] *** xref:deploy:kafka-connect/deploy-kafka-connect.adoc[Deploy on Docker] @@ -302,7 +302,7 @@ **** xref:reference:k-operator-helm-spec.adoc[Redpanda Operator] **** xref:reference:k-console-helm-spec.adoc[Redpanda Console] **** xref:reference:k-connector-helm-spec.adoc[Kafka Connect] -**** xref:redpanda-connect:reference:k-connect-helm-spec.adoc[Redpanda Connect] +**** xref:connect:reference:k-connect-helm-spec.adoc[Redpanda Connect] *** xref:reference:k-crd-index.adoc[] **** xref:reference:k-crd.adoc[] ** xref:reference:monitor-metrics.adoc[Monitoring Metrics] diff --git a/modules/console/pages/config/configure-console.adoc b/modules/console/pages/config/configure-console.adoc index 8453f825de..2dca3094b2 100644 --- a/modules/console/pages/config/configure-console.adoc +++ b/modules/console/pages/config/configure-console.adoc @@ -1,7 +1,7 @@ = Configure Redpanda Console :description: Learn how to configure Redpanda Console using environment variables, YAML files, or command-line arguments. :page-aliases: console:reference/config.adoc, reference:console/config.adoc -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] Redpanda Console loads configuration properties from three sources, in the following order of precedence: diff --git a/modules/console/pages/config/connect-to-redpanda.adoc b/modules/console/pages/config/connect-to-redpanda.adoc index 3f788601f1..adf195f4fb 100644 --- a/modules/console/pages/config/connect-to-redpanda.adoc +++ b/modules/console/pages/config/connect-to-redpanda.adoc @@ -1,6 +1,6 @@ = Configure Redpanda Console to Connect to a Redpanda Cluster :description: Learn how to configure Redpanda Console to connect to a Redpanda cluster and ensure communication with your Redpanda brokers. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/connect-to-redpanda.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/connect-to-redpanda.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] Redpanda Console connects to your Redpanda cluster using dedicated configuration blocks for the Kafka API, Schema Registry API, and Admin API. Each connection serves a different purpose: diff --git a/modules/console/pages/config/deserialization.adoc b/modules/console/pages/config/deserialization.adoc index ded6c24a55..e9404950ef 100644 --- a/modules/console/pages/config/deserialization.adoc +++ b/modules/console/pages/config/deserialization.adoc @@ -1,6 +1,6 @@ = Configure Message Deserialization in Redpanda Console :description: Learn how to configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] Redpanda Console provides tools for deserializing and inspecting messages in Kafka topics. This topic explains how to configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed. diff --git a/modules/console/pages/config/enterprise-license.adoc b/modules/console/pages/config/enterprise-license.adoc index c2832398b2..80e2ddb29b 100644 --- a/modules/console/pages/config/enterprise-license.adoc +++ b/modules/console/pages/config/enterprise-license.adoc @@ -1,6 +1,6 @@ = Add a License Key to Redpanda Console :description: Learn how to apply or update a license key to Redpanda Console. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/enterprise-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/enterprise-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] To enable xref:get-started:licensing/overview.adoc#console[enterprise features for Redpanda Console], you must have an Enterprise Edition license to load at startup. This guide explains how to configure Redpanda Console to load the license key from its local configuration. diff --git a/modules/console/pages/config/http-path-rewrites.adoc b/modules/console/pages/config/http-path-rewrites.adoc index 0b4a11cd13..52433b7108 100644 --- a/modules/console/pages/config/http-path-rewrites.adoc +++ b/modules/console/pages/config/http-path-rewrites.adoc @@ -1,7 +1,7 @@ = HTTP Path Rewrites in Redpanda Console :description: Learn how to configure Redpanda Console to work with your URL path rewrites, particularly when hosted under a subpath. :page-aliases: console:features/http-path-rewrites.adoc, manage:console/http-path-rewrites.adoc -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/http-path-rewrites.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/http-path-rewrites.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] If you want to host Redpanda Console under a subpath rather than the root path, you need to configure HTTP path rewrites. This allows you to serve Redpanda Console under a subpath of your domain, such as `+https://my-company.com/redpanda/console+`, instead of directly from `+https://my-company.com+`. This type of configuration is often necessary when: diff --git a/modules/console/pages/config/kafka-connect.adoc b/modules/console/pages/config/kafka-connect.adoc index 4a0f71a836..8f29fda256 100644 --- a/modules/console/pages/config/kafka-connect.adoc +++ b/modules/console/pages/config/kafka-connect.adoc @@ -1,7 +1,7 @@ = Connect Redpanda Console to Kafka Connect Clusters :description: Learn how to connect one or more Kafka Connect clusters with Redpanda Console. :page-aliases: console:features/kafka-connect.adoc, manage:console/kafka-connect.adoc -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/kafka-connect.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/kafka-connect.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] include::shared:partial$community-supported-kc.adoc[] diff --git a/modules/console/pages/config/security/authentication.adoc b/modules/console/pages/config/security/authentication.adoc index 8962a109cd..a36f8a4170 100644 --- a/modules/console/pages/config/security/authentication.adoc +++ b/modules/console/pages/config/security/authentication.adoc @@ -2,7 +2,7 @@ :description: Learn how authentication in Redpanda Console enables users to log in and optionally forward their credentials to the connected Redpanda cluster, ensuring all API requests are executed under the user's identity. :page-aliases: console:single-sign-on/authentication.adoc, manage:security/console/authentication.adoc, console:config/security/plain.adoc, console:config/security/okta.adoc, console:config/security/generic-oidc.adoc, console:config/security/keycloak.adoc, console:config/security/github.adoc, console:config/security/google.adoc, console:config/security/azure-ad.adoc :page-categories: Security, Management, Redpanda Console -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] diff --git a/modules/console/pages/config/security/authorization.adoc b/modules/console/pages/config/security/authorization.adoc index 5ab60faff9..aa99f9d812 100644 --- a/modules/console/pages/config/security/authorization.adoc +++ b/modules/console/pages/config/security/authorization.adoc @@ -2,7 +2,7 @@ :description: Learn how to configure role-based access control (RBAC) in Redpanda Console to restrict system access to authorized users. :page-aliases: console:single-sign-on/authorization.adoc, manage:security/console/authorization.adoc, console:features/role-bindings.adoc, console:reference/role-bindings.adoc, reference:console/role-bindings.adoc :page-categories: Security, Management, Redpanda Console -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authorization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/authorization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] [NOTE] diff --git a/modules/console/pages/config/security/index.adoc b/modules/console/pages/config/security/index.adoc index 0071a5d8a7..0f0074d807 100644 --- a/modules/console/pages/config/security/index.adoc +++ b/modules/console/pages/config/security/index.adoc @@ -2,5 +2,5 @@ :page-aliases: manage:security/console/index.adoc :description: Learn about security topics for Redpanda Console. :page-layout: index -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] diff --git a/modules/console/pages/config/security/tls-termination.adoc b/modules/console/pages/config/security/tls-termination.adoc index 7860e13cd5..cac494d048 100644 --- a/modules/console/pages/config/security/tls-termination.adoc +++ b/modules/console/pages/config/security/tls-termination.adoc @@ -3,7 +3,7 @@ :description: Learn how to secure Redpanda Console using TLS, either by letting Redpanda Console handle TLS termination or by offloading it to an upstream component, such as a reverse proxy or a Cloud HTTPS LoadBalancer. :page-categories: Management, Security, Redpanda Console :page-exclude-related-labs: true -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/tls-termination.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/tls-termination.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] To secure Redpanda Console using TLS (Transport Layer Security), you can either let Redpanda Console handle TLS termination or you can offload it to an upstream component, such as a reverse proxy or a cloud HTTPS load balancer. TLS termination refers to the process of decrypting incoming TLS-encrypted traffic. Choosing the right approach depends on various factors, such as your application's traffic load, the complexity of your infrastructure, security requirements, and resource availability: diff --git a/modules/console/pages/config/topic-documentation.adoc b/modules/console/pages/config/topic-documentation.adoc index f292de40fe..4c7ce649ca 100644 --- a/modules/console/pages/config/topic-documentation.adoc +++ b/modules/console/pages/config/topic-documentation.adoc @@ -1,7 +1,7 @@ = Enable Topic Documentation in Redpanda Console :description: Learn how to embed your Kafka topic documentation into the Redpanda Console UI by linking a Git repository that contains the topic documentation files. :page-aliases: console:features/topic-documentation.adoc, manage:console/topic-documentation.adoc -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/topic-documentation.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/topic-documentation.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] You can embed topic documentation into the Redpanda Console user interface by providing access to a public or private Git repository that hosts the documentation files in Markdown format. diff --git a/modules/console/pages/index.adoc b/modules/console/pages/index.adoc index d6dd75943c..6a4cbfabbe 100644 --- a/modules/console/pages/index.adoc +++ b/modules/console/pages/index.adoc @@ -1,7 +1,7 @@ = Introduction to Redpanda Console :description: Learn about Redpanda Console: a web interface for managing and interacting with Redpanda clusters. :page-aliases: console:index/index.adoc, console:features/index.adoc, reference:console/index.adoc -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] Redpanda Console is a web interface for managing and interacting with Redpanda clusters. Built to provide a seamless experience for developers working with streaming data, Redpanda Console simplifies tasks associated with managing data streams, offering a UI that helps you monitor, troubleshoot, and optimize your streaming workloads. diff --git a/modules/console/pages/ui/add-license.adoc b/modules/console/pages/ui/add-license.adoc index 2800d5787a..6eb9f2afc0 100644 --- a/modules/console/pages/ui/add-license.adoc +++ b/modules/console/pages/ui/add-license.adoc @@ -1,6 +1,6 @@ = Manage Enterprise Edition Licenses through Redpanda Console :description: Learn how to manage Enterprise Edition licenses in Redpanda Console. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/add-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/add-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] You can add or update an xref:get-started:licensing/overview.adoc#console[Enterprise Edition license] for both Redpanda and Redpanda Console directly through the Redpanda Console UI. diff --git a/modules/console/pages/ui/check-license.adoc b/modules/console/pages/ui/check-license.adoc index a715f5e5d3..7d6d44c048 100644 --- a/modules/console/pages/ui/check-license.adoc +++ b/modules/console/pages/ui/check-license.adoc @@ -1,6 +1,6 @@ = Check License Status in Redpanda Console :description: Learn how to check the status of your Redpanda Enterprise Edition license using the Redpanda Console. This topic includes steps to check license details and understand license warnings. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/check-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/check-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] You can check the expiration date of a license on the **Cluster Overview** page in Redpanda Console, under the **Licensing** section. diff --git a/modules/console/pages/ui/data-transforms.adoc b/modules/console/pages/ui/data-transforms.adoc index 727ebd05ea..6cbbd09df1 100644 --- a/modules/console/pages/ui/data-transforms.adoc +++ b/modules/console/pages/ui/data-transforms.adoc @@ -1,6 +1,6 @@ = Manage Data Transforms in {ui} :description: Use {ui} to 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. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/data-transforms.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/data-transforms.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] // tag::single-source[] diff --git a/modules/console/pages/ui/edit-topic-configuration.adoc b/modules/console/pages/ui/edit-topic-configuration.adoc index ab9207a367..28c977de8b 100644 --- a/modules/console/pages/ui/edit-topic-configuration.adoc +++ b/modules/console/pages/ui/edit-topic-configuration.adoc @@ -1,7 +1,7 @@ = Edit Topic Configuration in {ui} :page-aliases: manage:console/edit-topic-configuration.adoc :description: Learn how to use {ui} to edit the configuration of existing topics in a cluster. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/edit-topic-configuration.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/edit-topic-configuration.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] // tag::single-source[] diff --git a/modules/console/pages/ui/generate-bundle.adoc b/modules/console/pages/ui/generate-bundle.adoc index 902dfd7ccf..131d99ea26 100644 --- a/modules/console/pages/ui/generate-bundle.adoc +++ b/modules/console/pages/ui/generate-bundle.adoc @@ -1,6 +1,6 @@ = Manage Debug Bundles in Redpanda Console :description: Learn how to generate, download, and delete debug bundles in Redpanda Console for comprehensive cluster diagnostics. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/generate-bundle.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/generate-bundle.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] [NOTE] diff --git a/modules/console/pages/ui/programmable-push-filters.adoc b/modules/console/pages/ui/programmable-push-filters.adoc index a003448197..0574afe0af 100644 --- a/modules/console/pages/ui/programmable-push-filters.adoc +++ b/modules/console/pages/ui/programmable-push-filters.adoc @@ -2,7 +2,7 @@ :page-aliases: console:features/programmable-push-filters.adoc, reference:console/programmable-push-filters.adoc // Do not put page aliases in the single-sourced content :description: Learn how to filter Kafka records using custom JavaScript code within {ui}. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/programmable-push-filters.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/programmable-push-filters.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] // tag::single-source[] @@ -23,7 +23,7 @@ To add a JavaScript filter: . Define your JavaScript filtering logic in the provided input area. ifndef::env-cloud[] -image::ROOT:console:js-filter.png[alt="JavaScript filter in {ui}"] +image::streaming:console:js-filter.png[alt="JavaScript filter in {ui}"] endif::[] == Resource usage and performance diff --git a/modules/console/pages/ui/record-deserialization.adoc b/modules/console/pages/ui/record-deserialization.adoc index 30431c1a39..05fd04d33f 100644 --- a/modules/console/pages/ui/record-deserialization.adoc +++ b/modules/console/pages/ui/record-deserialization.adoc @@ -1,7 +1,7 @@ = View Deserialized Messages in {ui} :page-aliases: console:features/record-deserialization.adoc, manage:console/protobuf.adoc, reference:console/record-deserialization.adoc :description: Learn how {ui} deserializes messages. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/record-deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/record-deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] // tag::single-source[] diff --git a/modules/console/pages/ui/schema-reg.adoc b/modules/console/pages/ui/schema-reg.adoc index 755e544bce..7c4572cf64 100644 --- a/modules/console/pages/ui/schema-reg.adoc +++ b/modules/console/pages/ui/schema-reg.adoc @@ -2,7 +2,7 @@ :page-aliases: manage:schema-reg/schema-reg-ui.adoc :page-categories: Management, Schema Registry :description: Learn how to perform common Schema Registry management operations in the {ui}. -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/schema-reg.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:ui/schema-reg.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] // tag::single-source[] diff --git a/modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc b/modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc index ea2fcfe3ad..1adbb80965 100644 --- a/modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc +++ b/modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc @@ -7,7 +7,7 @@ include::shared:partial$community-supported-connectors.adoc[] -TIP: Try xref:redpanda-connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. +TIP: Try xref:connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. The https://hub.docker.com/r/redpandadata/connectors/tags[Redpanda Connectors Docker image^] includes a pre-configured instance of https://redpanda.com/guides/kafka-tutorial/what-is-kafka-connect[Kafka Connect] that works with Redpanda. This image contains _only_ the MirrorMaker2 connector but you can build a custom image to install additional connectors. diff --git a/modules/deploy/pages/kafka-connect/index.adoc b/modules/deploy/pages/kafka-connect/index.adoc index 7284f386c1..516e9ba283 100644 --- a/modules/deploy/pages/kafka-connect/index.adoc +++ b/modules/deploy/pages/kafka-connect/index.adoc @@ -4,6 +4,6 @@ Kafka Connect enables scalable and reliable streaming data integration with Redpanda. This section provides an overview of deployment options and links to platform-specific instructions. -TIP: Try xref:redpanda-connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. +TIP: Try xref:connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. Refer to the platform-specific pages for prerequisites, configuration, and deployment steps. diff --git a/modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc b/modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc index a0c26533ec..b5d1a06020 100644 --- a/modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc +++ b/modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc @@ -10,7 +10,7 @@ This topic describes how to deploy Kafka Connect in Kubernetes using the standal include::shared:partial$community-supported-connectors.adoc[] -TIP: Try xref:redpanda-connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. +TIP: Try xref:connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. The `connectors` Helm chart is a standalone chart that deploys an instance of https://redpanda.com/guides/kafka-tutorial/what-is-kafka-connect[Kafka Connect]. The underlying Docker image contains _only_ the MirrorMaker2 connector but you can build a custom image to install additional connectors. diff --git a/modules/deploy/partials/kubernetes/guides/next-steps.adoc b/modules/deploy/partials/kubernetes/guides/next-steps.adoc index d50c42fae5..8bc7f5e134 100644 --- a/modules/deploy/partials/kubernetes/guides/next-steps.adoc +++ b/modules/deploy/partials/kubernetes/guides/next-steps.adoc @@ -1,6 +1,6 @@ = Next steps -* xref:redpanda-labs:ROOT:index.adoc[Try an example in Redpanda Labs] +* xref:labs:streaming:index.adoc[Try an example in Redpanda Labs] * xref:manage:console/index.adoc[Learn more about Redpanda Console] * xref:get-started:rpk-install.adoc[Learn more about rpk] diff --git a/modules/develop/pages/consume-data/follower-fetching.adoc b/modules/develop/pages/consume-data/follower-fetching.adoc index 2e00d5890c..e76971a15b 100644 --- a/modules/develop/pages/consume-data/follower-fetching.adoc +++ b/modules/develop/pages/consume-data/follower-fetching.adoc @@ -31,7 +31,7 @@ ifdef::env-cloud[] For each consumer, set the `client.rack` property to a rack ID. Rack awareness is pre-enabled for cloud-based clusters in multi-AZ environments. endif::[] -include::ROOT:shared:partial$suggested-video.adoc[] +include::streaming:shared:partial$suggested-video.adoc[] * https://www.youtube.com/watch?v=wV6gH5_yVaw&ab_channel=RedpandaData[YouTube - Redpanda Office Hour: Follower Fetching (52 mins)^] diff --git a/modules/develop/pages/data-transforms/how-transforms-work.adoc b/modules/develop/pages/data-transforms/how-transforms-work.adoc index b32496d565..2f3483ed4c 100644 --- a/modules/develop/pages/data-transforms/how-transforms-work.adoc +++ b/modules/develop/pages/data-transforms/how-transforms-work.adoc @@ -54,7 +54,7 @@ This section outlines the limitations of data transforms. These constraints are === General - *No external access*: Transform functions have no external access to disk or network resources. -- *Single message transforms*: Only single record transforms are supported, but multiple output records from a single input record are supported. For aggregations, joins, or complex transformations, consider using xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect] or https://flink.apache.org/[Apache Flink^]. +- *Single message transforms*: Only single record transforms are supported, but multiple output records from a single input record are supported. For aggregations, joins, or complex transformations, consider using xref:connect:streaming:about.adoc[Redpanda Connect] or https://flink.apache.org/[Apache Flink^]. - *Output topic limit*: Up to eight output topics are supported. - *Delivery semantics*: Transform functions have at-least-once delivery. - *Transactions API*: When clients use the Kafka Transactions API on partitions of an input topic, transform functions process only committed records. diff --git a/modules/develop/pages/manage-topics/cloud-topics.adoc b/modules/develop/pages/manage-topics/cloud-topics.adoc index be21d252df..cd99889aeb 100644 --- a/modules/develop/pages/manage-topics/cloud-topics.adoc +++ b/modules/develop/pages/manage-topics/cloud-topics.adoc @@ -14,9 +14,9 @@ include::shared:partial$enterprise-license.adoc[] ==== endif::[] -include::ROOT:develop:partial$cloud-topics-overview.adoc[tag=intro] +include::streaming:develop:partial$cloud-topics-overview.adoc[tag=intro] -include::ROOT:develop:partial$cloud-topics-overview.adoc[tag=latency-explanation] +include::streaming:develop:partial$cloud-topics-overview.adoc[tag=latency-explanation] == Prerequisites @@ -52,7 +52,7 @@ endif::[] == Limitations -include::ROOT:develop:partial$cloud-topics-limitations.adoc[tag=limitations] +include::streaming:develop:partial$cloud-topics-limitations.adoc[tag=limitations] == Enable Cloud Topics diff --git a/modules/develop/partials/http-proxy.adoc b/modules/develop/partials/http-proxy.adoc index b339b28239..1d8278eba5 100644 --- a/modules/develop/partials/http-proxy.adoc +++ b/modules/develop/partials/http-proxy.adoc @@ -270,7 +270,7 @@ endif::[] NodeJS:: + -- -NOTE: This is based on the assumption that you're in the root directory of an existing NodeJS project. See xref:redpanda-labs:clients:docker-nodejs.adoc[] for an example of a NodeJS project. +NOTE: This is based on the assumption that you're in the root directory of an existing NodeJS project. See xref:labs:clients:docker-nodejs.adoc[] for an example of a NodeJS project. In a terminal window, run: diff --git a/modules/get-started/pages/intro-to-events.adoc b/modules/get-started/pages/intro-to-events.adoc index 27c6c028eb..7f9241102c 100644 --- a/modules/get-started/pages/intro-to-events.adoc +++ b/modules/get-started/pages/intro-to-events.adoc @@ -73,7 +73,7 @@ ifndef::env-cloud[] * To spin up a Redpanda cluster to try it out, see xref:./quick-start.adoc[Redpanda Quickstart]. * To learn more about Redpanda, see xref:./architecture.adoc[How Redpanda Works]. * For information about a Redpanda Self-Managed deployment, see xref:./licenses.adoc[Redpanda Licensing]. -* For information about a Redpanda Cloud deployment, see xref:redpanda-cloud:get-started:cloud-overview.adoc[]. +* For information about a Redpanda Cloud deployment, see xref:cloud-data-platform:get-started:cloud-overview.adoc[]. include::shared:partial$suggested-reading.adoc[] diff --git a/modules/get-started/pages/licensing/overview.adoc b/modules/get-started/pages/licensing/overview.adoc index 8c50d327dc..bc9cad5bb6 100644 --- a/modules/get-started/pages/licensing/overview.adoc +++ b/modules/get-started/pages/licensing/overview.adoc @@ -21,7 +21,7 @@ Go to the Redpanda Self-Managed quickstart to set up a local Redpanda cluster an [NOTE] ==== -Redpanda Cloud is a managed deployment of Redpanda Enterprise Edition. To learn more about Redpanda Cloud, see the xref:redpanda-cloud:get-started:cloud-overview.adoc[]. +Redpanda Cloud is a managed deployment of Redpanda Enterprise Edition. To learn more about Redpanda Cloud, see the xref:cloud-data-platform:get-started:cloud-overview.adoc[]. ==== == Community Edition @@ -85,7 +85,7 @@ include::get-started:partial$licensing/block-upgrades-note.adoc[] + IMPORTANT: To avoid startup issues with Redpanda Console when a trial or Enterprise license expires, use Redpanda Console v2.8.3 or later with clusters running Redpanda 24.3 or later. -- **Redpanda Connect**: To evaluate enterprise features in Redpanda Connect, you must xref:redpanda-connect:get-started:licensing.adoc#apply-a-license-key-to-redpanda-connect[apply a trial license key]. After the 30-day evaluation period, you are blocked from using enterprise connectors unless you https://www.redpanda.com/upgrade[upgrade to an Enterprise Edition license^]. +- **Redpanda Connect**: To evaluate enterprise features in Redpanda Connect, you must xref:connect:get-started:licensing.adoc#apply-a-license-key-to-redpanda-connect[apply a trial license key]. After the 30-day evaluation period, you are blocked from using enterprise connectors unless you https://www.redpanda.com/upgrade[upgrade to an Enterprise Edition license^]. [[self-managed]] === Redpanda enterprise features @@ -219,7 +219,7 @@ The following enterprise features are available with a valid Enterprise Edition |=== | Feature | Description | Restrictions Without Valid License -| xref:redpanda-connect:configuration:allow_and_deny_lists.adoc[Allow or deny lists] +| xref:connect:configuration:allow_and_deny_lists.adoc[Allow or deny lists] | Limit the Redpanda Connect components that users can run within data pipelines on a Redpanda Connect instance. | No change. @@ -227,15 +227,15 @@ The following enterprise features are available with a valid Enterprise Edition | Additional inputs, outputs, and processors available only to enterprise customers. | All enterprise connectors are blocked. -| xref:redpanda-connect:get-started:quickstarts/rpk.adoc#fips-compliance[FIPS compliance] +| xref:connect:get-started:quickstarts/rpk.adoc#fips-compliance[FIPS compliance] | Run Redpanda Connect using a FIPS-compliant version of `rpk`, the Redpanda command-line interface (CLI). | No change. -| xref:redpanda-connect:components:redpanda/about.adoc[Redpanda Connect configuration service] +| xref:connect:components:redpanda/about.adoc[Redpanda Connect configuration service] | A configuration block that you can use to send logs and status events to a topic on a Redpanda cluster. | No change. -| xref:redpanda-connect:configuration:secrets.adoc#look-up-secrets-on-a-remote-system-at-runtime[Secrets management] +| xref:connect:configuration:secrets.adoc#look-up-secrets-on-a-remote-system-at-runtime[Secrets management] | Retrieve secrets values from a remote system, such as a secret management solution, without setting environment variables. | No change. @@ -257,7 +257,7 @@ Redpanda Console offers two methods for applying or updating a license, dependin == Manage licenses for Redpanda Connect -Redpanda Connect offers multiple ways to apply or update your license. See xref:redpanda-connect:get-started:licensing.adoc#apply-a-license-key-to-redpanda-connect[Apply a license key to Redpanda Connect]. +Redpanda Connect offers multiple ways to apply or update your license. See xref:connect:get-started:licensing.adoc#apply-a-license-key-to-redpanda-connect[Apply a license key to Redpanda Connect]. == Next steps diff --git a/modules/get-started/pages/quick-start.adoc b/modules/get-started/pages/quick-start.adoc index 5173dcd955..0d8e2a8313 100644 --- a/modules/get-started/pages/quick-start.adoc +++ b/modules/get-started/pages/quick-start.adoc @@ -791,13 +791,13 @@ rpk connect run https://www.redpanda.com/contact[Contact Redpanda^] to discuss using Redpanda Enterprise Edition in production. -- xref:redpanda-labs:ROOT:index.adoc[Try more examples in Redpanda Labs] +- xref:labs:streaming:index.adoc[Try more examples in Redpanda Labs] - xref:get-started:licensing/overview.adoc[Learn more about enterprise features for Redpanda Self-Managed] - xref:deploy:redpanda/manual/production/index.adoc[Deploy for development or production] == Suggested reading -- xref:redpanda-connect:home:index.adoc[] +- xref:connect:home:index.adoc[] - xref:reference:rpk/index.adoc[] - xref:console:index.adoc[] diff --git a/modules/get-started/pages/release-notes/redpanda.adoc b/modules/get-started/pages/release-notes/redpanda.adoc index 0d5b53ad62..793ae2617c 100644 --- a/modules/get-started/pages/release-notes/redpanda.adoc +++ b/modules/get-started/pages/release-notes/redpanda.adoc @@ -4,8 +4,8 @@ This topic includes new content added in version {page-component-version}. For a complete list of all product updates, see the https://github.com/redpanda-data/redpanda/releases/[Redpanda release notes^]. See also: -* xref:redpanda-cloud:get-started:whats-new-cloud.adoc[] -* xref:redpanda-cloud:get-started:cloud-overview.adoc#redpanda-cloud-vs-self-managed-feature-compatibility[Redpanda Cloud vs Self-Managed feature compatibility] +* xref:cloud-data-platform:get-started:whats-new-cloud.adoc[] +* xref:cloud-data-platform:get-started:cloud-overview.adoc#redpanda-cloud-vs-self-managed-feature-compatibility[Redpanda Cloud vs Self-Managed feature compatibility] == Cloud Topics diff --git a/modules/get-started/partials/install-rpk-linux.adoc b/modules/get-started/partials/install-rpk-linux.adoc index 49654e5ccb..f46a23181b 100644 --- a/modules/get-started/partials/install-rpk-linux.adoc +++ b/modules/get-started/partials/install-rpk-linux.adoc @@ -23,7 +23,7 @@ curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk- ---- ==== -TIP: You can use `rpk` on Windows only with https://learn.microsoft.com/windows/wsl/install[WSL^]. However, commands that require Redpanda to be installed on your machine are not supported, such as xref:ROOT:reference:rpk/rpk-container/rpk-container.adoc[`rpk container`] commands, xref:ROOT:reference:rpk/rpk-iotune.adoc[`rpk iotune`], and xref:ROOT:reference:rpk/rpk-redpanda/rpk-redpanda.adoc[`rpk redpanda`] commands. +TIP: You can use `rpk` on Windows only with https://learn.microsoft.com/windows/wsl/install[WSL^]. However, commands that require Redpanda to be installed on your machine are not supported, such as xref:streaming:reference:rpk/rpk-container/rpk-container.adoc[`rpk container`] commands, xref:streaming:reference:rpk/rpk-iotune.adoc[`rpk iotune`], and xref:streaming:reference:rpk/rpk-redpanda/rpk-redpanda.adoc[`rpk redpanda`] commands. // end::latest[] diff --git a/modules/manage/pages/iceberg/migrate-to-iceberg-topics.adoc b/modules/manage/pages/iceberg/migrate-to-iceberg-topics.adoc index af2523259f..da6f9dc428 100644 --- a/modules/manage/pages/iceberg/migrate-to-iceberg-topics.adoc +++ b/modules/manage/pages/iceberg/migrate-to-iceberg-topics.adoc @@ -8,7 +8,7 @@ // tag::single-source[] ifdef::env-cloud[:rpcn-doc: develop:connect/about.adoc] -ifndef::env-cloud[:rpcn-doc: redpanda-connect:home:index.adoc] +ifndef::env-cloud[:rpcn-doc: connect:home:index.adoc] Migrate existing Iceberg pipelines to Redpanda Iceberg topics to simplify your architecture and reduce operational overhead. diff --git a/modules/manage/pages/kubernetes/k-manage-connectors.adoc b/modules/manage/pages/kubernetes/k-manage-connectors.adoc index 8aebfda7cc..7937fe1d48 100644 --- a/modules/manage/pages/kubernetes/k-manage-connectors.adoc +++ b/modules/manage/pages/kubernetes/k-manage-connectors.adoc @@ -374,4 +374,4 @@ kubectl exec $POD_NAME --namespace -- curl -s 'localhost:8083/connec - xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[Monitor Kafka Connect performance and health] - xref:deploy:kafka-connect/k-deploy-kafka-connect.adoc#install-a-new-connector[Install additional connector plugins] - xref:reference:k-connector-helm-spec.adoc[Configure advanced Kafka Connect settings] -- Explore xref:redpanda-connect:home:index.adoc[Redpanda Connect] for simpler data pipeline creation +- Explore xref:connect:home:index.adoc[Redpanda Connect] for simpler data pipeline creation diff --git a/modules/migrate/pages/kubernetes/strimzi.adoc b/modules/migrate/pages/kubernetes/strimzi.adoc index 98b5d1ae0c..a8d1fa7bb2 100644 --- a/modules/migrate/pages/kubernetes/strimzi.adoc +++ b/modules/migrate/pages/kubernetes/strimzi.adoc @@ -299,7 +299,7 @@ The Redpanda Operator does not support a custom resource for Kafka users. For de The Redpanda Operator does not support a custom resource to define Kafka Connect deployments. Redpanda provides support for Kafka Connect through a separate xref:deploy:kafka-connect/k-deploy-kafka-connect.adoc[Helm chart]. -TIP: You can use the xref:redpanda-connect:get-started:quickstarts/helm-chart.adoc[Redpanda Connect Helm chart], which comes with hundreds of prebuilt connectors, change data capture (CDC) capabilities, and YAML-configurable workflows. +TIP: You can use the xref:connect:get-started:quickstarts/helm-chart.adoc[Redpanda Connect Helm chart], which comes with hundreds of prebuilt connectors, change data capture (CDC) capabilities, and YAML-configurable workflows. [[migrate-kafkabridge]] ==== Migrate the KafkaBridge resource diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc index c83d7297bd..6470e8f554 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc @@ -2,7 +2,7 @@ Run Redpanda Connect in streams mode, where multiple pipelines can be executed in a single process and can be created, updated, and removed with REST HTTP endpoints. In streams mode, the stream fields of a root target configuration (input, buffer, pipeline, output) are ignored. Other fields are shared across all loaded streams (resources, metrics, etc.). -See xref:redpanda-connect:guides:streams_mode/about.adoc[Streams Mode]. +See xref:connect:guides:streams_mode/about.adoc[Streams Mode]. == Usage diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc index 72420fb9bb..1a750bd398 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc @@ -4,7 +4,7 @@ Execute any number of Redpanda Connect unit test definitions. If any tests fail, the process reports the errors and exits with a status code 1. -See xref:redpanda-connect:configuration:unit_testing.adoc[Unit Testing]. +See xref:connect:configuration:unit_testing.adoc[Unit Testing]. == Usage diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc index 3a3c79f04c..481f11a934 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc @@ -1,7 +1,7 @@ = rpk connect :description: These commands let you create and manage data pipelines using Redpanda Connect. -Create and manage data pipelines using Redpanda Connect. For full details, see the xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect documentation]. +Create and manage data pipelines using Redpanda Connect. For full details, see the xref:connect:streaming:about.adoc[Redpanda Connect documentation]. == Usage diff --git a/modules/reference/partials/rpk-cloud-byoc-concept.adoc b/modules/reference/partials/rpk-cloud-byoc-concept.adoc index 8ab73bbf29..f7115189b2 100644 --- a/modules/reference/partials/rpk-cloud-byoc-concept.adoc +++ b/modules/reference/partials/rpk-cloud-byoc-concept.adoc @@ -6,4 +6,4 @@ The BYOC command runs Terraform to create and start the agent. You first need a `redpanda-id` (or cluster ID); this is used to get the details of how your agent should be provisioned. -NOTE: To create a BYOC cluster, use the xref:redpanda-cloud:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[Cloud API] or the Redpanda Cloud UI. The UI contains the parameters necessary to run `rpk cloud byoc apply` with your cloud provider. \ No newline at end of file +NOTE: To create a BYOC cluster, use the xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[Cloud API] or the Redpanda Cloud UI. The UI contains the parameters necessary to run `rpk cloud byoc apply` with your cloud provider. \ No newline at end of file diff --git a/modules/shared/partials/community-supported-kc.adoc b/modules/shared/partials/community-supported-kc.adoc index 0a50ec617c..749d06bc8d 100644 --- a/modules/shared/partials/community-supported-kc.adoc +++ b/modules/shared/partials/community-supported-kc.adoc @@ -1,5 +1,5 @@ :note-caption: Community -NOTE: *Kafka Connect is community-supported on https://redpanda.com/slack[Redpanda Community Slack^]*. Redpanda Data does not provide enterprise support for Kafka Connect with Redpanda Console. For a supported and scalable Kafka Connect alternative, try xref:redpanda-connect:get-started:index.adoc[Redpanda Connect]. +NOTE: *Kafka Connect is community-supported on https://redpanda.com/slack[Redpanda Community Slack^]*. Redpanda Data does not provide enterprise support for Kafka Connect with Redpanda Console. For a supported and scalable Kafka Connect alternative, try xref:connect:get-started:index.adoc[Redpanda Connect]. :note-caption: Note From a4766bf59a162d0c563a7c409dd913be35d9d127 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 12 May 2026 13:34:11 +0100 Subject: [PATCH 03/20] Fix xref errors: labs component uses ROOT module, not streaming --- modules/deploy/partials/kubernetes/guides/next-steps.adoc | 2 +- modules/develop/pages/consume-data/follower-fetching.adoc | 2 +- modules/develop/pages/manage-topics/cloud-topics.adoc | 6 +++--- modules/get-started/pages/quick-start.adoc | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/deploy/partials/kubernetes/guides/next-steps.adoc b/modules/deploy/partials/kubernetes/guides/next-steps.adoc index 8bc7f5e134..d91fe115e1 100644 --- a/modules/deploy/partials/kubernetes/guides/next-steps.adoc +++ b/modules/deploy/partials/kubernetes/guides/next-steps.adoc @@ -1,6 +1,6 @@ = Next steps -* xref:labs:streaming:index.adoc[Try an example in Redpanda Labs] +* xref:labs:ROOT:index.adoc[Try an example in Redpanda Labs] * xref:manage:console/index.adoc[Learn more about Redpanda Console] * xref:get-started:rpk-install.adoc[Learn more about rpk] diff --git a/modules/develop/pages/consume-data/follower-fetching.adoc b/modules/develop/pages/consume-data/follower-fetching.adoc index e76971a15b..1ece89ff49 100644 --- a/modules/develop/pages/consume-data/follower-fetching.adoc +++ b/modules/develop/pages/consume-data/follower-fetching.adoc @@ -31,7 +31,7 @@ ifdef::env-cloud[] For each consumer, set the `client.rack` property to a rack ID. Rack awareness is pre-enabled for cloud-based clusters in multi-AZ environments. endif::[] -include::streaming:shared:partial$suggested-video.adoc[] +include::shared:partial$suggested-video.adoc[] * https://www.youtube.com/watch?v=wV6gH5_yVaw&ab_channel=RedpandaData[YouTube - Redpanda Office Hour: Follower Fetching (52 mins)^] diff --git a/modules/develop/pages/manage-topics/cloud-topics.adoc b/modules/develop/pages/manage-topics/cloud-topics.adoc index cd99889aeb..7620b2efec 100644 --- a/modules/develop/pages/manage-topics/cloud-topics.adoc +++ b/modules/develop/pages/manage-topics/cloud-topics.adoc @@ -14,9 +14,9 @@ include::shared:partial$enterprise-license.adoc[] ==== endif::[] -include::streaming:develop:partial$cloud-topics-overview.adoc[tag=intro] +include::develop:partial$cloud-topics-overview.adoc[tag=intro] -include::streaming:develop:partial$cloud-topics-overview.adoc[tag=latency-explanation] +include::develop:partial$cloud-topics-overview.adoc[tag=latency-explanation] == Prerequisites @@ -52,7 +52,7 @@ endif::[] == Limitations -include::streaming:develop:partial$cloud-topics-limitations.adoc[tag=limitations] +include::develop:partial$cloud-topics-limitations.adoc[tag=limitations] == Enable Cloud Topics diff --git a/modules/get-started/pages/quick-start.adoc b/modules/get-started/pages/quick-start.adoc index 0d8e2a8313..97b98ca51a 100644 --- a/modules/get-started/pages/quick-start.adoc +++ b/modules/get-started/pages/quick-start.adoc @@ -791,7 +791,7 @@ rpk connect run https://www.redpanda.com/contact[Contact Redpanda^] to discuss using Redpanda Enterprise Edition in production. -- xref:labs:streaming:index.adoc[Try more examples in Redpanda Labs] +- xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs] - xref:get-started:licensing/overview.adoc[Learn more about enterprise features for Redpanda Self-Managed] - xref:deploy:redpanda/manual/production/index.adoc[Deploy for development or production] From ac082275d305c02caa1bb9fc993818aeb5880e02 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 12 May 2026 16:39:13 +0100 Subject: [PATCH 04/20] Rename Redpanda Self-Managed to Redpanda Streaming - Add product-name attribute to antora.yml for future maintainability - Replace all instances of "Redpanda Self-Managed" with {product-name} in content - Update hardcoded instances in README, CI, and test files Co-Authored-By: Claude Opus 4.5 --- .github/workflows/test-docs.yml | 2 +- README.adoc | 4 ++-- antora.yml | 6 ++++-- modules/ROOT/nav.adoc | 2 +- modules/console/pages/ui/add-license.adoc | 2 +- modules/deploy/pages/index.adoc | 2 +- modules/get-started/pages/docker-compose-labs.adoc | 2 +- modules/get-started/pages/intro-to-events.adoc | 10 +++++----- .../licensing/add-license-redpanda/index.adoc | 2 +- .../licensing/add-license-redpanda/kubernetes.adoc | 4 ++-- .../licensing/add-license-redpanda/linux.adoc | 4 ++-- modules/get-started/pages/licensing/overview.adoc | 2 +- modules/get-started/pages/quick-start.adoc | 14 +++++++------- modules/get-started/pages/rpk-install.adoc | 2 +- modules/home/pages/index.adoc | 2 +- .../cluster-maintenance/disk-utilization.adoc | 2 +- .../pages/iceberg/iceberg-topics-gcp-biglake.adoc | 4 ++-- .../manage/pages/iceberg/use-iceberg-catalogs.adoc | 2 +- .../manage/pages/schema-reg/manage-schema-reg.adoc | 2 +- modules/manage/pages/security/iam-roles.adoc | 4 ++-- modules/manage/pages/use-admin-api.adoc | 6 +++--- modules/manage/partials/remote-read-replicas.adoc | 2 +- modules/reference/pages/api-reference.adoc | 2 +- .../partials/rpk-cloud/rpk-cloud-auth-use.adoc | 2 +- modules/upgrade/partials/versioning.adoc | 2 +- tests/docker-compose/transform/README.adoc | 2 +- 26 files changed, 46 insertions(+), 44 deletions(-) diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml index cf008c049b..5a0b7f05a3 100644 --- a/.github/workflows/test-docs.yml +++ b/.github/workflows/test-docs.yml @@ -80,7 +80,7 @@ jobs: create_issue_on_fail: true token: ${{ env.ACTIONS_BOT_TOKEN }} - - name: Test Redpanda Self-Managed quickstart + - name: Test Redpanda Streaming quickstart if: ${{ needs.setup.outputs.quickstart == 'true' || needs.setup.outputs.console == 'true' }} uses: doc-detective/github-action@v1 with: diff --git a/README.adoc b/README.adoc index 4e30391962..1da74fee61 100644 --- a/README.adoc +++ b/README.adoc @@ -16,7 +16,7 @@ image:https://img.shields.io/coderabbit/prs/github/redpanda-data/docs?utm_source

++++ -This repository hosts the documentation content for Redpanda Self-Managed. +This repository hosts the documentation content for Redpanda Streaming. == Contribute @@ -94,7 +94,7 @@ npm run serve == Versioning -Versioned content is stored in branches that track the version of Redpanda Self-Managed. Production branches use the *v/x.y* naming pattern. For example, branch `v/22.3` hosts the content for version 22.3.x of Redpanda Self-Managed. The `main` branch always contains docs for the latest release. +Versioned content is stored in branches that track the version of Redpanda Streaming. Production branches use the *v/x.y* naming pattern. For example, branch `v/22.3` hosts the content for version 22.3.x of Redpanda Streaming. The `main` branch always contains docs for the latest release. The production {url-playbook}[docs site playbook] instructs Antora to automatically aggregate content in the following branches: diff --git a/antora.yml b/antora.yml index 0e94024989..73368fad99 100644 --- a/antora.yml +++ b/antora.yml @@ -6,6 +6,8 @@ nav: - modules/ROOT/nav.adoc asciidoc: attributes: + # Product name used throughout the documentation + product-name: Redpanda Streaming # Date of release in the format YYYY-MM-DD page-release-date: 2026-03-31 # Only used in the main branch (latest version) @@ -86,7 +88,7 @@ asciidoc: - page: develop/guide-nodejs/ reason: Page moved to Redpanda Labs. # Data for the home page - page-home-intro: Redpanda is a Kafka-compatible event streaming platform built for data-intensive applications. Install Self-Managed Redpanda in your environment with the free Community Edition or with the Enterprise Edition for additional features like Tiered Storage, Continuous Data Balancing, and Audit Logging. + page-home-intro: Redpanda is a Kafka-compatible event streaming platform built for data-intensive applications. Install Redpanda Streaming in your environment with the free Community Edition or with the Enterprise Edition for additional features like Tiered Storage, Continuous Data Balancing, and Audit Logging. #page-home-image: page-home-intro-learn-more: get-started:intro-to-events.adoc page-home-primary-row-title: Deploy @@ -118,7 +120,7 @@ asciidoc: url: 'manage:monitoring.adoc' link-text: 'Learn more' - title: 'rpk commands' - description: 'Redpanda CLI reference for Self-Managed Redpanda.' + description: 'Redpanda CLI reference for Redpanda Streaming.' url: 'reference:rpk/index.adoc' link-text: 'Learn more' page-home-tertiary-row-title: 'Labs' diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index bb139d7cb9..6896366f0e 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -9,7 +9,7 @@ ** xref:console:index.adoc[Introduction to Redpanda Console] ** xref:get-started:install-beta.adoc[Install Beta] ** xref:get-started:quickstarts.adoc[Quickstarts] -*** xref:get-started:quick-start.adoc[Redpanda Self-Managed] +*** xref:get-started:quick-start.adoc[{product-name}] *** xref:get-started:rpk-quickstart.adoc[] *** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs] ** xref:get-started:licensing/index.adoc[Redpanda Licensing] diff --git a/modules/console/pages/ui/add-license.adoc b/modules/console/pages/ui/add-license.adoc index 6eb9f2afc0..2966569bbd 100644 --- a/modules/console/pages/ui/add-license.adoc +++ b/modules/console/pages/ui/add-license.adoc @@ -39,7 +39,7 @@ If the existing license expires soon, you can click the *Upload license* button + image::console:license.png[] + -When a new license is uploaded, enterprise features in Redpanda Self-Managed are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. +When a new license is uploaded, enterprise features in {product-name} are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. After restarting Redpanda Console, enterprise features such as RBAC are unlocked. However, to enable and use these features, you must configure them. See xref:console:config/index.adoc[]. diff --git a/modules/deploy/pages/index.adoc b/modules/deploy/pages/index.adoc index 05bdf189f5..7b98c7df5a 100644 --- a/modules/deploy/pages/index.adoc +++ b/modules/deploy/pages/index.adoc @@ -1,5 +1,5 @@ = Self-Managed Deployment -:description: Learn about Redpanda Self-Managed deployments. +:description: Learn about {product-name} deployments. :page-layout: index :page-aliases: deployment:index.adoc, deployment:index/index.adoc, deploy:deployment-option/index.adoc, deploy:deployment-option/index/index.adoc, deploy:index/index.adoc, deploy:deployment-option/self-hosted/index.adoc :page-categories: Deployment diff --git a/modules/get-started/pages/docker-compose-labs.adoc b/modules/get-started/pages/docker-compose-labs.adoc index 812f4e5508..00c439d1ad 100644 --- a/modules/get-started/pages/docker-compose-labs.adoc +++ b/modules/get-started/pages/docker-compose-labs.adoc @@ -1,7 +1,7 @@ = Docker Compose Labs :page-index-data: docker-labs-index :page-role: index-list -:description: Explore this collection of hands-on labs for deploying and testing Redpanda Self-Managed using Docker Compose. Whether you're a beginner looking to get started or an experienced user aiming to deepen your knowledge, these labs provide step-by-step instructions and practical examples to enhance your skills. +:description: Explore this collection of hands-on labs for deploying and testing {product-name} using Docker Compose. Whether you're a beginner looking to get started or an experienced user aiming to deepen your knowledge, these labs provide step-by-step instructions and practical examples to enhance your skills. {description} diff --git a/modules/get-started/pages/intro-to-events.adoc b/modules/get-started/pages/intro-to-events.adoc index 7f9241102c..201c77e71a 100644 --- a/modules/get-started/pages/intro-to-events.adoc +++ b/modules/get-started/pages/intro-to-events.adoc @@ -59,20 +59,20 @@ Raft facilitates communication between the nodes in a Redpanda cluster to make s + With the Bring Your Own Cloud (BYOC) offering, you deploy Redpanda in your own virtual private cloud, and all data is contained in your environment. Redpanda handles provisioning, monitoring, and upgrades, but you manage your streaming data without Redpanda's control plane ever seeing it. -== Redpanda Self-Managed versions +== {product-name} versions -You can deploy Redpanda in a self-hosted environment (Redpanda Self-Managed) or as a fully managed cloud service (Redpanda Cloud). +You can deploy Redpanda in a self-hosted environment ({product-name}) or as a fully managed cloud service (Redpanda Cloud). -Redpanda Self-Managed version numbers follow the convention AB.C.D, where AB is the two-digit year, C is the feature release, and D is the patch release. For example, version 22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. +{product-name} version numbers follow the convention AB.C.D, where AB is the two-digit year, C is the feature release, and D is the patch release. For example, version 22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. -Redpanda Cloud releases on a continuous basis and uptakes Redpanda Self-Managed versions. +Redpanda Cloud releases on a continuous basis and uptakes {product-name} versions. ifndef::env-cloud[] == Next steps * To spin up a Redpanda cluster to try it out, see xref:./quick-start.adoc[Redpanda Quickstart]. * To learn more about Redpanda, see xref:./architecture.adoc[How Redpanda Works]. -* For information about a Redpanda Self-Managed deployment, see xref:./licenses.adoc[Redpanda Licensing]. +* For information about a {product-name} deployment, see xref:./licenses.adoc[Redpanda Licensing]. * For information about a Redpanda Cloud deployment, see xref:cloud-data-platform:get-started:cloud-overview.adoc[]. include::shared:partial$suggested-reading.adoc[] diff --git a/modules/get-started/pages/licensing/add-license-redpanda/index.adoc b/modules/get-started/pages/licensing/add-license-redpanda/index.adoc index 2675ea38a1..dc894acc8c 100644 --- a/modules/get-started/pages/licensing/add-license-redpanda/index.adoc +++ b/modules/get-started/pages/licensing/add-license-redpanda/index.adoc @@ -1,3 +1,3 @@ = Add an Enterprise Edition License to Redpanda :page-layout: index -:description: Learn how to add an Enterprise Edition license to Redpanda Self-Managed. +:description: Learn how to add an Enterprise Edition license to {product-name}. diff --git a/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc b/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc index 9be180e5d6..fd7fc49104 100644 --- a/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc +++ b/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc @@ -2,7 +2,7 @@ :description: Learn how to add or update a Redpanda Enterprise Edition license in a Kubernetes environment. :env-kubernetes: true -To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpanda Self-Managed], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for Redpanda Self-Managed in a Kubernetes environment. +To enable xref:get-started:licensing/overview.adoc[enterprise features for {product-name}], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for {product-name} in a Kubernetes environment. == Prerequisites @@ -182,7 +182,7 @@ The process for updating a license depends on how it was originally applied: - <>. - xref:console:ui/add-license.adoc[Use Redpanda Console] -When a new license is uploaded, enterprise features in Redpanda Self-Managed are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. +When a new license is uploaded, enterprise features in {product-name} are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. [[secret-update]] === Update the Kubernetes Secret diff --git a/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc b/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc index 936929208d..7778a4adb0 100644 --- a/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc +++ b/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc @@ -1,7 +1,7 @@ = Add an Enterprise Edition License to Redpanda in Linux :description: Learn how to add or update a Redpanda Enterprise Edition license in a Linux environment. -To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpanda Self-Managed], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for Redpanda Self-Managed in a Linux environment. +To enable xref:get-started:licensing/overview.adoc[enterprise features for {product-name}], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for {product-name} in a Linux environment. == Prerequisites @@ -62,7 +62,7 @@ To update an existing license, you can use one the following methods: - xref:reference:rpk/rpk-cluster/rpk-cluster-license-set.adoc[] - xref:console:ui/add-license.adoc[Redpanda Console] -When a new license is uploaded, enterprise features in Redpanda Self-Managed are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. +When a new license is uploaded, enterprise features in {product-name} are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. == Next steps diff --git a/modules/get-started/pages/licensing/overview.adoc b/modules/get-started/pages/licensing/overview.adoc index bc9cad5bb6..b665632684 100644 --- a/modules/get-started/pages/licensing/overview.adoc +++ b/modules/get-started/pages/licensing/overview.adoc @@ -14,7 +14,7 @@ Redpanda, Redpanda Console, and Redpanda Connect are available in community and [TIP] ==== -Go to the Redpanda Self-Managed quickstart to set up a local Redpanda cluster and try the Enterprise Edition free for up to 60 days. +Go to the {product-name} quickstart to set up a local Redpanda cluster and try the Enterprise Edition free for up to 60 days. ==== :tip-caption: Tip diff --git a/modules/get-started/pages/quick-start.adoc b/modules/get-started/pages/quick-start.adoc index 97b98ca51a..5db803a049 100644 --- a/modules/get-started/pages/quick-start.adoc +++ b/modules/get-started/pages/quick-start.adoc @@ -1,4 +1,4 @@ -= Redpanda Self-Managed Quickstart += {product-name} Quickstart :description: Learn how to quickly start working with a local Redpanda cluster that comes with a free 30-day license for Enterprise Edition. You can also extend the trial license for a further 30 days. :page-aliases: install-upgrade:index.adoc, install-upgrade:index/index.adoc, install-upgrade:start-streaming.adoc, quickstart:console-installation, quickstart:quick-start-docker.adoc, quickstart:quick-start-linux.adoc, quickstart:quick-start-macos.adoc, quickstart:quick-start-windows.adoc, getting-started:quick-start-docker.adoc, getting-started:quick-start-linux.adoc, getting-started:quick-start-windows.adoc, getting-started:quick-start-macos.adoc, console:installation.adoc, get-started:quick-start/quick-start-console.adoc, get-started:quick-start/quick-start-macos.adoc, get-started:quick-start/quick-start-linux.adoc, get-started:quick-start/quick-start-docker.adoc, manage:console/quickstart.adoc, console:quickstart.adoc, console:labs.adoc :page-categories: Deployment, Development, rpk, Redpanda Console @@ -8,11 +8,11 @@ // ========================AUTOMATED TESTS=================================== // The comments in this file are used to run automated tests of the documented steps. Tests are run using GitHub Actions on each pull request that changes this file in the upstream repository. For more details about the testing tool we use, see https://doc-detective.com/. -// (test start {"testId": "quickstart", "description": "Redpanda Self-Managed quickstart"}) +// (test start {"testId": "quickstart", "description": "{product-name} quickstart"}) {description} -Redpanda Self-Managed is a modern streaming platform, compatible with Kafka APIs, designed for speed, simplicity, and efficiency. In this quickstart, you: +{product-name} is a modern streaming platform, compatible with Kafka APIs, designed for speed, simplicity, and efficiency. In this quickstart, you: - Deploy a three-broker Redpanda cluster. - Explore streaming data in Redpanda Console. @@ -29,7 +29,7 @@ This quickstart uses Docker to run Redpanda, which is only for development and t == Enterprise features -The Enterprise Edition of Redpanda Self-Managed adds advanced capabilities to help scale, manage, optimize, and secure your cluster. +The Enterprise Edition of {product-name} adds advanced capabilities to help scale, manage, optimize, and secure your cluster. All new Redpanda clusters include a built-in 30-day Enterprise Edition license, so you can evaluate enterprise features. Some features highlighted in this quickstart require an enterprise license: @@ -82,9 +82,9 @@ https://docs.microsoft.com/en-us/windows/wsl/install[Windows Subsystem for Linux :note-caption: Note -== Deploy Redpanda Self-Managed +== Deploy {product-name} -To download, extract, and start Redpanda Self-Managed in Docker, run: +To download, extract, and start {product-name} in Docker, run: [,bash,subs="attributes+"] ---- @@ -792,7 +792,7 @@ rpk connect run https://www.redpanda.com/contact[Contact Redpanda^] to discuss using Redpanda Enterprise Edition in production. - xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs] -- xref:get-started:licensing/overview.adoc[Learn more about enterprise features for Redpanda Self-Managed] +- xref:get-started:licensing/overview.adoc[Learn more about enterprise features for {product-name}] - xref:deploy:redpanda/manual/production/index.adoc[Deploy for development or production] == Suggested reading diff --git a/modules/get-started/pages/rpk-install.adoc b/modules/get-started/pages/rpk-install.adoc index 681f1ee5d3..25723088f4 100644 --- a/modules/get-started/pages/rpk-install.adoc +++ b/modules/get-started/pages/rpk-install.adoc @@ -12,7 +12,7 @@ The `rpk` tool is a single binary application that provides a way to interact wi * Set up access control lists (ACLs) and other security features ifndef::env-cloud[] -For Redpanda Self-Managed deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster. +For {product-name} deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster. You can also install `rpk` on your local machine as a standalone binary. With this setup, you can connect to a Redpanda cluster on your local machine and to an external one on a remote server. If you use `rpk` as a standalone binary to communicate with a Redpanda cluster, your installed version of `rpk` must match the version of Redpanda running in your cluster. endif::[] diff --git a/modules/home/pages/index.adoc b/modules/home/pages/index.adoc index 9d37a6cee6..de3c5f7377 100644 --- a/modules/home/pages/index.adoc +++ b/modules/home/pages/index.adoc @@ -1,4 +1,4 @@ -= Redpanda Self-Managed Documentation += {product-name} Documentation :page-role: component-home-v2 :description: Home page for the Redpanda docs site. diff --git a/modules/manage/pages/cluster-maintenance/disk-utilization.adoc b/modules/manage/pages/cluster-maintenance/disk-utilization.adoc index b1484a49a7..fdd6e99145 100644 --- a/modules/manage/pages/cluster-maintenance/disk-utilization.adoc +++ b/modules/manage/pages/cluster-maintenance/disk-utilization.adoc @@ -19,7 +19,7 @@ Redpanda provides several ways to manage disk space, with varying degrees of fle == Configure message retention -By default, all topics on Redpanda Self-Managed clusters retain 24 hours of data on local disk, while Redpanda Cloud topics retain 6 hours of data. Redpanda makes use of dynamic xref:#space_management[space management] strategies to save on disk space. If data is written fast enough, however, it's possible to exhaust local disk space even when using Tiered Storage. Proper configuration of message retention properties for your use case can prevent this from happening. +By default, all topics on {product-name} clusters retain 24 hours of data on local disk, while Redpanda Cloud topics retain 6 hours of data. Redpanda makes use of dynamic xref:#space_management[space management] strategies to save on disk space. If data is written fast enough, however, it's possible to exhaust local disk space even when using Tiered Storage. Proper configuration of message retention properties for your use case can prevent this from happening. Retention properties control the minimum length of time messages are kept on disk before they're deleted or compacted. Setting message retention properties is the best way to prevent old messages from accumulating on disk to the point that the disk becomes full. You can configure retention properties to delete messages based on the following conditions: diff --git a/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc b/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc index 076cc1a54e..f5f1930772 100644 --- a/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc +++ b/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc @@ -131,7 +131,7 @@ Replace the placeholder values: == Optional: Deploy Redpanda quickstart on GCP -If you want to quickly test Iceberg topics in BigLake, you can deploy a test environment using the Redpanda Self-Managed quickstart. In this section, you create a new storage bucket for Tiered Storage and Iceberg data. You configure a Redpanda cluster for the BigLake catalog integration and deploy the cluster on a GCP Linux VM instance using Docker Compose. +If you want to quickly test Iceberg topics in BigLake, you can deploy a test environment using the {product-name} quickstart. In this section, you create a new storage bucket for Tiered Storage and Iceberg data. You configure a Redpanda cluster for the BigLake catalog integration and deploy the cluster on a GCP Linux VM instance using Docker Compose. NOTE: If you already have a Redpanda cluster deployed on GCP, skip to <>. @@ -203,7 +203,7 @@ sudo apt-get update sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin ---- -. Download the Redpanda Self-Managed quickstart files: +. Download the {product-name} quickstart files: + [,bash,subs="attributes+"] ---- diff --git a/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc b/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc index dfb9b44a6c..a87ac76f70 100644 --- a/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc +++ b/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc @@ -66,7 +66,7 @@ endif::[] ifndef::env-cloud[] === Limitations -The Iceberg integration for Redpanda Self-Managed supports multiple Iceberg catalogs, with progressive levels of release maturity. Each catalog integration is tested and released independently. +The Iceberg integration for {product-name} supports multiple Iceberg catalogs, with progressive levels of release maturity. Each catalog integration is tested and released independently. The following shows the current status of Iceberg catalog integrations. Check this list regularly as Redpanda continues to expand GA coverage for Iceberg topics. diff --git a/modules/manage/pages/schema-reg/manage-schema-reg.adoc b/modules/manage/pages/schema-reg/manage-schema-reg.adoc index b0c456ae0e..3118d723ae 100644 --- a/modules/manage/pages/schema-reg/manage-schema-reg.adoc +++ b/modules/manage/pages/schema-reg/manage-schema-reg.adoc @@ -1,5 +1,5 @@ = Use Schema Registry :page-layout: index -:description: Learn how to add, delete, and update schemas in Redpanda Self-Managed. +:description: Learn how to add, delete, and update schemas in {product-name}. {description} \ No newline at end of file diff --git a/modules/manage/pages/security/iam-roles.adoc b/modules/manage/pages/security/iam-roles.adoc index f0a188b6a3..05627f836f 100644 --- a/modules/manage/pages/security/iam-roles.adoc +++ b/modules/manage/pages/security/iam-roles.adoc @@ -1,10 +1,10 @@ = IAM Roles -:description: For Redpanda Self-Managed clusters deployed on a public cloud platform, cloud provider IAM roles and managed identities provide a safer alternative to the less secure static credential system, which is based on access keys. +:description: For {product-name} clusters deployed on a public cloud platform, cloud provider IAM roles and managed identities provide a safer alternative to the less secure static credential system, which is based on access keys. :page-aliases: security:iam-roles.adoc :page-categories: Management, Security -For Redpanda Self-Managed clusters deployed on a public cloud platform, cloud provider IAM roles (also known as managed identities) provide a safer alternative to the less secure static credential system, which is based on access keys. With static credentials, the access key and secret key are stored in plaintext in the configuration file. IAM roles are safer because they supply a role with temporary credentials that are dynamically sourced at runtime, and only last for the duration of a single session. These credentials allow you to access the data stored in an S3 bucket or Google Cloud Storage, as well as other resources. +For {product-name} clusters deployed on a public cloud platform, cloud provider IAM roles (also known as managed identities) provide a safer alternative to the less secure static credential system, which is based on access keys. With static credentials, the access key and secret key are stored in plaintext in the configuration file. IAM roles are safer because they supply a role with temporary credentials that are dynamically sourced at runtime, and only last for the duration of a single session. These credentials allow you to access the data stored in an S3 bucket or Google Cloud Storage, as well as other resources. You can use IAM roles with any Redpanda feature that makes use of cloud storage, such as xref:manage:tiered-storage.adoc[Tiered Storage] or xref:manage:remote-read-replicas.adoc[Remote Read Replicas]. diff --git a/modules/manage/pages/use-admin-api.adoc b/modules/manage/pages/use-admin-api.adoc index 8e82068b92..f56dee3bba 100644 --- a/modules/manage/pages/use-admin-api.adoc +++ b/modules/manage/pages/use-admin-api.adoc @@ -1,8 +1,8 @@ = Manage Redpanda using the Admin API :page-categories: Management, High Availability, Upgrades -:description: Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to Redpanda Self-Managed and cannot be done using the standard Kafka API. +:description: Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to {product-name} and cannot be done using the standard Kafka API. -The Redpanda Admin API allows you to manage your cluster and perform operations specific to Redpanda Self-Managed that are not available through the standard Kafka API. You can call the Admin API using any HTTP client. +The Redpanda Admin API allows you to manage your cluster and perform operations specific to {product-name} that are not available through the standard Kafka API. You can call the Admin API using any HTTP client. Most Admin API operations are also available using xref:get-started:intro-to-rpk.adoc[`rpk`], a CLI tool that interacts with the Admin API under the hood. @@ -10,7 +10,7 @@ Redpanda v25.3 introduces new endpoints to the Admin API that are served with ht == Prerequisites -* A running Redpanda Self-Managed cluster. +* A running {product-name} cluster. * Superuser privileges, if xref:manage:security/authentication.adoc#enable-authentication[authentication] is enabled on your cluster for the Admin API. For more information, see xref:manage:security/authentication.adoc#create-superusers[Configure Authentication]. (Some endpoints are read-only and do not require superuser access.) * A tool to make HTTP requests, such as `curl`, or client libraries for your programming language of choice. ** For Admin API operations introduced in v25.3 and later, you can also make requests using a ConnectRPC client. You can install the Connect plugin for your preferred language and use the Protobuf compiler to generate an SDK. These RPC services are also available in a Buf module, which you can access through the https://buf.build/redpandadata/core/docs/dev:redpanda.core.admin.v2[Buf Schema Registry]. The https://buf.build/docs/cli/[Buf CLI] provides an easy way to generate client SDKs. diff --git a/modules/manage/partials/remote-read-replicas.adoc b/modules/manage/partials/remote-read-replicas.adoc index 027a59235b..eeaa6871ed 100644 --- a/modules/manage/partials/remote-read-replicas.adoc +++ b/modules/manage/partials/remote-read-replicas.adoc @@ -491,7 +491,7 @@ A topic's object store thus lags behind the local copy by the xref:reference:tun if set, by the topic's `segment.bytes` value. To reduce this lag in the data availability for the Remote Read Replica: * You can lower the value of `segment.bytes`. This lets Redpanda archive smaller log segments more frequently, at the cost of increasing I/O and file count. -* Redpanda Self-Managed deployments can set an idle timeout with config_ref:{config-ref},true,properties/object-storage-properties[] +* {product-name} deployments can set an idle timeout with config_ref:{config-ref},true,properties/object-storage-properties[] to force Redpanda to periodically archive the contents of open log segments to object storage. This is useful if a topic's write rate is low and log segments are kept open for long periods of time. The appropriate interval may depend on your total partition count: a system with less partitions can handle a higher number of segments per partition. diff --git a/modules/reference/pages/api-reference.adoc b/modules/reference/pages/api-reference.adoc index af89556f7f..a06071fa51 100644 --- a/modules/reference/pages/api-reference.adoc +++ b/modules/reference/pages/api-reference.adoc @@ -11,7 +11,7 @@ Manage schemas within a Redpanda cluster. See also: xref:manage:schema-reg/index HTTP Proxy is an HTTP server that exposes operations you can perform directly on a Redpanda cluster. Use the Redpanda HTTP Proxy API to perform a subset of actions that are also available through the Kafka API, but using simpler REST operations. See also: xref:develop:http-proxy.adoc[Use Redpanda with the HTTP Proxy API]. * Admin API Reference + -Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to Redpanda Self-Managed and cannot be done using the standard Kafka API. See also: xref:manage:use-admin-api.adoc[]. +Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to {product-name} and cannot be done using the standard Kafka API. See also: xref:manage:use-admin-api.adoc[]. + -- * link:/api/doc/admin/[Admin API (legacy)] endpoints are available on all supported versions of Redpanda. Select "v1" in the version selector to view these endpoints. diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc index 6b99c3294b..39487c8174 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc @@ -3,7 +3,7 @@ Select the `rpk` cloud authentication (auth) to use. -This swaps the current cloud authentication to the specified cloud authentication. If your current profile is a cloud profile, this unsets the current profile (because the authorization is now different). If your current profile is for a Redpanda Self-Managed cluster, the profile is kept. +This swaps the current cloud authentication to the specified cloud authentication. If your current profile is a cloud profile, this unsets the current profile (because the authorization is now different). If your current profile is for a {product-name} cluster, the profile is kept. == Usage diff --git a/modules/upgrade/partials/versioning.adoc b/modules/upgrade/partials/versioning.adoc index 3659c3f40e..97857e733e 100644 --- a/modules/upgrade/partials/versioning.adoc +++ b/modules/upgrade/partials/versioning.adoc @@ -1 +1 @@ -Redpanda Self-Managed version numbers follow the convention AB.C.D, where AB is the two digit year, C is the feature release, and D is the patch release. For example, v22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. You can find a list of all releases on https://github.com/redpanda-data/redpanda/releases[GitHub^]. \ No newline at end of file +{product-name} version numbers follow the convention AB.C.D, where AB is the two digit year, C is the feature release, and D is the patch release. For example, v22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. You can find a list of all releases on https://github.com/redpanda-data/redpanda/releases[GitHub^]. \ No newline at end of file diff --git a/tests/docker-compose/transform/README.adoc b/tests/docker-compose/transform/README.adoc index 4485435c06..0b2dc635c1 100644 --- a/tests/docker-compose/transform/README.adoc +++ b/tests/docker-compose/transform/README.adoc @@ -1,6 +1,6 @@ = Modify the Wasm Transform in the Quickstart -This directory contains the Go source code (`transform.go`) for the data transform that is used in the Redpanda Self-Managed quickstart. +This directory contains the Go source code (`transform.go`) for the data transform that is used in the Redpanda Streaming quickstart. If you're following the quickstart, you *do not* need to modify or rebuild this code. The Docker Compose configuration automatically deploys a pre-built transform called `regex.wasm`. However, if you want to customize the data transform logic, continue reading. From 226c38822f2d2ae01c4249789a990c9d7b668f0b Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 12 May 2026 17:06:46 +0100 Subject: [PATCH 05/20] Add cloud-product-name attribute for single-sourced content Co-Authored-By: Claude Opus 4.5 --- antora.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 73368fad99..b1b01191d5 100644 --- a/antora.yml +++ b/antora.yml @@ -6,8 +6,9 @@ nav: - modules/ROOT/nav.adoc asciidoc: attributes: - # Product name used throughout the documentation + # Product names for single-sourced content compatibility product-name: Redpanda Streaming + cloud-product-name: Redpanda Cloud # Date of release in the format YYYY-MM-DD page-release-date: 2026-03-31 # Only used in the main branch (latest version) From 7592bb5699790499fb39b8315513d267720084c1 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 12 May 2026 17:27:02 +0100 Subject: [PATCH 06/20] Remove local product-name attributes (now in shared branch) Co-Authored-By: Claude Opus 4.5 --- antora.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/antora.yml b/antora.yml index b1b01191d5..df7ce6a0ea 100644 --- a/antora.yml +++ b/antora.yml @@ -6,9 +6,6 @@ nav: - modules/ROOT/nav.adoc asciidoc: attributes: - # Product names for single-sourced content compatibility - product-name: Redpanda Streaming - cloud-product-name: Redpanda Cloud # Date of release in the format YYYY-MM-DD page-release-date: 2026-03-31 # Only used in the main branch (latest version) From 3f3da8caca5eddf722392e8f999dc82d37241528 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Thu, 14 May 2026 05:32:18 +0100 Subject: [PATCH 07/20] Rename page-header-data to component-metadata and remove section field - Renamed page-header-data to component-metadata for clarity - Removed redundant section field (hierarchy now from page-navigation config) - Part of config-driven navigation system implementation --- antora.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/antora.yml b/antora.yml index df7ce6a0ea..d116e3a0f9 100644 --- a/antora.yml +++ b/antora.yml @@ -9,9 +9,8 @@ asciidoc: # Date of release in the format YYYY-MM-DD page-release-date: 2026-03-31 # Only used in the main branch (latest version) - page-header-data: + component-metadata: title: "Streaming" - section: "Data Platform" parent-component: "self-managed" description: "Redpanda broker and rpk CLI for self-managed deployments." color: "#107569" From 987d219a3a979416ff0cf50d9e80b4f01a7e94f9 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Fri, 15 May 2026 17:33:00 +0100 Subject: [PATCH 08/20] Update streaming component home page to v3 layout - Switch from component-home-v2 to component-home-v3 - Add deploy section with quickstart, K8s, and Linux options - Add popular topics and labs sections - Update page attributes for new template Co-Authored-By: Claude Sonnet 4.5 --- modules/ROOT/nav.adoc | 2 +- modules/get-started/pages/quick-start.adoc | 16 ++++---- modules/home/pages/index.adoc | 44 ++++++++++++++++++++-- 3 files changed, 50 insertions(+), 12 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 6896366f0e..26111ccdb4 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -9,7 +9,7 @@ ** xref:console:index.adoc[Introduction to Redpanda Console] ** xref:get-started:install-beta.adoc[Install Beta] ** xref:get-started:quickstarts.adoc[Quickstarts] -*** xref:get-started:quick-start.adoc[{product-name}] +*** xref:get-started:quick-start.adoc[Redpanda Streaming] *** xref:get-started:rpk-quickstart.adoc[] *** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs] ** xref:get-started:licensing/index.adoc[Redpanda Licensing] diff --git a/modules/get-started/pages/quick-start.adoc b/modules/get-started/pages/quick-start.adoc index 5db803a049..7693cc99f9 100644 --- a/modules/get-started/pages/quick-start.adoc +++ b/modules/get-started/pages/quick-start.adoc @@ -1,4 +1,4 @@ -= {product-name} Quickstart += Quickstart for Redpanda Self-Managed Data Platform :description: Learn how to quickly start working with a local Redpanda cluster that comes with a free 30-day license for Enterprise Edition. You can also extend the trial license for a further 30 days. :page-aliases: install-upgrade:index.adoc, install-upgrade:index/index.adoc, install-upgrade:start-streaming.adoc, quickstart:console-installation, quickstart:quick-start-docker.adoc, quickstart:quick-start-linux.adoc, quickstart:quick-start-macos.adoc, quickstart:quick-start-windows.adoc, getting-started:quick-start-docker.adoc, getting-started:quick-start-linux.adoc, getting-started:quick-start-windows.adoc, getting-started:quick-start-macos.adoc, console:installation.adoc, get-started:quick-start/quick-start-console.adoc, get-started:quick-start/quick-start-macos.adoc, get-started:quick-start/quick-start-linux.adoc, get-started:quick-start/quick-start-docker.adoc, manage:console/quickstart.adoc, console:quickstart.adoc, console:labs.adoc :page-categories: Deployment, Development, rpk, Redpanda Console @@ -8,13 +8,13 @@ // ========================AUTOMATED TESTS=================================== // The comments in this file are used to run automated tests of the documented steps. Tests are run using GitHub Actions on each pull request that changes this file in the upstream repository. For more details about the testing tool we use, see https://doc-detective.com/. -// (test start {"testId": "quickstart", "description": "{product-name} quickstart"}) +// (test start {"testId": "quickstart", "description": "Redpanda quickstart"}) {description} -{product-name} is a modern streaming platform, compatible with Kafka APIs, designed for speed, simplicity, and efficiency. In this quickstart, you: +Redpanda Data Platform is a modern streaming platform, compatible with Kafka APIs, designed for speed, simplicity, and efficiency. In this quickstart, you: -- Deploy a three-broker Redpanda cluster. +- Deploy a three-broker Redpanda Streaming cluster. - Explore streaming data in Redpanda Console. - Learn the basics of streaming with the Redpanda CLI (`rpk`). - Deploy a streaming pipeline with Redpanda Connect. @@ -29,7 +29,7 @@ This quickstart uses Docker to run Redpanda, which is only for development and t == Enterprise features -The Enterprise Edition of {product-name} adds advanced capabilities to help scale, manage, optimize, and secure your cluster. +The Enterprise Edition of Redpanda adds advanced capabilities to help scale, manage, optimize, and secure your cluster. All new Redpanda clusters include a built-in 30-day Enterprise Edition license, so you can evaluate enterprise features. Some features highlighted in this quickstart require an enterprise license: @@ -82,9 +82,9 @@ https://docs.microsoft.com/en-us/windows/wsl/install[Windows Subsystem for Linux :note-caption: Note -== Deploy {product-name} +== Deploy Redpanda -To download, extract, and start {product-name} in Docker, run: +To download, extract, and start Redpanda in Docker, run: [,bash,subs="attributes+"] ---- @@ -792,7 +792,7 @@ rpk connect run https://www.redpanda.com/contact[Contact Redpanda^] to discuss using Redpanda Enterprise Edition in production. - xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs] -- xref:get-started:licensing/overview.adoc[Learn more about enterprise features for {product-name}] +- xref:get-started:licensing/overview.adoc[Learn more about enterprise features for Redpanda] - xref:deploy:redpanda/manual/production/index.adoc[Deploy for development or production] == Suggested reading diff --git a/modules/home/pages/index.adoc b/modules/home/pages/index.adoc index de3c5f7377..1e6fec0997 100644 --- a/modules/home/pages/index.adoc +++ b/modules/home/pages/index.adoc @@ -1,4 +1,42 @@ -= {product-name} Documentation -:page-role: component-home-v2 -:description: Home page for the Redpanda docs site. += Redpanda Streaming Documentation +:page-layout: component-home-v3 +:page-role: component-home-v3 +:page-toclevels: -1 +:description: Kafka-compatible event streaming with 10x lower latency and no JVM dependencies. Deploy Redpanda on your infrastructure for maximum performance and control. +:page-hero-description: Kafka-compatible event streaming with 10x lower latency and no JVM dependencies. Deploy Redpanda on your infrastructure for maximum performance and control. +// Deploy section - Getting Started +:page-deploy-title: Get started with Streaming +:page-deploy-1-title: Quick start +:page-deploy-1-desc: Set up a local Redpanda cluster in Docker and start streaming in minutes. +:page-deploy-1-link: get-started:quick-start.adoc +:page-deploy-1-icon: lightning +:page-deploy-2-title: Kubernetes +:page-deploy-2-desc: Deploy production-ready clusters with the Redpanda Operator. +:page-deploy-2-link: deploy:deployment-option/self-hosted/kubernetes/index.adoc +:page-deploy-2-icon: kubernetes +:page-deploy-3-title: Linux installation +:page-deploy-3-desc: Install Redpanda on bare metal or VMs for maximum performance. +:page-deploy-3-link: deploy:deployment-option/self-hosted/manual/index.adoc +:page-deploy-3-icon: terminal +// Popular topics section +:page-popular-title: Popular topics +:page-popular-1-title: Configuration +:page-popular-1-desc: Tune Redpanda for your workload with cluster and broker properties. +:page-popular-1-link: reference:properties/cluster-properties.adoc +:page-popular-1-icon: settings +:page-popular-2-title: rpk commands +:page-popular-2-desc: Command-line tool for managing clusters, topics, and data. +:page-popular-2-link: reference:rpk/index.adoc +:page-popular-2-icon: terminal +:page-popular-3-title: Tiered Storage +:page-popular-3-desc: Archive data to object storage for cost-effective long-term retention. +:page-popular-3-link: manage:tiered-storage.adoc +:page-popular-3-icon: archive +:page-popular-4-title: Schema Registry +:page-popular-4-desc: Manage schemas for Avro, Protobuf, and JSON with built-in registry. +:page-popular-4-link: manage:schema-reg/index.adoc +:page-popular-4-icon: box +// Labs section +:page-labs-title: Labs for Streaming +:page-labs-link: https://redpanda.com/labs From 8405d27360739b05557e9235a6bd82ed9451bb81 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 May 2026 11:29:01 +0100 Subject: [PATCH 09/20] Fix broken Labs xrefs on home page - Update component name from redpanda-labs to labs - Fix openai.adoc module from redpanda-connect to connect-plugins Co-Authored-By: Claude Opus 4.5 --- antora.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/antora.yml b/antora.yml index d116e3a0f9..112f2638ef 100644 --- a/antora.yml +++ b/antora.yml @@ -123,10 +123,10 @@ asciidoc: page-home-tertiary-row-title: 'Labs' page-home-tertiary-row: - title: 'Set up Postgres CDC with Debezium and Redpanda' - url: 'redpanda-labs:docker-compose:cdc-postgres-json.adoc' + url: 'labs:docker-compose:cdc-postgres-json.adoc' - title: 'Redact information in JSON messages' - url: 'redpanda-labs:data-transforms:redaction-go.adoc' + url: 'labs:data-transforms:redaction-go.adoc' - title: 'Stream text embeddings with Redpanda, OpenAI, and MongoDB' - url: 'redpanda-labs:redpanda-connect:openai.adoc' + url: 'labs:connect-plugins:openai.adoc' - title: 'Build a chat room application with Redpanda and Rust' - url: 'redpanda-labs:clients:docker-rust.adoc' + url: 'labs:clients:docker-rust.adoc' From 0a955f46542c7e8e005f439b6da83c54b68e2821 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 May 2026 16:43:54 +0100 Subject: [PATCH 10/20] Fix xrefs for single-sourcing in schema-reg-contexts - Add streaming: component prefix to all xrefs for single-sourcing compatibility - Comment out non-existent rpk-registry-context-list and rpk-registry-context-delete xrefs Co-Authored-By: Claude Opus 4.5 --- .../pages/schema-reg/schema-reg-contexts.adoc | 41 +++++++++---------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/modules/manage/pages/schema-reg/schema-reg-contexts.adoc b/modules/manage/pages/schema-reg/schema-reg-contexts.adoc index bccfdb82e0..be1a21b2fa 100644 --- a/modules/manage/pages/schema-reg/schema-reg-contexts.adoc +++ b/modules/manage/pages/schema-reg/schema-reg-contexts.adoc @@ -62,8 +62,8 @@ endif::env-cloud[] Before using Schema Registry contexts, ensure that: -* You are running xref:get-started:release-notes/redpanda.adoc[Redpanda v26.1] or later. -* The xref:reference:properties/cluster-properties.adoc#schema_registry_enable_qualified_subjects[`schema_registry_enable_qualified_subjects`] cluster configuration property is set to `true`. +* You are running xref:streaming:get-started:release-notes/redpanda.adoc[Redpanda v26.1] or later. +* The xref:streaming:reference:properties/cluster-properties.adoc#schema_registry_enable_qualified_subjects[`schema_registry_enable_qualified_subjects`] cluster configuration property is set to `true`. + [IMPORTANT] ==== @@ -482,18 +482,17 @@ NOTE: The default context (`.`) cannot be deleted. For additional detail, refer to the full reference documentation for these commands: -* xref:reference:rpk/rpk-registry/rpk-registry-context-list.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-context-delete.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-schema-list.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-mode-get.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-mode-set.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-subject-delete.adoc[] -* xref:reference:rpk/rpk-registry/rpk-registry-subject-list.adoc[] +// TODO: Add xrefs for rpk-registry-context-list and rpk-registry-context-delete when docs are available +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-schema-list.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-mode-get.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-mode-set.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-subject-delete.adoc[] +* xref:streaming:reference:rpk/rpk-registry/rpk-registry-subject-list.adoc[] [#client-integration-status] == Client integration status @@ -615,7 +614,7 @@ The following Schema Registry metrics include a `context` label, enabling per-co | New `context` label added. |=== -For the full metrics reference, see xref:reference:public-metrics-reference.adoc[]. +For the full metrics reference, see xref:streaming:reference:public-metrics-reference.adoc[]. [#upgrade-considerations] @@ -771,15 +770,15 @@ curl -s -X DELETE http://localhost:8081/contexts/.staging == Suggested reading -* xref:manage:schema-reg/schema-reg-overview.adoc[] -* xref:manage:schema-reg/schema-reg-api.adoc[] -* xref:manage:schema-reg/schema-reg-authorization.adoc[] +* xref:streaming:manage:schema-reg/schema-reg-overview.adoc[] +* xref:streaming:manage:schema-reg/schema-reg-api.adoc[] +* xref:streaming:manage:schema-reg/schema-reg-authorization.adoc[] * link:/api/doc/schema-registry/[Schema Registry API reference] -* xref:reference:public-metrics-reference.adoc[] +* xref:streaming:reference:public-metrics-reference.adoc[] ifndef::env-cloud[] -* xref:reference:cluster-properties.adoc[] +* xref:streaming:reference:cluster-properties.adoc[] endif::env-cloud[] ifdef::env-cloud[] -* xref:reference:properties/cluster-properties.adoc[] +* xref:streaming:reference:properties/cluster-properties.adoc[] endif::env-cloud[] // end::single-source[] From 4cfe6686016b95f8161905ebeea11a540ecc6d51 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 May 2026 18:00:06 +0100 Subject: [PATCH 11/20] Change title from Self-Managed to Streaming Co-Authored-By: Claude Opus 4.5 --- antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 112f2638ef..2f7769400c 100644 --- a/antora.yml +++ b/antora.yml @@ -1,5 +1,5 @@ name: streaming -title: Self-Managed +title: Streaming version: 26.1 start_page: home:index.adoc nav: From b1a5adb33a23e82fdc70cec6a8184033c27df167 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Wed, 20 May 2026 14:58:25 +0100 Subject: [PATCH 12/20] Remove duplicate page-role attribute from streaming home page Only page-layout is needed; page-role is redundant as the layout automatically sets the correct role class. --- modules/home/pages/index.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/home/pages/index.adoc b/modules/home/pages/index.adoc index 1e6fec0997..07c889e67c 100644 --- a/modules/home/pages/index.adoc +++ b/modules/home/pages/index.adoc @@ -1,6 +1,5 @@ = Redpanda Streaming Documentation :page-layout: component-home-v3 -:page-role: component-home-v3 :page-toclevels: -1 :description: Kafka-compatible event streaming with 10x lower latency and no JVM dependencies. Deploy Redpanda on your infrastructure for maximum performance and control. :page-hero-description: Kafka-compatible event streaming with 10x lower latency and no JVM dependencies. Deploy Redpanda on your infrastructure for maximum performance and control. From 9db51a5499e56d1c3958fc82fc74c9b0fdd5e748 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Wed, 20 May 2026 15:32:31 +0100 Subject: [PATCH 13/20] Add component-specific AI suggestions for chat drawer Defines 4 streaming-specific AI suggestion questions that appear in the Ask AI chat drawer when viewing streaming documentation. Co-Authored-By: Claude Sonnet 4.5 --- antora.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/antora.yml b/antora.yml index 2f7769400c..80b898d388 100644 --- a/antora.yml +++ b/antora.yml @@ -6,6 +6,11 @@ nav: - modules/ROOT/nav.adoc asciidoc: attributes: + # AI suggestions for the chat drawer + ai-suggestion-1: How do I configure a Redpanda cluster? + ai-suggestion-2: What are best practices for Kafka migration? + ai-suggestion-3: How do I set up Tiered Storage? + ai-suggestion-4: Troubleshoot broker connectivity issues # Date of release in the format YYYY-MM-DD page-release-date: 2026-03-31 # Only used in the main branch (latest version) From 055d461c444e8751c04fe45885bdb1b8a4d6a295 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Thu, 21 May 2026 10:40:08 +0100 Subject: [PATCH 14/20] Add version selector footer link attributes for 26.1/main with .adoc extension --- antora.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/antora.yml b/antora.yml index 80b898d388..b9784df32b 100644 --- a/antora.yml +++ b/antora.yml @@ -11,6 +11,11 @@ asciidoc: ai-suggestion-2: What are best practices for Kafka migration? ai-suggestion-3: How do I set up Tiered Storage? ai-suggestion-4: Troubleshoot broker connectivity issues + # Version selector footer links (used by compute-end-of-life extension) + # page-whats-new-doc: Antora resource ID for the "What's new" link in version dropdown footer + # page-upgrade-doc: Antora resource ID for the "Upgrade guide" link in version dropdown footer + page-whats-new-doc: get-started:release-notes/index.adoc + page-upgrade-doc: upgrade:index.adoc # Date of release in the format YYYY-MM-DD page-release-date: 2026-03-31 # Only used in the main branch (latest version) From d6108fc32f5d120eb0c1cb0bb290d32dd6b1edaa Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Fri, 22 May 2026 16:56:26 +0100 Subject: [PATCH 15/20] Enable parent context navigation cards Add page-use-parent-context flag to enable hierarchical navigation with parent context cards in the UI. This shows the Self-Managed parent card with Streaming/Connect subcards when viewing Streaming pages. Co-Authored-By: Claude Sonnet 4.5 --- antora.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/antora.yml b/antora.yml index 956701f1f8..4927279d8f 100644 --- a/antora.yml +++ b/antora.yml @@ -6,6 +6,7 @@ nav: - modules/ROOT/nav.adoc asciidoc: attributes: + page-use-parent-context: true # AI suggestions for the chat drawer ai-suggestion-1: How do I configure a Redpanda cluster? ai-suggestion-2: What are best practices for Kafka migration? From de59203e5da6c6b8d19f768e87c7529b9094463c Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Fri, 22 May 2026 17:57:32 +0100 Subject: [PATCH 16/20] Remove unused page-use-parent-context flag Co-Authored-By: Claude Sonnet 4.5 --- antora.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/antora.yml b/antora.yml index 4927279d8f..956701f1f8 100644 --- a/antora.yml +++ b/antora.yml @@ -6,7 +6,6 @@ nav: - modules/ROOT/nav.adoc asciidoc: attributes: - page-use-parent-context: true # AI suggestions for the chat drawer ai-suggestion-1: How do I configure a Redpanda cluster? ai-suggestion-2: What are best practices for Kafka migration? From fee6dcd5c30ac69a949fe882ac10ce7f50f0ef09 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 25 May 2026 09:45:27 +0100 Subject: [PATCH 17/20] Replace {product-name} with Redpanda Streaming Co-Authored-By: Claude Sonnet 4.5 --- add-parent-context-flag.sh | 82 +++++++++++++++++++ modules/console/pages/ui/add-license.adoc | 2 +- modules/deploy/pages/index.adoc | 2 +- .../pages/docker-compose-labs.adoc | 2 +- .../get-started/pages/intro-to-events.adoc | 10 +-- .../licensing/add-license-redpanda/index.adoc | 2 +- .../add-license-redpanda/kubernetes.adoc | 4 +- .../licensing/add-license-redpanda/linux.adoc | 4 +- .../get-started/pages/licensing/overview.adoc | 2 +- modules/get-started/pages/rpk-install.adoc | 2 +- .../cluster-maintenance/disk-utilization.adoc | 2 +- .../iceberg/iceberg-topics-gcp-biglake.adoc | 4 +- .../pages/iceberg/use-iceberg-catalogs.adoc | 2 +- .../pages/schema-reg/manage-schema-reg.adoc | 2 +- modules/manage/pages/security/iam-roles.adoc | 4 +- modules/manage/pages/use-admin-api.adoc | 6 +- .../manage/partials/remote-read-replicas.adoc | 2 +- modules/reference/pages/api-reference.adoc | 2 +- .../rpk-cloud/rpk-cloud-auth-use.adoc | 2 +- modules/upgrade/partials/versioning.adoc | 2 +- 20 files changed, 111 insertions(+), 29 deletions(-) create mode 100755 add-parent-context-flag.sh diff --git a/add-parent-context-flag.sh b/add-parent-context-flag.sh new file mode 100755 index 0000000000..2293f138a3 --- /dev/null +++ b/add-parent-context-flag.sh @@ -0,0 +1,82 @@ +#!/bin/bash + +# Script to add page-use-parent-context flag to all Streaming version branches +# Usage: ./add-parent-context-flag.sh + +set -e + +# Define all branches to update +BRANCHES=( + "feature/rename-streaming-main" + "feature/rename-streaming-23.3" + "feature/rename-streaming-24.1" + "feature/rename-streaming-24.2" + "feature/rename-streaming-24.3" + "feature/rename-streaming-25.1" + "feature/rename-streaming-25.2" + "feature/rename-streaming-25.3" +) + +echo "πŸš€ Starting to add page-use-parent-context flag to all Streaming branches..." +echo "" + +for BRANCH in "${BRANCHES[@]}"; do + echo "═══════════════════════════════════════════════════════════════" + echo "πŸ“ Processing branch: $BRANCH" + echo "═══════════════════════════════════════════════════════════════" + + # Checkout the branch + git checkout "$BRANCH" + + # Check if the flag already exists + if grep -q "page-use-parent-context: true" antora.yml; then + echo "βœ… Flag already exists in $BRANCH, skipping..." + echo "" + continue + fi + + # Add the flag after "attributes:" line + # Using sed to insert the line + sed -i '' '/^ attributes:$/a\ + page-use-parent-context: true +' antora.yml + + # Verify the change was made + if grep -q "page-use-parent-context: true" antora.yml; then + echo "βœ… Successfully added flag to antora.yml" + + # Show the change + echo "πŸ“„ Changes:" + git diff antora.yml | head -15 + + # Commit the change + git add antora.yml + git commit -m "Enable parent context navigation cards + +Add page-use-parent-context flag to enable hierarchical navigation +with parent context cards in the UI. This shows the Self-Managed +parent card with Streaming/Connect subcards when viewing Streaming pages. + +Co-Authored-By: Claude Sonnet 4.5 " + + echo "βœ… Committed changes to $BRANCH" + echo "" + else + echo "❌ Failed to add flag to $BRANCH" + echo "" + exit 1 + fi +done + +echo "═══════════════════════════════════════════════════════════════" +echo "βœ… All branches updated successfully!" +echo "═══════════════════════════════════════════════════════════════" +echo "" +echo "πŸ“€ Ready to push. Run the following commands to push all branches:" +echo "" +for BRANCH in "${BRANCHES[@]}"; do + echo "git push origin $BRANCH" +done +echo "" +echo "Or push all at once with:" +echo "git push origin $(echo ${BRANCHES[@]})" diff --git a/modules/console/pages/ui/add-license.adoc b/modules/console/pages/ui/add-license.adoc index 2966569bbd..7d7529b40f 100644 --- a/modules/console/pages/ui/add-license.adoc +++ b/modules/console/pages/ui/add-license.adoc @@ -39,7 +39,7 @@ If the existing license expires soon, you can click the *Upload license* button + image::console:license.png[] + -When a new license is uploaded, enterprise features in {product-name} are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. +When a new license is uploaded, enterprise features in Redpanda Streaming are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. After restarting Redpanda Console, enterprise features such as RBAC are unlocked. However, to enable and use these features, you must configure them. See xref:console:config/index.adoc[]. diff --git a/modules/deploy/pages/index.adoc b/modules/deploy/pages/index.adoc index 7b98c7df5a..d9ad3edf4c 100644 --- a/modules/deploy/pages/index.adoc +++ b/modules/deploy/pages/index.adoc @@ -1,5 +1,5 @@ = Self-Managed Deployment -:description: Learn about {product-name} deployments. +:description: Learn about Redpanda Streaming deployments. :page-layout: index :page-aliases: deployment:index.adoc, deployment:index/index.adoc, deploy:deployment-option/index.adoc, deploy:deployment-option/index/index.adoc, deploy:index/index.adoc, deploy:deployment-option/self-hosted/index.adoc :page-categories: Deployment diff --git a/modules/get-started/pages/docker-compose-labs.adoc b/modules/get-started/pages/docker-compose-labs.adoc index 00c439d1ad..12605b1830 100644 --- a/modules/get-started/pages/docker-compose-labs.adoc +++ b/modules/get-started/pages/docker-compose-labs.adoc @@ -1,7 +1,7 @@ = Docker Compose Labs :page-index-data: docker-labs-index :page-role: index-list -:description: Explore this collection of hands-on labs for deploying and testing {product-name} using Docker Compose. Whether you're a beginner looking to get started or an experienced user aiming to deepen your knowledge, these labs provide step-by-step instructions and practical examples to enhance your skills. +:description: Explore this collection of hands-on labs for deploying and testing Redpanda Streaming using Docker Compose. Whether you're a beginner looking to get started or an experienced user aiming to deepen your knowledge, these labs provide step-by-step instructions and practical examples to enhance your skills. {description} diff --git a/modules/get-started/pages/intro-to-events.adoc b/modules/get-started/pages/intro-to-events.adoc index 201c77e71a..cc50211a44 100644 --- a/modules/get-started/pages/intro-to-events.adoc +++ b/modules/get-started/pages/intro-to-events.adoc @@ -59,20 +59,20 @@ Raft facilitates communication between the nodes in a Redpanda cluster to make s + With the Bring Your Own Cloud (BYOC) offering, you deploy Redpanda in your own virtual private cloud, and all data is contained in your environment. Redpanda handles provisioning, monitoring, and upgrades, but you manage your streaming data without Redpanda's control plane ever seeing it. -== {product-name} versions +== Redpanda Streaming versions -You can deploy Redpanda in a self-hosted environment ({product-name}) or as a fully managed cloud service (Redpanda Cloud). +You can deploy Redpanda in a self-hosted environment (Redpanda Streaming) or as a fully managed cloud service (Redpanda Cloud). -{product-name} version numbers follow the convention AB.C.D, where AB is the two-digit year, C is the feature release, and D is the patch release. For example, version 22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. +Redpanda Streaming version numbers follow the convention AB.C.D, where AB is the two-digit year, C is the feature release, and D is the patch release. For example, version 22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. -Redpanda Cloud releases on a continuous basis and uptakes {product-name} versions. +Redpanda Cloud releases on a continuous basis and uptakes Redpanda Streaming versions. ifndef::env-cloud[] == Next steps * To spin up a Redpanda cluster to try it out, see xref:./quick-start.adoc[Redpanda Quickstart]. * To learn more about Redpanda, see xref:./architecture.adoc[How Redpanda Works]. -* For information about a {product-name} deployment, see xref:./licenses.adoc[Redpanda Licensing]. +* For information about a Redpanda Streaming deployment, see xref:./licenses.adoc[Redpanda Licensing]. * For information about a Redpanda Cloud deployment, see xref:cloud-data-platform:get-started:cloud-overview.adoc[]. include::shared:partial$suggested-reading.adoc[] diff --git a/modules/get-started/pages/licensing/add-license-redpanda/index.adoc b/modules/get-started/pages/licensing/add-license-redpanda/index.adoc index dc894acc8c..07491009c3 100644 --- a/modules/get-started/pages/licensing/add-license-redpanda/index.adoc +++ b/modules/get-started/pages/licensing/add-license-redpanda/index.adoc @@ -1,3 +1,3 @@ = Add an Enterprise Edition License to Redpanda :page-layout: index -:description: Learn how to add an Enterprise Edition license to {product-name}. +:description: Learn how to add an Enterprise Edition license to Redpanda Streaming. diff --git a/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc b/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc index fd7fc49104..630558bb69 100644 --- a/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc +++ b/modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc @@ -2,7 +2,7 @@ :description: Learn how to add or update a Redpanda Enterprise Edition license in a Kubernetes environment. :env-kubernetes: true -To enable xref:get-started:licensing/overview.adoc[enterprise features for {product-name}], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for {product-name} in a Kubernetes environment. +To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpanda Streaming], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for Redpanda Streaming in a Kubernetes environment. == Prerequisites @@ -182,7 +182,7 @@ The process for updating a license depends on how it was originally applied: - <>. - xref:console:ui/add-license.adoc[Use Redpanda Console] -When a new license is uploaded, enterprise features in {product-name} are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. +When a new license is uploaded, enterprise features in Redpanda Streaming are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. [[secret-update]] === Update the Kubernetes Secret diff --git a/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc b/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc index 7778a4adb0..7fdffdc19f 100644 --- a/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc +++ b/modules/get-started/pages/licensing/add-license-redpanda/linux.adoc @@ -1,7 +1,7 @@ = Add an Enterprise Edition License to Redpanda in Linux :description: Learn how to add or update a Redpanda Enterprise Edition license in a Linux environment. -To enable xref:get-started:licensing/overview.adoc[enterprise features for {product-name}], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for {product-name} in a Linux environment. +To enable xref:get-started:licensing/overview.adoc[enterprise features for Redpanda Streaming], you must have an Enterprise Edition license. This guide outlines how to apply or update an Enterprise Edition license for Redpanda Streaming in a Linux environment. == Prerequisites @@ -62,7 +62,7 @@ To update an existing license, you can use one the following methods: - xref:reference:rpk/rpk-cluster/rpk-cluster-license-set.adoc[] - xref:console:ui/add-license.adoc[Redpanda Console] -When a new license is uploaded, enterprise features in {product-name} are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. +When a new license is uploaded, enterprise features in Redpanda Streaming are unlocked immediately without requiring a cluster restart. However, to unlock enterprise features in Redpanda Console, you must restart the Redpanda Console instance. == Next steps diff --git a/modules/get-started/pages/licensing/overview.adoc b/modules/get-started/pages/licensing/overview.adoc index 2826a3824e..eef690d165 100644 --- a/modules/get-started/pages/licensing/overview.adoc +++ b/modules/get-started/pages/licensing/overview.adoc @@ -14,7 +14,7 @@ Redpanda, Redpanda Console, and Redpanda Connect are available in community and [TIP] ==== -Go to the {product-name} quickstart to set up a local Redpanda cluster and try the Enterprise Edition free for up to 60 days. +Go to the Redpanda Streaming quickstart to set up a local Redpanda cluster and try the Enterprise Edition free for up to 60 days. ==== :tip-caption: Tip diff --git a/modules/get-started/pages/rpk-install.adoc b/modules/get-started/pages/rpk-install.adoc index 25723088f4..da01fa8e53 100644 --- a/modules/get-started/pages/rpk-install.adoc +++ b/modules/get-started/pages/rpk-install.adoc @@ -12,7 +12,7 @@ The `rpk` tool is a single binary application that provides a way to interact wi * Set up access control lists (ACLs) and other security features ifndef::env-cloud[] -For {product-name} deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster. +For Redpanda Streaming deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster. You can also install `rpk` on your local machine as a standalone binary. With this setup, you can connect to a Redpanda cluster on your local machine and to an external one on a remote server. If you use `rpk` as a standalone binary to communicate with a Redpanda cluster, your installed version of `rpk` must match the version of Redpanda running in your cluster. endif::[] diff --git a/modules/manage/pages/cluster-maintenance/disk-utilization.adoc b/modules/manage/pages/cluster-maintenance/disk-utilization.adoc index fdd6e99145..4b5bd55d35 100644 --- a/modules/manage/pages/cluster-maintenance/disk-utilization.adoc +++ b/modules/manage/pages/cluster-maintenance/disk-utilization.adoc @@ -19,7 +19,7 @@ Redpanda provides several ways to manage disk space, with varying degrees of fle == Configure message retention -By default, all topics on {product-name} clusters retain 24 hours of data on local disk, while Redpanda Cloud topics retain 6 hours of data. Redpanda makes use of dynamic xref:#space_management[space management] strategies to save on disk space. If data is written fast enough, however, it's possible to exhaust local disk space even when using Tiered Storage. Proper configuration of message retention properties for your use case can prevent this from happening. +By default, all topics on Redpanda Streaming clusters retain 24 hours of data on local disk, while Redpanda Cloud topics retain 6 hours of data. Redpanda makes use of dynamic xref:#space_management[space management] strategies to save on disk space. If data is written fast enough, however, it's possible to exhaust local disk space even when using Tiered Storage. Proper configuration of message retention properties for your use case can prevent this from happening. Retention properties control the minimum length of time messages are kept on disk before they're deleted or compacted. Setting message retention properties is the best way to prevent old messages from accumulating on disk to the point that the disk becomes full. You can configure retention properties to delete messages based on the following conditions: diff --git a/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc b/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc index f5f1930772..553d37b820 100644 --- a/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc +++ b/modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc @@ -131,7 +131,7 @@ Replace the placeholder values: == Optional: Deploy Redpanda quickstart on GCP -If you want to quickly test Iceberg topics in BigLake, you can deploy a test environment using the {product-name} quickstart. In this section, you create a new storage bucket for Tiered Storage and Iceberg data. You configure a Redpanda cluster for the BigLake catalog integration and deploy the cluster on a GCP Linux VM instance using Docker Compose. +If you want to quickly test Iceberg topics in BigLake, you can deploy a test environment using the Redpanda Streaming quickstart. In this section, you create a new storage bucket for Tiered Storage and Iceberg data. You configure a Redpanda cluster for the BigLake catalog integration and deploy the cluster on a GCP Linux VM instance using Docker Compose. NOTE: If you already have a Redpanda cluster deployed on GCP, skip to <>. @@ -203,7 +203,7 @@ sudo apt-get update sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin ---- -. Download the {product-name} quickstart files: +. Download the Redpanda Streaming quickstart files: + [,bash,subs="attributes+"] ---- diff --git a/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc b/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc index a87ac76f70..4160bd4fd9 100644 --- a/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc +++ b/modules/manage/pages/iceberg/use-iceberg-catalogs.adoc @@ -66,7 +66,7 @@ endif::[] ifndef::env-cloud[] === Limitations -The Iceberg integration for {product-name} supports multiple Iceberg catalogs, with progressive levels of release maturity. Each catalog integration is tested and released independently. +The Iceberg integration for Redpanda Streaming supports multiple Iceberg catalogs, with progressive levels of release maturity. Each catalog integration is tested and released independently. The following shows the current status of Iceberg catalog integrations. Check this list regularly as Redpanda continues to expand GA coverage for Iceberg topics. diff --git a/modules/manage/pages/schema-reg/manage-schema-reg.adoc b/modules/manage/pages/schema-reg/manage-schema-reg.adoc index 3118d723ae..a893088b00 100644 --- a/modules/manage/pages/schema-reg/manage-schema-reg.adoc +++ b/modules/manage/pages/schema-reg/manage-schema-reg.adoc @@ -1,5 +1,5 @@ = Use Schema Registry :page-layout: index -:description: Learn how to add, delete, and update schemas in {product-name}. +:description: Learn how to add, delete, and update schemas in Redpanda Streaming. {description} \ No newline at end of file diff --git a/modules/manage/pages/security/iam-roles.adoc b/modules/manage/pages/security/iam-roles.adoc index 05627f836f..1954da2b61 100644 --- a/modules/manage/pages/security/iam-roles.adoc +++ b/modules/manage/pages/security/iam-roles.adoc @@ -1,10 +1,10 @@ = IAM Roles -:description: For {product-name} clusters deployed on a public cloud platform, cloud provider IAM roles and managed identities provide a safer alternative to the less secure static credential system, which is based on access keys. +:description: For Redpanda Streaming clusters deployed on a public cloud platform, cloud provider IAM roles and managed identities provide a safer alternative to the less secure static credential system, which is based on access keys. :page-aliases: security:iam-roles.adoc :page-categories: Management, Security -For {product-name} clusters deployed on a public cloud platform, cloud provider IAM roles (also known as managed identities) provide a safer alternative to the less secure static credential system, which is based on access keys. With static credentials, the access key and secret key are stored in plaintext in the configuration file. IAM roles are safer because they supply a role with temporary credentials that are dynamically sourced at runtime, and only last for the duration of a single session. These credentials allow you to access the data stored in an S3 bucket or Google Cloud Storage, as well as other resources. +For Redpanda Streaming clusters deployed on a public cloud platform, cloud provider IAM roles (also known as managed identities) provide a safer alternative to the less secure static credential system, which is based on access keys. With static credentials, the access key and secret key are stored in plaintext in the configuration file. IAM roles are safer because they supply a role with temporary credentials that are dynamically sourced at runtime, and only last for the duration of a single session. These credentials allow you to access the data stored in an S3 bucket or Google Cloud Storage, as well as other resources. You can use IAM roles with any Redpanda feature that makes use of cloud storage, such as xref:manage:tiered-storage.adoc[Tiered Storage] or xref:manage:remote-read-replicas.adoc[Remote Read Replicas]. diff --git a/modules/manage/pages/use-admin-api.adoc b/modules/manage/pages/use-admin-api.adoc index f56dee3bba..a3b6717faf 100644 --- a/modules/manage/pages/use-admin-api.adoc +++ b/modules/manage/pages/use-admin-api.adoc @@ -1,8 +1,8 @@ = Manage Redpanda using the Admin API :page-categories: Management, High Availability, Upgrades -:description: Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to {product-name} and cannot be done using the standard Kafka API. +:description: Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to Redpanda Streaming and cannot be done using the standard Kafka API. -The Redpanda Admin API allows you to manage your cluster and perform operations specific to {product-name} that are not available through the standard Kafka API. You can call the Admin API using any HTTP client. +The Redpanda Admin API allows you to manage your cluster and perform operations specific to Redpanda Streaming that are not available through the standard Kafka API. You can call the Admin API using any HTTP client. Most Admin API operations are also available using xref:get-started:intro-to-rpk.adoc[`rpk`], a CLI tool that interacts with the Admin API under the hood. @@ -10,7 +10,7 @@ Redpanda v25.3 introduces new endpoints to the Admin API that are served with ht == Prerequisites -* A running {product-name} cluster. +* A running Redpanda Streaming cluster. * Superuser privileges, if xref:manage:security/authentication.adoc#enable-authentication[authentication] is enabled on your cluster for the Admin API. For more information, see xref:manage:security/authentication.adoc#create-superusers[Configure Authentication]. (Some endpoints are read-only and do not require superuser access.) * A tool to make HTTP requests, such as `curl`, or client libraries for your programming language of choice. ** For Admin API operations introduced in v25.3 and later, you can also make requests using a ConnectRPC client. You can install the Connect plugin for your preferred language and use the Protobuf compiler to generate an SDK. These RPC services are also available in a Buf module, which you can access through the https://buf.build/redpandadata/core/docs/dev:redpanda.core.admin.v2[Buf Schema Registry]. The https://buf.build/docs/cli/[Buf CLI] provides an easy way to generate client SDKs. diff --git a/modules/manage/partials/remote-read-replicas.adoc b/modules/manage/partials/remote-read-replicas.adoc index eeaa6871ed..bdf9de647f 100644 --- a/modules/manage/partials/remote-read-replicas.adoc +++ b/modules/manage/partials/remote-read-replicas.adoc @@ -491,7 +491,7 @@ A topic's object store thus lags behind the local copy by the xref:reference:tun if set, by the topic's `segment.bytes` value. To reduce this lag in the data availability for the Remote Read Replica: * You can lower the value of `segment.bytes`. This lets Redpanda archive smaller log segments more frequently, at the cost of increasing I/O and file count. -* {product-name} deployments can set an idle timeout with config_ref:{config-ref},true,properties/object-storage-properties[] +* Redpanda Streaming deployments can set an idle timeout with config_ref:{config-ref},true,properties/object-storage-properties[] to force Redpanda to periodically archive the contents of open log segments to object storage. This is useful if a topic's write rate is low and log segments are kept open for long periods of time. The appropriate interval may depend on your total partition count: a system with less partitions can handle a higher number of segments per partition. diff --git a/modules/reference/pages/api-reference.adoc b/modules/reference/pages/api-reference.adoc index a06071fa51..eeacc0abf6 100644 --- a/modules/reference/pages/api-reference.adoc +++ b/modules/reference/pages/api-reference.adoc @@ -11,7 +11,7 @@ Manage schemas within a Redpanda cluster. See also: xref:manage:schema-reg/index HTTP Proxy is an HTTP server that exposes operations you can perform directly on a Redpanda cluster. Use the Redpanda HTTP Proxy API to perform a subset of actions that are also available through the Kafka API, but using simpler REST operations. See also: xref:develop:http-proxy.adoc[Use Redpanda with the HTTP Proxy API]. * Admin API Reference + -Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to {product-name} and cannot be done using the standard Kafka API. See also: xref:manage:use-admin-api.adoc[]. +Manage components of a Redpanda cluster, such as individual brokers and partition leadership. The Redpanda Admin API also allows you to perform operations that are specific to Redpanda Streaming and cannot be done using the standard Kafka API. See also: xref:manage:use-admin-api.adoc[]. + -- * link:/api/doc/admin/[Admin API (legacy)] endpoints are available on all supported versions of Redpanda. Select "v1" in the version selector to view these endpoints. diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc index 39487c8174..5dd3bb628d 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-use.adoc @@ -3,7 +3,7 @@ Select the `rpk` cloud authentication (auth) to use. -This swaps the current cloud authentication to the specified cloud authentication. If your current profile is a cloud profile, this unsets the current profile (because the authorization is now different). If your current profile is for a {product-name} cluster, the profile is kept. +This swaps the current cloud authentication to the specified cloud authentication. If your current profile is a cloud profile, this unsets the current profile (because the authorization is now different). If your current profile is for a Redpanda Streaming cluster, the profile is kept. == Usage diff --git a/modules/upgrade/partials/versioning.adoc b/modules/upgrade/partials/versioning.adoc index 97857e733e..8ebc1a4897 100644 --- a/modules/upgrade/partials/versioning.adoc +++ b/modules/upgrade/partials/versioning.adoc @@ -1 +1 @@ -{product-name} version numbers follow the convention AB.C.D, where AB is the two digit year, C is the feature release, and D is the patch release. For example, v22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. You can find a list of all releases on https://github.com/redpanda-data/redpanda/releases[GitHub^]. \ No newline at end of file +Redpanda Streaming version numbers follow the convention AB.C.D, where AB is the two digit year, C is the feature release, and D is the patch release. For example, v22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release. You can find a list of all releases on https://github.com/redpanda-data/redpanda/releases[GitHub^]. \ No newline at end of file From 464ea4bc6fba5ac2b4940eedfaf487451343f45e Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 26 May 2026 09:02:21 +0100 Subject: [PATCH 18/20] Update component color to match design system MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changed from #107569 to #4D7C0F (SMΒ·Streaming lime from color wheel). Co-Authored-By: Claude Sonnet 4.5 --- antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 956701f1f8..30a4bc4137 100644 --- a/antora.yml +++ b/antora.yml @@ -23,7 +23,7 @@ asciidoc: title: "Streaming" parent-component: "self-managed" description: "Redpanda broker and rpk CLI for self-managed deployments." - color: "#107569" + color: "#4D7C0F" order: 2 icon: "activity" # Name of the Redpanda UI used in single-sourced content with Redpanda Cloud. From 88444ad0c61cbe0ebf0bca55692660af6e4be79d Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 26 May 2026 12:14:35 +0100 Subject: [PATCH 19/20] Fix unescaped {id} attributes in schema-reg-authorization.adoc Escape curly braces in API endpoint paths to prevent AsciiDoc from interpreting them as attribute references. Co-Authored-By: Claude Opus 4.5 --- modules/manage/pages/schema-reg/schema-reg-authorization.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/manage/pages/schema-reg/schema-reg-authorization.adoc b/modules/manage/pages/schema-reg/schema-reg-authorization.adoc index bc8cbaac14..7f937534f8 100644 --- a/modules/manage/pages/schema-reg/schema-reg-authorization.adoc +++ b/modules/manage/pages/schema-reg/schema-reg-authorization.adoc @@ -122,12 +122,12 @@ Not all Kafka operations are supported when using Redpanda Schema Registry ACLs. | `read` | `subject` -| `/schemas/ids/{id}/versions` +| `/schemas/ids/\{id\}/versions` | `GET` | `describe` | `registry` -| `/schemas/ids/{id}/subjects` +| `/schemas/ids/\{id\}/subjects` | `GET` | `describe` | `registry` From 30fabc16acb9a0fadc22a84da542896f14a1a05b Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 26 May 2026 12:24:00 +0100 Subject: [PATCH 20/20] Fix remaining unescaped attributes in schema-reg and release notes Escape curly braces in API endpoint paths to prevent AsciiDoc from interpreting them as attribute references: - schema-reg-api.adoc: {name}, {subject} - schema-reg-overview.adoc: {subject}, {version}, {id} - schema-reg-contexts.adoc: {subject}, {version}, {id}, {context} (many) - release-notes/redpanda.adoc: {subject}, {version}, {id} Co-Authored-By: Claude Opus 4.5 --- .../pages/release-notes/redpanda.adoc | 2 +- .../pages/schema-reg/schema-reg-api.adoc | 4 ++-- .../pages/schema-reg/schema-reg-contexts.adoc | 24 +++++++++---------- .../pages/schema-reg/schema-reg-overview.adoc | 4 ++-- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/modules/get-started/pages/release-notes/redpanda.adoc b/modules/get-started/pages/release-notes/redpanda.adoc index de4f53040d..6ed7f8e4ba 100644 --- a/modules/get-started/pages/release-notes/redpanda.adoc +++ b/modules/get-started/pages/release-notes/redpanda.adoc @@ -87,7 +87,7 @@ To enable contexts, set xref:reference:properties/cluster-properties.adoc#schema xref:manage:schema-reg/schema-reg-overview.adoc#metadata-properties[Schema Registry metadata properties] let you store and retrieve arbitrary key-value pairs alongside schemas. Properties such as `owner`, `team`, or `application.version` travel with the schema through its lifecycle, making it easier to track ownership and lineage without modifying the schema itself. -You can set metadata when registering a schema using the `POST /subjects/{subject}/versions` endpoint or with the xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[`--metadata-properties`] flag in `rpk registry schema create`. Metadata is returned in `GET /subjects/{subject}/versions/{version}` and `GET /schemas/ids/{id}` responses, and viewable with `rpk registry schema get --print-metadata`. New schema versions automatically inherit metadata from the most recent version of the subject unless you register with an explicit empty `metadata` object. +You can set metadata when registering a schema using the `POST /subjects/\{subject\}/versions` endpoint or with the xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[`--metadata-properties`] flag in `rpk registry schema create`. Metadata is returned in `GET /subjects/\{subject\}/versions/\{version\}` and `GET /schemas/ids/\{id\}` responses, and viewable with `rpk registry schema get --print-metadata`. New schema versions automatically inherit metadata from the most recent version of the subject unless you register with an explicit empty `metadata` object. == OIDC authentication with rpk diff --git a/modules/manage/pages/schema-reg/schema-reg-api.adoc b/modules/manage/pages/schema-reg/schema-reg-api.adoc index 8890155f5f..6853405760 100644 --- a/modules/manage/pages/schema-reg/schema-reg-api.adoc +++ b/modules/manage/pages/schema-reg/schema-reg-api.adoc @@ -704,7 +704,7 @@ rpk:: + -- ```bash -# --references flag takes the format {name}:{subject}:{schema version} +# --references flag takes the format \{name\}:\{subject\}:\{schema version\} rpk registry schema create import --schema import_schema.proto --references simple:test-simple:2 ``` ``` @@ -1135,7 +1135,7 @@ While a Schema Registry or subject is in import mode: [NOTE] ==== -Import mode supports continuous migration: producers and consumers can keep operating against the target registry while it is in import mode, as long as they do not attempt to register new schemas. Lookups of already-registered schemas continue to succeed, while auto-registration calls (for example, `POST /subjects/{subject}/versions` without an explicit ID) are rejected. +Import mode supports continuous migration: producers and consumers can keep operating against the target registry while it is in import mode, as long as they do not attempt to register new schemas. Lookups of already-registered schemas continue to succeed, while auto-registration calls (for example, `POST /subjects/\{subject\}/versions` without an explicit ID) are rejected. To avoid auto-registration errors on the client side, configure your clients to look up schemas instead of registering them. For Confluent serializers, set `auto.register.schemas=false` (and optionally `use.latest.version=true`). ==== diff --git a/modules/manage/pages/schema-reg/schema-reg-contexts.adoc b/modules/manage/pages/schema-reg/schema-reg-contexts.adoc index a68eba20b2..85ebdfa7e8 100644 --- a/modules/manage/pages/schema-reg/schema-reg-contexts.adoc +++ b/modules/manage/pages/schema-reg/schema-reg-contexts.adoc @@ -80,7 +80,7 @@ The `schema_registry_enable_qualified_subjects` property defaults to `false`, so * *Non-Java SerDe clients*: Not supported in Schema Registry contexts. * *Server-side schema ID validation*: Schema ID validation using Kafka record headers does not support contexts. However, schema ID validation using magic byte and prefix are supported. * *Iceberg topics*: You cannot use schemas within a context for Iceberg Topics. -* *`referencedby` endpoint*: `GET /subjects/{subject}/versions/{version}/referencedby` returns a list of bare schema IDs with no context information. When references span contexts, it is not possible to determine which context each returned ID belongs to. +* *`referencedby` endpoint*: `GET /subjects/\{subject\}/versions/\{version\}/referencedby` returns a list of bare schema IDs with no context information. When references span contexts, it is not possible to determine which context each returned ID belongs to. * *Cross-context isolation*: Contexts provide organizational and ID-space isolation, but do not prevent cross-context schema references. There is no mechanism to block schemas in one context from referencing schemas in another context. * *Default context cannot be deleted*: You cannot delete the default context (`.`). * *Breaking change on upgrade*: After enabling `schema_registry_enable_qualified_subjects`, any existing subject whose name matches the qualified subject pattern (for example, `:.staging:user-value`) is reinterpreted as subject `user-value` in context `.staging` rather than as a literal subject name in the default context. See <>. @@ -93,7 +93,7 @@ When you enable contexts, Schema Registry changes how it assigns schema IDs, res Prior to v26.1, the Schema Registry maintained a single global ID counter. All schemas shared one ID space, and a given schema ID pointed to exactly one schema across the entire registry. -With Schema Registry contexts, each context has its own independent ID counter. This means schema ID `1` in `.staging` and schema ID `1` in `.production` are different schemas. As a result (and by default), `GET /schemas/ids/{id}` searches the _default context only_. To retrieve a schema by ID from a non-default context, you must pass the `subject` query parameter to scope the lookup: +With Schema Registry contexts, each context has its own independent ID counter. This means schema ID `1` in `.staging` and schema ID `1` in `.production` are different schemas. As a result (and by default), `GET /schemas/ids/\{id\}` searches the _default context only_. To retrieve a schema by ID from a non-default context, you must pass the `subject` query parameter to scope the lookup: [source,bash] ---- @@ -222,7 +222,7 @@ The following configuration examples show how to perform common context operatio === Register a schema in a context -To register a schema in a named context, use the qualified subject form in the `POST /subjects/{subject}/versions` request: +To register a schema in a named context, use the qualified subject form in the `POST /subjects/\{subject\}/versions` request: [source,bash] ---- @@ -338,7 +338,7 @@ NOTE: `.__GLOBAL` is a reserved context name and cannot be used as a regular con === Retrieve schema references with qualified names -Use `referenceFormat=qualified` on `GET /subjects/{subject}/versions/{version}` to return references with context-qualified subject names instead of bare names: +Use `referenceFormat=qualified` on `GET /subjects/\{subject\}/versions/\{version\}` to return references with context-qualified subject names instead of bare names: [source,bash] ---- @@ -517,7 +517,7 @@ The following table identifies the status of Schema Registry context client inte | Non-Java SerDe | Not supported -| Workaround: set the client's Schema Registry base URL to `\http://:8081/contexts/{context}`. +| Workaround: set the client's Schema Registry base URL to `\http://:8081/contexts/\{context\}`. | rpk | Supported @@ -554,7 +554,7 @@ Contexts use the existing `sr_subject` and `sr_registry` ACL resource types. | `sr_subject` (results filtered to accessible subjects) | `describe` -| Delete a context (`DELETE /contexts/{context}`) +| Delete a context (`DELETE /contexts/\{context\}`) | `sr_registry` | `delete` @@ -661,9 +661,9 @@ Following is troubleshooting guidance for Schema Registry contexts. [#schema-id-lookup-fails] === Schema ID lookup returns 404 or wrong schema -*Symptom*: `GET /schemas/ids/{id}` returns a 404 or returns the wrong schema after registering a schema in a non-default context. +*Symptom*: `GET /schemas/ids/\{id\}` returns a 404 or returns the wrong schema after registering a schema in a non-default context. -*Cause*: `GET /schemas/ids/{id}` searches the *default context only*. A schema registered in `:.staging:my-topic` (returning ID `1`) is not found by `GET /schemas/ids/1` without a context hint. +*Cause*: `GET /schemas/ids/\{id\}` searches the *default context only*. A schema registered in `:.staging:my-topic` (returning ID `1`) is not found by `GET /schemas/ids/1` without a context hint. *Resolution*: Pass the `subject` query parameter to scope the lookup to the correct context: @@ -692,7 +692,7 @@ endif::env-cloud[] === Schema registration fails after upgrading to v26.1 -*Symptom*: A `POST /subjects/{subject}/versions` request returns an unexpected error after upgrading and enabling the flag. +*Symptom*: A `POST /subjects/\{subject\}/versions` request returns an unexpected error after upgrading and enabling the flag. *Cause*: An existing subject whose name begins with `:.` has been reinterpreted as a context-qualified subject. If the inferred context was pre-configured in `READONLY` mode, new registrations are rejected. @@ -716,7 +716,7 @@ curl -s -X PUT http://localhost:8081/mode/:.affected-context: \ === Context cannot be deleted -*Symptom*: `DELETE /contexts/{context}` returns a `context_not_empty` error even though all subjects appear to have been deleted. +*Symptom*: `DELETE /contexts/\{context\}` returns a `context_not_empty` error even though all subjects appear to have been deleted. *Cause*: Soft-deleted subjects still count toward the non-empty check. Subjects must be hard-deleted (permanently deleted) before the context can be removed. Also note that the default context (`.`) cannot be deleted under any circumstances. @@ -765,11 +765,11 @@ curl -s -X DELETE http://localhost:8081/contexts/.staging === `referencedby` returns IDs with no context information -*Symptom*: `GET /subjects/{subject}/versions/{version}/referencedby` returns schema IDs, but you cannot determine which context each ID belongs to. +*Symptom*: `GET /subjects/\{subject\}/versions/\{version\}/referencedby` returns schema IDs, but you cannot determine which context each ID belongs to. *Cause*: This is a known limitation of the `referencedby` endpoint. It returns bare schema IDs with no context metadata. When references span contexts, the returned IDs are ambiguous. -*Resolution*: There is no workaround. To identify which schema an ID belongs to, try resolving the ID against each relevant context using `GET /schemas/ids/{id}?subject=::`. +*Resolution*: There is no workaround. To identify which schema an ID belongs to, try resolving the ID against each relevant context using `GET /schemas/ids/\{id\}?subject=:\{context\}:\{subject\}`. == Suggested reading diff --git a/modules/manage/pages/schema-reg/schema-reg-overview.adoc b/modules/manage/pages/schema-reg/schema-reg-overview.adoc index 18526e3384..87cda7452c 100644 --- a/modules/manage/pages/schema-reg/schema-reg-overview.adoc +++ b/modules/manage/pages/schema-reg/schema-reg-overview.adoc @@ -162,7 +162,7 @@ endif::[] [#metadata-properties] == Metadata properties -Schema Registry lets you store and retrieve arbitrary key-value metadata properties alongside schemas. Properties such as `owner`, `team`, or `application.version` travel with the schema through its lifecycle. You can register a new schema with associated metadata properties by sending a `POST` request to `/subjects/{subject}/versions` with a `metadata.properties` object in the request body: +Schema Registry lets you store and retrieve arbitrary key-value metadata properties alongside schemas. Properties such as `owner`, `team`, or `application.version` travel with the schema through its lifecycle. You can register a new schema with associated metadata properties by sending a `POST` request to `/subjects/\{subject\}/versions` with a `metadata.properties` object in the request body: [,json] ---- @@ -191,7 +191,7 @@ rpk registry schema create my-subject --schema schema.avsc \ --metadata-properties '{"owner":"platform-team","application.version":"2.1.0"}' ---- -Metadata properties are returned on `GET /subjects/{subject}/versions/{version}` and `GET /schemas/ids/{id}` responses. To view metadata on an existing schema, add `--print-metadata` to `rpk registry schema get`. You can also view metadata properties in {ui}. +Metadata properties are returned on `GET /subjects/\{subject\}/versions/\{version\}` and `GET /schemas/ids/\{id\}` responses. To view metadata on an existing schema, add `--print-metadata` to `rpk registry schema get`. You can also view metadata properties in {ui}. When you register a new schema version without a `metadata` field, the new version automatically inherits properties from the most recent version of that subject. To avoid inheriting the previous version's metadata, you can send `"metadata": {}` to register a schema with explicitly no metadata. Registering the same schema definition with different metadata properties creates a new schema version.