Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,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:
Expand Down
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image:https://img.shields.io/coderabbit/prs/github/redpanda-data/docs?utm_source
</p></a>
++++

This repository hosts the documentation content for Redpanda Self-Managed.
This repository hosts the documentation content for Redpanda Streaming.

== Contribute

Expand Down Expand Up @@ -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:

Expand Down
22 changes: 14 additions & 8 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
name: ROOT
name: streaming
title: Self-Managed
version: 25.1
start_page: home:index.adoc
nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
# Product name used throughout the documentation
# Date of release in the format YYYY-MM-DD
page-release-date: 2025-04-07
# 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
Expand Down Expand Up @@ -82,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: panda.png # images must be in modules/ROOT/images
page-home-intro-learn-more: get-started:intro-to-events.adoc
page-home-primary-row-title: Deploy
Expand Down Expand Up @@ -114,16 +120,16 @@ 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'
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: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'
4 changes: 2 additions & 2 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -257,7 +257,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]
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/ui/add-license.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,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[].

Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/ui/programmable-push-filters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include::shared:partial$community-supported-connectors.adoc[]
The Redpanda Connectors Helm chart includes a pre-configured instance of https://redpanda.com/guides/kafka-tutorial/what-is-kafka-connect[Kafka Connect] that works
with Redpanda. The underlying Docker image contains _only_ the MirrorMaker2 connector but you can build a custom image to install additional connectors.

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.

[cols="1a,2a"]
|===
Expand Down
2 changes: 1 addition & 1 deletion modules/deploy/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Next steps

* xref:redpanda-labs:ROOT: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]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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::shared:partial$suggested-video.adoc[]

* https://www.youtube.com/watch?v=wV6gH5_yVaw&ab_channel=RedpandaData[YouTube - Redpanda Office Hour: Follower Fetching (52 mins)^]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion modules/develop/partials/http-proxy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Curl is likely already installed on your system. If not, see https://curl.se/dow
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:

Expand Down
2 changes: 1 addition & 1 deletion modules/get-started/pages/docker-compose-labs.adoc
Original file line number Diff line number Diff line change
@@ -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}

Expand Down
12 changes: 6 additions & 6 deletions modules/get-started/pages/intro-to-events.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,21 +59,21 @@ 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 Redpanda Cloud deployment, see xref:redpanda-cloud:get-started:cloud-overview.adoc[].
* 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[]

Expand Down
Original file line number Diff line number Diff line change
@@ -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}.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -182,7 +182,7 @@ The process for updating a license depends on how it was originally applied:
- <<inline-update, Update the license string inline in your Helm values or manifest file>>.
- 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
Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading
Loading