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 6b801988a3..eb4c9a8346 100644 --- a/antora.yml +++ b/antora.yml @@ -1,17 +1,23 @@ -name: ROOT -title: Self-Managed +name: streaming +title: Streaming version: 24.2 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-07-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 content that is single-sourced with Redpanda Cloud. ui: Redpanda Console@ # Fallback versions @@ -74,7 +80,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 @@ -106,16 +112,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/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/quickstart.adoc b/modules/console/pages/quickstart.adoc index 7230491e1a..ce7babb25f 100644 --- a/modules/console/pages/quickstart.adoc +++ b/modules/console/pages/quickstart.adoc @@ -32,7 +32,7 @@ You should see the version of Docker Compose that's installed on your local mach . xref:console:attachment$docker-compose.yml[Download] the following Docker Compose file on your local file system. + -This Docker Compose file deploys a Redpanda Self-Managed cluster, Redpanda Console, and Redpanda Connect. Redpanda Connect is used to generate demo data and produce it to a topic on the Redpanda cluster. +This Docker Compose file deploys a {product-name} cluster, Redpanda Console, and Redpanda Connect. Redpanda Connect is used to generate demo data and produce it to a topic on the Redpanda cluster. + .Reveal the YAML content [%collapsible] @@ -273,7 +273,7 @@ In the *Connectors* menu, you can manage your Kafka Connect clusters or view ins See also: - xref:console:config/kafka-connect.adoc[Manage Kafka Connect in Redpanda Console] -- xref:redpanda-connect:ROOT:about.adoc[About Redpanda Connect] +- xref:connect:streaming:about.adoc[About Redpanda Connect] == Data transforms @@ -291,10 +291,10 @@ See also: == Suggested reading -- xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect] -** xref:redpanda-connect:components:outputs/kafka_franz.adoc[`kafka_franz`] output connector -** xref:redpanda-connect:components:inputs/generate.adoc[`generate`] input connector -** xref:redpanda-connect:configuration:processing_pipelines.adoc[processing pipelines] +- xref:connect:streaming:about.adoc[Redpanda Connect] +** xref:connect:components:outputs/kafka_franz.adoc[`kafka_franz`] output connector +** xref:connect:components:inputs/generate.adoc[`generate`] input connector +** xref:connect:configuration:processing_pipelines.adoc[processing pipelines] - xref:reference:rpk/index.adoc[`rpk`] ** xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] 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 e93976096c..35a460587c 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/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/licenses.adoc b/modules/get-started/pages/licenses.adoc index aee2e4aeb7..14e8807ee9 100644 --- a/modules/get-started/pages/licenses.adoc +++ b/modules/get-started/pages/licenses.adoc @@ -1,15 +1,15 @@ = Redpanda Licensing -:description: Redpanda Self-Managed is free and source-available at the Redpanda GitHub repo. Additional features are included with an Enterprise license. +:description: {product-name} is free and source-available at the Redpanda GitHub repo. Additional features are included with an Enterprise license. :page-aliases: introduction:licenses.adoc -You can deploy Redpanda in a self-hosted environment (Redpanda Self-Managed) or as a fully-managed cloud service (Redpanda Cloud). For Redpanda Self-Managed, select either the Community Edition or the Enterprise Edition: +You can deploy Redpanda in a self-hosted environment ({product-name}) or as a fully-managed cloud service (Redpanda Cloud). For {product-name}, select either the Community Edition or the Enterprise Edition: * Redpanda Community Edition is free and source-available at the https://github.com/redpanda-data/redpanda[Redpanda GitHub repository^]. * Redpanda Enterprise Edition requires a license key and includes additional features. [NOTE] ==== -To learn about Redpanda Cloud deployments, see the xref:redpanda-cloud:get-started:cloud-overview.adoc[]. +To learn about Redpanda Cloud deployments, see the xref:cloud-data-platform:get-started:cloud-overview.adoc[]. ==== == Redpanda Community Edition @@ -37,8 +37,8 @@ Redpanda Enterprise Edition is licensed with the https://github.com/redpanda-dat * xref:manage:security/authorization/rbac.adoc[Redpanda Role-Based Access Control (RBAC)] * xref:manage:security/console/authorization.adoc[Redpanda Console Authorization (RBAC)] * xref:manage:security/console/authentication.adoc[Redpanda Console Authentication] -* xref:redpanda-connect:components:outputs/snowflake_put.adoc[Snowflake connector for Redpanda Connect] -* xref:redpanda-connect:components:outputs/splunk_hec.adoc[Splunk connector for Redpanda Connect] +* xref:connect:components:outputs/snowflake_put.adoc[Snowflake connector for Redpanda Connect] +* xref:connect:components:outputs/splunk_hec.adoc[Splunk connector for Redpanda Connect] Enterprise features require a license key. You can evaluate enterprise features with a free 30-day trial. Contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda Sales^] to request a trial license, to extend your trial period, or to purchase an Enterprise Edition license. diff --git a/modules/get-started/pages/quick-start.adoc b/modules/get-started/pages/quick-start.adoc index 0317142a73..081cd23f24 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. :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, get-started:quickstarts/index.adoc :page-categories: Deployment, Development, rpk @@ -6,12 +6,12 @@ {description} -This quickstart introduces you to Redpanda Self-Managed in a self-hosted environment with a minimal setup. Docker Compose provides a straightforward and reproducible setup process, whether you're exploring Redpanda for the first time or testing new configurations. The option between a single broker and a three-broker setup helps you test Redpanda for simplicity and resilience. +This quickstart introduces you to {product-name} in a self-hosted environment with a minimal setup. Docker Compose provides a straightforward and reproducible setup process, whether you're exploring Redpanda for the first time or testing new configurations. The option between a single broker and a three-broker setup helps you test Redpanda for simplicity and resilience. [NOTE] ==== Redpanda in Docker is supported only for development and testing. -To deploy Redpanda Self-Managed in production, use one of the following environments: +To deploy {product-name} in production, use one of the following environments: - xref:deploy:deployment-option/self-hosted/manual/index.adoc[Linux] - xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[Kubernetes] @@ -46,7 +46,7 @@ For production environments where you need more resilience, a three-broker setup Single Broker:: + -- -. xref:redpanda-labs:docker-compose:attachment$single-broker/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system. +. xref:labs:docker-compose:attachment$single-broker/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system. + .Reveal the YAML content [%collapsible] @@ -54,7 +54,7 @@ Single Broker:: .`docker-compose.yml` [,yaml,subs="attributes+"] ---- -include::redpanda-labs:docker-compose:attachment$single-broker/docker-compose.yml[] +include::labs:docker-compose:attachment$single-broker/docker-compose.yml[] ---- ==== @@ -77,7 +77,7 @@ Three Brokers:: + -- -. xref:redpanda-labs:docker-compose:attachment$three-brokers/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system. +. xref:labs:docker-compose:attachment$three-brokers/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system. + .Reveal the YAML content [%collapsible] @@ -85,7 +85,7 @@ Three Brokers:: .`docker-compose.yml` [,yaml,subs="attributes+"] ---- -include::redpanda-labs:docker-compose:attachment$three-brokers/docker-compose.yml[] +include::labs:docker-compose:attachment$three-brokers/docker-compose.yml[] ---- ==== @@ -297,7 +297,7 @@ docker compose down -v == Next steps -- xref:redpanda-labs:ROOT:index.adoc[Try more examples in Redpanda Labs] +- xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs] - xref:manage:console/index.adoc[Learn more about Redpanda Console] - xref:rpk-install.adoc[Learn more about rpk] - xref:deploy:deployment-option/self-hosted/manual/production/index.adoc[Deploy for development or production] diff --git a/modules/get-started/pages/rpk-install.adoc b/modules/get-started/pages/rpk-install.adoc index e782184180..987ae178d5 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 7c538c77b6..4c7dda0a41 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] == Declarative user and ACL management in Kubernetes @@ -90,4 +90,4 @@ The following `rpk` commands are new in this version: == Doc enhancements -The https://docs.redpanda.com/home/[Redpanda Docs home page] has been redesigned, so you can stay within the context of Redpanda Self-Managed, Redpanda Cloud, or Redpanda Connect docs. We hope that our docs help and inspire our users. Please share your feedback with the links at the bottom of any doc page. +The https://docs.redpanda.com/home/[Redpanda Docs home page] has been redesigned, so you can stay within the context of {product-name}, Redpanda Cloud, or Redpanda Connect docs. We hope that our docs help and inspire our users. Please share your feedback with the links at the bottom of any doc page. 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/cluster-balancing.adoc b/modules/manage/pages/cluster-maintenance/cluster-balancing.adoc index 1fdc4aad46..95ea98794a 100644 --- a/modules/manage/pages/cluster-maintenance/cluster-balancing.adoc +++ b/modules/manage/pages/cluster-maintenance/cluster-balancing.adoc @@ -126,7 +126,7 @@ This is a beta feature for v24.2 and is not recommended for use for production c curl -X PUT -d '{"state": "active"}' http://127.0.0.1:9644/v1/features/node_local_core_assignment ``` -xref:24.3@ROOT:upgrade:index.adoc[Upgrade to 24.3 or later] to use this feature for production clusters. +xref:24.3@streaming:upgrade:index.adoc[Upgrade to 24.3 or later] to use this feature for production clusters. ==== In Redpanda, every partition replica is assigned to a CPU core on a broker. While Redpanda's default <> monitors cluster-level events, such as the addition of new brokers or broker failure to balance partition assignments, it does not account for the distribution of partitions _within_ an individual broker. diff --git a/modules/manage/pages/cluster-maintenance/disk-utilization.adoc b/modules/manage/pages/cluster-maintenance/disk-utilization.adoc index 48abcbcbb0..040f9978f2 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/kubernetes/k-manage-resources.adoc b/modules/manage/pages/kubernetes/k-manage-resources.adoc index c1531cf74c..e8a093c15f 100644 --- a/modules/manage/pages/kubernetes/k-manage-resources.adoc +++ b/modules/manage/pages/kubernetes/k-manage-resources.adoc @@ -28,7 +28,7 @@ kubectl describe nodes Decreasing the number of CPU cores in a production cluster is not supported in this version of Redpanda. However, you can enable xref:manage:cluster-maintenance/cluster-balancing.adoc#intra-broker-partition-balancing[intra-broker partition balancing] to reduce CPU cores in a development cluster. -Starting from version 24.3, decreasing the number of CPU cores in a production cluster is supported. xref:24.3@ROOT:upgrade:index.adoc[Upgrade to version 24.3] or later to access this feature. +Starting from version 24.3, decreasing the number of CPU cores in a production cluster is supported. xref:24.3@streaming:upgrade:index.adoc[Upgrade to version 24.3] or later to access this feature. [[memory]] == Configure memory resources 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 b99c95c15d..b1a352ed53 100644 --- a/modules/manage/partials/remote-read-replicas.adoc +++ b/modules/manage/partials/remote-read-replicas.adoc @@ -440,7 +440,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/shared/partials/community-supported-connectors.adoc b/modules/shared/partials/community-supported-connectors.adoc index a979bcc713..decc996083 100644 --- a/modules/shared/partials/community-supported-connectors.adoc +++ b/modules/shared/partials/community-supported-connectors.adoc @@ -1,5 +1,5 @@ IMPORTANT: *The Redpanda Connectors Docker image is a community-supported artifact*. For support, reach out to the Redpanda team in https://redpanda.com/slack[Redpanda Community Slack^]. + -Are you looking for xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect documentation]? +Are you looking for xref:connect:streaming:about.adoc[Redpanda Connect documentation]? This topic describes how to use the https://hub.docker.com/r/redpandadata/connectors/tags[Redpanda Connectors Docker image^], which includes a pre-configured instance of https://redpanda.com/guides/kafka-tutorial/what-is-kafka-connect[Kafka Connect] that works 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