Single source mount/unmount #874
Merged
Conversation
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
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Gellért Peresztegi-Nagy <[email protected]> Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Angela Simms <[email protected]> Co-authored-by: Joyce Fee <[email protected]> Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Angela Simms <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]> Co-authored-by: Jake Cahill <[email protected]> Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Gellért Peresztegi-Nagy <[email protected]> Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Michele Cyran <[email protected]> Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: JakeSCahill <[email protected]> Co-authored-by: Michele Cyran <[email protected]> Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Jake Cahill <[email protected]> Co-authored-by: Kat Batuigas <[email protected]> Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]> Co-authored-by: Gellért Peresztegi-Nagy <[email protected]> Co-authored-by: Angela Simms <[email protected]> Co-authored-by: Kat Batuigas <[email protected]> Co-authored-by: Michele Cyran <[email protected]>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
kbatuigas
commented
Nov 22, 2024
|
|
||
| [NOTE] | ||
| ==== | ||
| include::shared:partial$enterprise-license.adoc[] |
Contributor
Author
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?
Contributor
Author
There was a problem hiding this comment.
cc @towfiqa if you could provide guidance for this as well.
kbatuigas
commented
Nov 22, 2024
| + | ||
| 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). |
Contributor
Author
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?
Contributor
Author
There was a problem hiding this comment.
cc @towfiqa if you could provide guidance for this as well.
4 tasks
kbatuigas
commented
Nov 28, 2024
| :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. |
Contributor
Author
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.
weeco
reviewed
Nov 28, 2024
| :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. |
Contributor
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
Contributor
Author
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/
weeco
approved these changes
Nov 28, 2024
…APIs-for-mount-unmount-of-TS-topics # Conflicts: # antora.yml # modules/ROOT/nav.adoc # modules/console/pages/config/enterprise-license.adoc # modules/console/pages/ui/generate-bundle.adoc # modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc # modules/develop/pages/produce-data/leader-pinning.adoc # modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc # modules/get-started/pages/licensing/add-license-redpanda/linux.adoc # modules/get-started/pages/licensing/monitor-license-status.adoc # modules/get-started/pages/licensing/overview.adoc # modules/get-started/pages/whats-new.adoc # modules/get-started/partials/licensing/check-license.adoc # modules/manage/pages/mountable-topics.adoc # modules/manage/partials/mountable-topics.adoc # modules/reference/pages/properties/cluster-properties.adoc # modules/reference/pages/properties/topic-properties.adoc # modules/reference/pages/public-metrics-reference.adoc # modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc # modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc # modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc # modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc # modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc # modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc # modules/shared/partials/enterprise-and-console.adoc # modules/troubleshoot/partials/errors-and-solutions.adoc
Deflaimun
force-pushed
the
DOC-717-Document-Cloud-Feature-Public-Cloud-APIs-for-mount-unmount-of-TS-topics
branch
2 times, most recently
from
f55ee88 to
8ff5de8
Compare
Contributor
|
Force-push: Add back the local-playbook change |
Feediver1
reviewed
Dec 3, 2024
| ``` | ||
| + | ||
| * `ns` is the topic namespace. This field is optional and only `kafka` is supported. | ||
| * You may have multiple topics with the same name that are available to mount from object storage. This can happen if you have unmounted topics with this name from different clusters. To uniquely identify a source topic, use `<topic-name>/<cluster-uuid>/<initial-revision>` as the topic reference. |
Contributor
There was a problem hiding this comment.
Suggested change
| * You may have multiple topics with the same name that are available to mount from object storage. This can happen if you have unmounted topics with this name from different clusters. To uniquely identify a source topic, use `<topic-name>/<cluster-uuid>/<initial-revision>` as the topic reference. | |
| * You may have multiple topics with the same name that are available to mount from object storage. This can happen if you have unmounted topics using the same name in different clusters. To uniquely identify a source topic, use `<topic-name>/<cluster-uuid>/<initial-revision>` as the topic reference. |
Feediver1
reviewed
Dec 3, 2024
| + | ||
| * `ns` is the topic namespace. This field is optional and only `kafka` is supported. | ||
| * You may have multiple topics with the same name that are available to mount from object storage. This can happen if you have unmounted topics with this name from different clusters. To uniquely identify a source topic, use `<topic-name>/<cluster-uuid>/<initial-revision>` as the topic reference. | ||
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. In the example, you specify a new name for topic 1 in the target cluster, but topic 2 retains its original name in the target cluster. |
Contributor
There was a problem hiding this comment.
Suggested change
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. In the example, you specify a new name for topic 1 in the target cluster, but topic 2 retains its original name in the target cluster. | |
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. The following example shows how to specify a new name for topic 1 in the target cluster, while topic 2 retains its original name in the target cluster. |
Feediver1
reviewed
Dec 3, 2024
| * `ns` is the topic namespace. This field is optional and only `kafka` is supported. | ||
| * You may have multiple topics with the same name that are available to mount from object storage. This can happen if you have unmounted topics with this name from different clusters. To uniquely identify a source topic, use `<topic-name>/<cluster-uuid>/<initial-revision>` as the topic reference. | ||
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. In the example, you specify new names for topics 1 and 3 in the target cluster, but topic 2 retains its original name in the target cluster. | ||
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. In the example, you specify a new name for topic 1 in the target cluster, but topic 2 retains its original name in the target cluster. |
Contributor
There was a problem hiding this comment.
Suggested change
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. In the example, you specify a new name for topic 1 in the target cluster, but topic 2 retains its original name in the target cluster. | |
| * To rename a topic in the target cluster, use the optional `alias` object in the request body. The following example shows how to specify a new name for topic 1 in the target cluster, while topic 2 retains its original name in the target cluster. |
Feediver1
reviewed
Dec 3, 2024
Co-authored-by: Joyce Fee <[email protected]>
Contributor
Author
|
Status update: have a request out to the API team to add the mount/unmount endpoints to the OpenAPI spec. I'll wait till tomorrow morning Eastern Time to see we can get that in so we can also add the reference doc URLs here, otherwise I'll go ahead and merge tomorrow and we can add the xrefs afterwards. |
kbatuigas
deleted the
DOC-717-Document-Cloud-Feature-Public-Cloud-APIs-for-mount-unmount-of-TS-topics
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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