diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml index 24f92ce2c0..79508948ea 100644 --- a/.github/workflows/test-docs.yml +++ b/.github/workflows/test-docs.yml @@ -66,7 +66,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 c7bb4006cf..9df949dc39 100644 --- a/README.adoc +++ b/README.adoc @@ -14,7 +14,7 @@ image:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f

++++ -This repository hosts the documentation content for Redpanda Self-Managed. +This repository hosts the documentation content for Redpanda Streaming. == Contribute @@ -92,7 +92,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 944dfbc834..4999db9c75 100644 --- a/antora.yml +++ b/antora.yml @@ -1,17 +1,23 @@ -name: ROOT -title: Self-Managed +name: streaming +title: Streaming version: 24.3 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: 2024-12-03 # 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 content that is single-sourced with Redpanda Cloud. ui: Redpanda Console@ # Fallback versions @@ -79,7 +85,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 @@ -111,16 +117,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' diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 1fab9f0e8c..9f14e083c8 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -6,7 +6,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] @@ -259,7 +259,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/deserialization.adoc b/modules/console/pages/config/deserialization.adoc index 1a25978d38..da116278d7 100644 --- a/modules/console/pages/config/deserialization.adoc +++ b/modules/console/pages/config/deserialization.adoc @@ -33,7 +33,7 @@ kafka: ---- - `enabled`: Set to `true` to enable the use of a Schema Registry. -- `urls`: Provide the URLs to your Schema Registry endpoints. Multiple URLs can be specified for redundancy. To set up the Schema Registry in {ui} with Redpanda Self-Managed, see xref:console:ui/schema-reg.adoc[]. +- `urls`: Provide the URLs to your Schema Registry endpoints. Multiple URLs can be specified for redundancy. To set up the Schema Registry in {ui} with {product-name}, see xref:console:ui/schema-reg.adoc[]. - `username/password`: Use these fields for basic authentication. For security, it's recommended to use xref:console:config/configure-console.adoc#environment-variables[environment variables] or command-line flags for sensitive information. - `bearerToken`: Optionally, use bearer token authentication instead of basic auth. - `tls`: If your Schema Registry is secured with TLS, configure the necessary certificates and options. diff --git a/modules/console/pages/ui/add-license.adoc b/modules/console/pages/ui/add-license.adoc index 33b46cbe91..a737e8f512 100644 --- a/modules/console/pages/ui/add-license.adoc +++ b/modules/console/pages/ui/add-license.adoc @@ -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[]. diff --git a/modules/console/pages/ui/programmable-push-filters.adoc b/modules/console/pages/ui/programmable-push-filters.adoc index 7f366dffc6..0ae2e1883e 100644 --- a/modules/console/pages/ui/programmable-push-filters.adoc +++ b/modules/console/pages/ui/programmable-push-filters.adoc @@ -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 diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc index 09f1158314..1a0d3e00a2 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc @@ -13,7 +13,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"] |=== 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/deploy/partials/kubernetes/guides/next-steps.adoc b/modules/deploy/partials/kubernetes/guides/next-steps.adoc index d50c42fae5..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: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] diff --git a/modules/develop/pages/consume-data/follower-fetching.adoc b/modules/develop/pages/consume-data/follower-fetching.adoc index 0b6333e8c0..5dc0cd8a56 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::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 7f35a46096..46811813bb 100644 --- a/modules/develop/pages/data-transforms/how-transforms-work.adoc +++ b/modules/develop/pages/data-transforms/how-transforms-work.adoc @@ -52,7 +52,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 record 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 xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect] or https://flink.apache.org/[Apache Flink^]. +- *Single record 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 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/partials/http-proxy.adoc b/modules/develop/partials/http-proxy.adoc index 366bcd72cb..e194b08e62 100644 --- a/modules/develop/partials/http-proxy.adoc +++ b/modules/develop/partials/http-proxy.adoc @@ -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: 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 518c652e89..f502efdba1 100644 --- a/modules/get-started/pages/intro-to-events.adoc +++ b/modules/get-started/pages/intro-to-events.adoc @@ -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[] 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 61332dc70c..11e05bfa72 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 9809d99001..82521bcb11 100644 --- a/modules/get-started/pages/licensing/overview.adoc +++ b/modules/get-started/pages/licensing/overview.adoc @@ -14,14 +14,14 @@ 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 [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 @@ -49,7 +49,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 @@ -161,7 +161,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. @@ -169,11 +169,11 @@ 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: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. @@ -195,7 +195,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 6e5c862a20..25e01592c0 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 :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 {"id": "quickstart", "description": "Redpanda Self-Managed quickstart"}) +// (test start {"id": "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: @@ -68,9 +68,9 @@ If you're on Windows, use a compatible terminal that supports Unix-like commands :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+"] ---- @@ -785,13 +785,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:get-started:licensing/overview.adoc[Learn more about enterprise features for Redpanda Self-Managed] +- 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:deploy:deployment-option/self-hosted/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/rpk-install.adoc b/modules/get-started/pages/rpk-install.adoc index 8276f672c3..e03da10954 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/get-started/pages/whats-new.adoc b/modules/get-started/pages/whats-new.adoc index 6c703e732f..0fdbdd4064 100644 --- a/modules/get-started/pages/whats-new.adoc +++ b/modules/get-started/pages/whats-new.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] == Leader pinning 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/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 5c7eeef698..8f276290ea 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/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/partials/remote-read-replicas.adoc b/modules/manage/partials/remote-read-replicas.adoc index ab0ee72961..ddd77fe1a3 100644 --- a/modules/manage/partials/remote-read-replicas.adoc +++ b/modules/manage/partials/remote-read-replicas.adoc @@ -447,7 +447,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 40a5357406..b57f53edbb 100644 --- a/modules/reference/pages/api-reference.adoc +++ b/modules/reference/pages/api-reference.adoc @@ -11,4 +11,4 @@ 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]. * link:/api/doc/admin/[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. +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. 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/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 f7039a0fd2..3400ce8412 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, 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. 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, 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. 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.