Skip to content
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

Single source mount/unmount #874

Open
wants to merge 4 commits into
base: v-WIP/24.3
Choose a base branch
from

Conversation

kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Nov 21, 2024

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

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 199fb00
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67410102fc2d7100081cbe97
😎 Deploy Preview https://deploy-preview-874--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kbatuigas kbatuigas marked this pull request as ready for review November 22, 2024 21:40
@kbatuigas kbatuigas requested a review from a team as a code owner November 22, 2024 21:40
@@ -7,7 +7,14 @@ For topics with Tiered Storage enabled, you can unmount a topic to safely detach
include::shared:partial$enterprise-license.adoc[]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @towfiqa if you could provide guidance for this as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant