-
Notifications
You must be signed in to change notification settings - Fork 47
Doc 1602: Cloud Topics (Beta) #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
44
commits into
main
Choose a base branch
from
DOC-1602
base: main
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
44 commits
Select commit
Hold shift + click to select a range
fdba4a5
DOC-1602: Cloud Topics
Feediver1 c65f277
DOC-1602
Feediver1 a887548
DOC-1602: Cloud Topics
Feediver1 995af76
DOC-1602: Cloud Topics
Feediver1 aa0356a
DOC-1602: Cloud Topics
Feediver1 8f70048
DOC-1602
Feediver1 5d17406
DOC-1602
Feediver1 a3515d6
DOC-1602
Feediver1 175f268
DOC-1602
Feediver1 a293336
DOC-1602
Feediver1 238deb1
DOC-1602
Feediver1 da6b41f
DOC-1602
Feediver1 1db8c65
DOC-1602
Feediver1 0cfda42
DOC-1602
Feediver1 11eba36
DOC-1602
Feediver1 486bb3a
DOC-1602
Feediver1 2a47164
DOC-1602
Feediver1 71aa1b2
DOC-1602
Feediver1 9d06ba3
DOC-1602
Feediver1 46b4113
WIP
Feediver1 2559aac
WIP
Feediver1 680155f
WIP
Feediver1 c9f6279
wip
Feediver1 52a4749
fix change in config topics
Feediver1 0dc634c
WIP
Feediver1 f026582
wip
Feediver1 4e364e1
Update modules/develop/pages/manage-topics/cloud-topics.adoc
Feediver1 143ff36
Merge branch 'main' of https://github.com/redpanda-data/docs into DOC…
JakeSCahill 3490c89
Add cloud_topics configs
JakeSCahill 9cd28be
Add overrides
JakeSCahill 5c6324d
implemented review feedback
Feediver1 09fecb6
Merge branch 'main' into DOC-1602
Feediver1 2397b4d
removed redundant info
Feediver1 aa31084
Apply suggestions from code review
Feediver1 f447dad
Update modules/reference/attachments/redpanda-properties-v25.3.1.json
Feediver1 c6ca959
Update modules/reference/partials/properties/cluster-properties.adoc
Feediver1 428b438
Apply suggestions from code review
Feediver1 4caa86b
fixed links
Feediver1 cf88678
fix link
Feediver1 4aad0ef
fixed llinks
Feediver1 74bac79
fixed links
Feediver1 29dffa0
fixed links
Feediver1 e63670d
fix broken link
Feediver1 aad2eaf
removed link
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
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
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. | ||
| :page-beta: true | ||
| // tag::single-source[] | ||
|
|
||
| ifndef::env-cloud[] | ||
| [NOTE] | ||
| ==== | ||
| include::shared:partial$enterprise-license.adoc[] | ||
| ==== | ||
| endif::[] | ||
|
|
||
| Starting in v25.3, 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-sensitive, low-throughput workloads (for example, for audit logs), Cloud Topics are optimized for latency-tolerant, high-throughput workloads where cloud provider infrastructure costs (especially 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 where streaming latency isn't critical. | ||
|
|
||
| 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 or multi-region 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. | ||
|
|
||
| == Prerequisites | ||
|
|
||
| - xref:get-started:rpk-install.adoc[] v25.3 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 properties to `false`: | ||
|
|
||
| * config_ref:cloud_storage_enable_remote_write,false,properties/object-storage-properties[] | ||
| * config_ref:cloud_storage_enable_remote_read,false,properties/object-storage-properties[] | ||
|
|
||
| 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 following features are not supported in this beta release of Cloud Topics: | ||
|
|
||
| - Kafka compaction | ||
| - Iceberg topics | ||
| - Topic recovery | ||
| - Remote Read Replicas | ||
|
|
||
| IMPORTANT: You should expect to throw away any cluster running Cloud Topics (beta) after it becomes generally available (GA). Redpanda may be unable to continue using Cloud Topics created with the beta version, and you may be unable to upgrade to future versions. Also, 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 | ||
|
|
||
| You must first enable Cloud Topics for your cluster: | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk cluster config set unstable_beta_feature_cloud_topics_enabled=true | ||
| Successfully updated configuration. New configuration version is 3. | ||
| ---- | ||
|
|
||
| Once enabled, create the Cloud Topic: | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk topic create -c cloud_topics_enabled=true <new-cloud-topic-name> | ||
| TOPIC STATUS | ||
| audit.analytics.may2025 OK | ||
| ---- | ||
|
|
||
| You can make a topic a Cloud Topic only at topic creation time. | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Feediver1 maybe here is where we add the 'pro tip' for Producer Acks setting. |
||
| NOTE: 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[] | ||
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,4 @@ | ||
| = Topics | ||
| :page-categories: Clients, Development | ||
| :description: Learn how to manage topics in Redpanda, including creation, configuration, and advanced features. | ||
| :page-layout: index |
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
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.
Should this be a separate bulleted item under Prereqs? If not (if it should instead be nested under the enterprise license), then add + in the line breaks, like in the above suggestion