Single source mount/unmount #874
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -7,7 +7,14 @@ For topics with Tiered Storage enabled, you can unmount a topic to safely detach | |||
| include::shared:partial$enterprise-license.adoc[] | |||
There was a problem hiding this comment.
@mattschumpert we do not have licensing content for the cloud docs like we do for self-managed. Should I remove/hide the licensing prereq for the Cloud version of this page?
There was a problem hiding this comment.
cc @towfiqa if you could provide guidance for this as well.
| . 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. | ||
| + | ||
| 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. | ||
| endif::[] | ||
| . Enable xref:manage:tiered-storage.adoc[Tiered Storage] for specific topics, or for the entire cluster (all topics). |
There was a problem hiding this comment.
@mattschumpert how should Cloud users make sure that they meet this prereq? Can they toggle Tiered Storage on a per-topic basis and is that what we should say for the Cloud version of this page?
There was a problem hiding this comment.
cc @towfiqa if you could provide guidance for this as well.
| @@ -4,4 +4,6 @@ | |||
| :page-categories: Management | |||
| :env-linux: true | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
@towfiqa This is the overview for the self-managed version of the doc. The cloud version will have this, could you review and let me know if any changes are needed?:
(preview available here)
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 remount the detached topic to the origin cluster, allowing you to hibernate a topic and free up system resources taken up by the topic.
| @@ -4,4 +4,6 @@ | |||
| :page-categories: Management | |||
| :env-linux: true | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
You can mount the detached topic to either the same origin cluster, or a different one.
Afaik cross-cluster mounting/unmounting is not supported in Cloud and definetely not supported via the cloud api
There was a problem hiding this comment.
Thanks @weeco I do have a modified version of this intro for the Cloud page. Preview here: https://deploy-preview-874--redpanda-docs-preview.netlify.app/redpanda-cloud/manage/mountable-topics/
Description
Adds Cloud API to the mountable topics doc and conditionalizes content so that the page can be single sourced between Self-Managed and Cloud docs, but Cloud API content is rendered only on the Cloud docs site.
Related: redpanda-data/cloud-docs#134
Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 26 Nov
Page previews
Redpanda Cloud docs > Manage > Mountable Topics
Checks