Skip to content

Commit 5bf691e

Browse files
committed
Add overview paragraph directly in self-managed version of page
1 parent 199fb00 commit 5bf691e

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

modules/manage/pages/mountable-topics.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44
:page-categories: Management
55
:env-linux: true
66

7+
For topics with Tiered Storage enabled, you can unmount a topic to safely detach it from a cluster and keep the topic data in the cluster's object storage bucket or container. You can mount the detached topic to either the same origin cluster, or a different one. This allows you to hibernate a topic and free up system resources taken up by the topic, or migrate a topic to a different cluster.
8+
79
include::manage:partial$mountable-topics.adoc[]

modules/manage/partials/mountable-topics.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
For topics with Tiered Storage enabled, you can unmount a topic to safely detach it from a cluster and keep the topic data in the cluster's object storage bucket or container. You can mount the detached topic to either the same origin cluster, or a different one. This allows you to hibernate a topic and free up system resources taken up by the topic, or migrate a topic to a different cluster.
2-
31
== Prerequisites
42

53
[NOTE]
@@ -9,13 +7,15 @@ include::shared:partial$enterprise-license.adoc[]
97

108
ifndef::env-cloud[]
119
. xref:get-started:rpk-install.adoc[Install `rpk`], or ensure that you have access to the Admin API.
10+
. Enable xref:manage:tiered-storage.adoc[Tiered Storage] for specific topics, or for the entire cluster (all topics).
1211
endif::[]
1312
ifdef::env-cloud[]
1413
. xref:manage:rpk/rpk-install.adoc[Install `rpk`] to run cluster mount and unmount operations on the command line, or xref:manage:api/cloud-api-authentication.adoc[authenticate] to the Cloud API and execute these operations programmatically.
1514
+
1615
If using the Cloud API, you'll make requests against Data Plane APIs. Make sure you xref:manage:api/cloud-dataplane-api.adoc#get-data-plane-api-url[retrieve the Data Plane API URL] and use this URL to perform a mount or unmount operation.
16+
. Enable xref:ROOT:manage:tiered-storage.adoc[Tiered Storage] for the topics you want to unmount or mount.
1717
endif::[]
18-
. Enable xref:manage:tiered-storage.adoc[Tiered Storage] for specific topics, or for the entire cluster (all topics).
18+
1919

2020
== Unmount a topic from a cluster to object storage
2121

0 commit comments

Comments
 (0)