-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1658 BYOVPC requires premium support #410
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
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughText-only documentation updates in two files:
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks✅ Passed checks (5 passed)
Comment |
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.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/get-started/pages/cloud-overview.adoc (1)
372-393
: Remove/reconcile legacy "add‑on / additional purchase" messaging for BYOVPC/BYOVNetcloud-overview now lists BYOVPC (AWS) and BYOVNet (Azure) as beta — several pages still call them "add‑on", "may require an additional purchase", or instruct readers to "unlock this feature". Update wording to reflect current beta/support status or explicitly state current purchase/support requirements.
Files to update:
- modules/shared/partials/feature-flag-rpcn.adoc — line 3: "BYOVPC/BYOVNet is an add-on feature that requires Premium Support..."
- modules/get-started/pages/cluster-types/byoc/gcp/enable-secrets-byovpc-gcp.adoc — line 7: "BYOVPC is an add-on feature that may require an additional purchase."
- modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc — line 6: same wording.
- modules/get-started/pages/cloud-overview.adoc — reconcile beta feature list (lines ~385–389) with support/purchase references (e.g., enterprise/Premium support table around lines ~99 and 'To unlock...' messaging near line ~296).
Action: remove or reword "add‑on"/"additional purchase"/"unlock this feature" language (or clearly state the current policy) so all pages are consistent with cloud-overview.
🧹 Nitpick comments (3)
modules/shared/partials/feature-flag-rpcn.adoc (1)
3-3
: Standardize support-tier capitalization to "Enterprise Support" and "Premium Support"Replace occurrences of "Enterprise support" / "Premium support" with Title Case across the docs; keep "BYOVPC/BYOVNet" unchanged.
Files to update:
- modules/get-started/pages/cloud-overview.adoc — lines ~96–99, 106–107
- modules/get-started/partials/get-started-serverless.adoc — lines ~17, 26
- modules/get-started/pages/whats-new-cloud.adoc — lines ~237–238
modules/get-started/pages/cloud-overview.adoc (2)
106-106
: Proper-case support tier names for consistencyCapitalize product tier names.
-* Enterprise support provides access to streaming experts 24/5, with 24/7 priority escalation for production outages. Premium support offers enhanced response SLAs. +* Enterprise Support provides access to streaming experts 24/5, with 24/7 priority escalation for production outages. Premium Support offers enhanced response SLAs.
151-157
: Optional: add a cross-reference or note about Premium Support in BYOVPC/BYOVNet sectionConsider an inline NOTE here to reiterate the Premium Support requirement to reduce context-switching for readers who skim sections.
I can propose a one-line NOTE with consistent phrasing if helpful.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/get-started/pages/cloud-overview.adoc
(1 hunks)modules/shared/partials/feature-flag-rpcn.adoc
(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.061Z
Learning: In Redpanda Cloud documentation, BYOVPC and BYOVNet are different product names for different cloud providers: BYOVPC is used for AWS and GCP, while BYOVNet is used for Azure. When documentation sections cover multiple cloud providers, the combined notation "BYOVPC/BYOVNet" is correct and should not be changed to use only one term.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
📚 Learning: 2025-07-21T21:52:17.061Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.061Z
Learning: In Redpanda Cloud documentation, BYOVPC and BYOVNet are different product names for different cloud providers: BYOVPC is used for AWS and GCP, while BYOVNet is used for Azure. When documentation sections cover multiple cloud providers, the combined notation "BYOVPC/BYOVNet" is correct and should not be changed to use only one term.
Applied to files:
modules/shared/partials/feature-flag-rpcn.adoc
📚 Learning: 2025-08-07T16:36:45.111Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.
Applied to files:
modules/shared/partials/feature-flag-rpcn.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
@coderabbitai review |
✅ Actions performedReview triggered.
|
Description
This pull request updates the Redpanda Cloud documentation to make it clear that Premium support is required for BYOVPC.
Resolves https://redpandadata.atlassian.net/browse/DOC-1658
Review deadline:
Page previews
Cloud Overview (see last row of table + note below table)
Create BYOVPC/VNet for AWS/Azure/GCP (see Important admonition at top of page: note that AWS and Azure are still in beta, and we say Redpanda Support does not support beta features)
Checks