-
Notifications
You must be signed in to change notification settings - Fork 48
Doc 1602: Cloud Topics GA #1469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Feediver1
wants to merge
74
commits into
v-WIP/26.1
Choose a base branch
from
DOC-1602
base: v-WIP/26.1
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
74 commits
Select commit
Hold shift + click to select a range
928c900
DOC-1602: Cloud Topics
Feediver1 2259e38
DOC-1602
Feediver1 08f5094
DOC-1602: Cloud Topics
Feediver1 d1e0dd1
DOC-1602: Cloud Topics
Feediver1 89bae92
DOC-1602: Cloud Topics
Feediver1 5a71ac2
DOC-1602
Feediver1 d561243
DOC-1602
Feediver1 79fcaf4
DOC-1602
Feediver1 471306a
DOC-1602
Feediver1 2e552ee
DOC-1602
Feediver1 47f06ec
DOC-1602
Feediver1 2bd2b38
DOC-1602
Feediver1 c1c78fb
DOC-1602
Feediver1 2811fe0
DOC-1602
Feediver1 db75f1f
DOC-1602
Feediver1 bf1a074
DOC-1602
Feediver1 6b23790
DOC-1602
Feediver1 d34750b
DOC-1602
Feediver1 fcd88cc
DOC-1602
Feediver1 b9b2ae4
WIP
Feediver1 82b4be2
WIP
Feediver1 d6e4097
WIP
Feediver1 d214319
wip
Feediver1 cb2c6a9
fix change in config topics
Feediver1 53a6f53
WIP
Feediver1 842e4b1
wip
Feediver1 3ebce8d
Update modules/develop/pages/manage-topics/cloud-topics.adoc
Feediver1 5132772
Add cloud_topics configs
JakeSCahill affffe0
Add overrides
JakeSCahill c27c1ae
implemented review feedback
Feediver1 28d23fb
removed redundant info
Feediver1 fe7d1c7
Apply suggestions from code review
Feediver1 b0d9b97
Update modules/reference/attachments/redpanda-properties-v25.3.1.json
Feediver1 673649a
Update modules/reference/partials/properties/cluster-properties.adoc
Feediver1 47528e9
Apply suggestions from code review
Feediver1 4498099
fixed links
Feediver1 68ecd1c
fix link
Feediver1 e05a2ef
fixed llinks
Feediver1 2f9ade6
fixed links
Feediver1 bdbf49e
fix broken link
Feediver1 0507080
removed link
Feediver1 9222987
review feedback from Matt
Feediver1 d3d0562
copyedit
Feediver1 6ce9690
Removed per Matt Shumpert
Feediver1 7d2fe18
Fix broken xref in tristate-behavior-change partial
Feediver1 f8f8751
Add explicit anchor to Configure write caching section
Feediver1 29c381b
Apply suggestion from @Feediver1
Feediver1 63b6084
Fix flaky Doc Detective test for Topics nav link
Feediver1 2a4f1ab
fix(tests): reset to overview before Topics nav click in audit logs s…
Feediver1 1b98b6f
fix(tests): use nav-link-icon-* selectors instead of nav-link-* for s…
Feediver1 e91bd0c
Apply suggestion from @Feediver1
Feediver1 cd4782e
updates for 26.1
Feediver1 98cc852
docs: add learning objectives to cloud-topics.adoc
Feediver1 6be2d03
fix: remove conflicting page alias from manage-topics/config-topics.adoc
Feediver1 d128071
chore: retrigger build
Feediver1 97dc05a
Apply suggestion from Noah
Feediver1 1a57c47
Apply suggestion from Noah
Feediver1 d1a52f8
Apply suggestion from Noah
Feediver1 ca17951
Apply suggestion from Noah
Feediver1 b5b5043
Apply suggestion from Noah
Feediver1 cb4fd24
Apply suggestion from Noah
Feediver1 1329b5c
Apply suggestion from @Feediver1
Feediver1 7d5e38e
Apply suggestion from @Feediver1
Feediver1 db005d0
Apply suggestion from @Feediver1
Feediver1 37b58cc
Apply suggestion from @Feediver1
Feediver1 4b3727b
Apply suggestion from Willem
Feediver1 4c454e0
fix(doc-detective): replace data-testid nav selectors with href-based…
Feediver1 168f3a9
Apply suggestion from @Feediver1
Feediver1 5361a21
chore: retrigger build
Feediver1 672cab8
Apply suggestion from @Feediver1
Feediver1 744c7b7
Apply suggestion from @Feediver1
Feediver1 cb94db6
auto-docs: regenerate topic-properties.adoc for v26.1.1-rc2
Feediver1 cb02672
docs: add description for redpanda.storage.mode topic property
Feediver1 dec01e5
revert: remove redpanda.cloud_topic.enabled update from PR
Feediver1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| = Manage Cloud Topics | ||
| :description: Cloud Topics are Redpanda topics that enable users to trade off latency for lower costs. | ||
| :learning-objective-1: Describe the latency and cost trade-offs of Cloud Topics compared to standard Redpanda topics | ||
| :learning-objective-2: Create a Cloud Topic using rpk after enabling Cloud Topics on your cluster | ||
| :learning-objective-3: Identify Cloud Topics limitations and configurations that reduce cross-AZ networking costs | ||
| // tag::single-source[] | ||
|
|
||
| ifndef::env-cloud[] | ||
| [NOTE] | ||
| ==== | ||
| include::shared:partial$enterprise-license.adoc[] | ||
| ==== | ||
| endif::[] | ||
|
|
||
| Starting in v26.1, Redpanda provides Cloud Topics to support multi-modal streaming workloads in the most cost-effective way possible: as a configurable option on a single cluster. While standard Redpanda xref:config-topics.adoc[topics] that use local storage or Tiered Storage are ideal for latency-tolerant workloads (for example, for audit logs or analytics), Cloud Topics are optimized for latency-tolerant, high-throughput workloads where cross-AZ networking charges are a major consideration that can become the dominant cost driver at high throughput. These workloads can include observability streams, offline analytics, AI/ML model training data feeds, or development environments that have flexible latency requirements. | ||
|
|
||
| Instead of replicating every byte across expensive network links, Cloud Topics leverage durable, inexpensive Cloud storage (S3, ADLS, GCS, MinIO) as the primary mechanism to back up data. This eliminates over 90% of the cost of replicating data over network links in multi-AZ clusters. The difference in end-to-end latency is typically between 500 ms - 1 s, which is often acceptable for many streaming workloads, and can unlock new streaming use cases that previously were not cost effective. | ||
|
|
||
| With Cloud Topics, data from the client is not acknowledged until it is uploaded to cloud storage. This maintains durability in the face of infrastructure failures, but results in an increase in both produce latency and end-to-end latency, driven by both batching of produced data and the inherent latency of the underlying object store. You should generally expect latencies in the range of 250 ms - 1 s. | ||
|
|
||
| == Prerequisites | ||
|
|
||
| - xref:get-started:rpk-install.adoc[] v26.1 or later. | ||
| ifndef::env-cloud[] | ||
| - xref:manage:tiered-storage.adoc#set-up-tiered-storage[Enable Tiered Storage] on your Redpanda cluster. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| When you enable Tiered Storage at the cluster level, by default, all new topics are Tiered Storage (or standard) topics. However, if you plan to use Cloud Topics for all new topics in a Redpanda cluster, be sure to set the following cluster-level property: | ||
| + | ||
| [,bash] | ||
| ---- | ||
| default_redpanda_storage_mode=cloud | ||
| ---- | ||
| + | ||
| This ensures that newly-created Redpanda topics are Cloud Topics by default. | ||
| + | ||
| For details, see xref:manage:tiered-storage.adoc#enable-tiered-storage-for-a-cluster[Enable Tiered Storage for a cluster]. | ||
| ==== | ||
|
|
||
| - xref:manage:tiered-storage.adoc#configure-object-storage[Configure object storage]. | ||
| - Ensure that you have an Enterprise license. | ||
| + | ||
| To check your license status, run: | ||
| + | ||
| [,bash] | ||
| ---- | ||
| rpk cluster license info | ||
| ---- | ||
| + | ||
| - If you intend to use Docker Compose while working with Cloud Topics, see the https://docs.docker.com/compose/install/[Docker Compose installation documentation^]. To verify you have it installed, run: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| docker compose version | ||
| ---- | ||
| + | ||
| You should see the installed Docker Compose version. | ||
| + | ||
| For more details about using Docker Compose with Redpanda, see the xref:get-started:quick-start.adoc[Redpanda Self-Managed Quickstart]. | ||
|
|
||
| endif::[] | ||
|
|
||
| == Limitations | ||
|
|
||
| The Remote Read Replicas feature is not supported for Cloud Topics. | ||
|
|
||
| IMPORTANT: Any topic specified to be a Cloud Topic cannot be subsequently converted back to a standard Redpanda topic that uses local or Tiered Storage. | ||
|
|
||
| == Enable Cloud Topics for your cluster | ||
|
|
||
| To enable Cloud Topics for a cluster: | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk cluster config set cloud_topics_enabled=true | ||
| ---- | ||
Feediver1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| NOTE: This configuration update requires a restart. | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk topic create -c redpanda.storage.mode=cloud <new-cloud-topic-name> | ||
| TOPIC STATUS | ||
| audit.analytics.may2025 OK | ||
| ---- | ||
|
|
||
| You can make a topic a Cloud Topic only at topic creation time. | ||
|
|
||
Feediver1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| In addition to replication, cross-AZ ingress (producer) and egress (consumer) traffic can also contribute substantially to cloud networking cost. When running multi-AZ clusters in general, Redpanda strongly recommends using xref:../consume-data/follower-fetching.adoc[Follower Fetching], which allows consumers to avoid crossing network zones. When possible, you can use xref:../produce-data/leader-pinning.adoc[leader pinning], which positions a topic's partition leader close to the producers, providing a similar benefit for ingress traffic. These features can add additional savings to the replication cost savings of Cloud Topics. | ||
|
|
||
| // end::single-source[] | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok this part I think we need to hold off on and align with matt and will regarding
redpanda.storage.mode=cloudper my note up above. Not so much about the behavior of the configs, but about if we are going to try to unify around a new set of configs and how we want to discuss that in the context of upgrades and new clusters.cc @WillemKauf / @mattschumpert
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is incorrect- you don't need to explicitly set these settings to false to create cloud topics. you just need to set
default_redpanda_storage_mode=cloudat the cluster level to default create cloud topics. the remote read and write properties will have no effect on the topic then,redpanda.storage.modedictates the behavior of the topic.