DOC-95 add get started for BYOC #391
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 📝 WalkthroughWalkthroughThe PR updates a single documentation page: modules/get-started/pages/cluster-types/byoc/index.adoc. It revises the front matter to include BYOVNet alongside BYOC and BYOVPC, and expands the page content with a structured introduction to BYOC, guidance for BYOVPC/BYOVNet, and an explicit caution about not deploying other workloads on Redpanda-managed BYOC infrastructure. No code or API changes are introduced. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes(no out-of-scope changes identified) Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
modules/get-started/pages/cluster-types/byoc/index.adoc (5)
2-2: Tune the description for “Get started” intentThis page reads as an intro/landing “Get started” page rather than a step-by-step creation guide. Consider aligning the description.
Apply this diff:
-:description: Learn how to create a Bring Your Own Cloud (BYOC), Bring Your Own Virtual Private Cloud (BYOVPC), or Bring Your Own Virtual Network (BYOVNet) cluster. +:description: Get started with Bring Your Own Cloud (BYOC), Bring Your Own Virtual Private Cloud (BYOVPC), and Bring Your Own Virtual Network (BYOVNet) clusters.
7-10: Minor style/clarity tweaks (avoid repetition; provider wording)
- Avoid repeating “Redpanda” twice in one sentence.
- “AWS and GCP” (both use VPC) reads more naturally than “AWS or GCP”.
Apply this diff:
-Bring Your Own Cloud (BYOC) lets you run Redpanda in your own cloud environment while still getting managed services from Redpanda. With BYOC clusters, Redpanda deploys into your existing cloud network: +Bring Your Own Cloud (BYOC) lets you run Redpanda in your own cloud environment while still getting fully managed operations. With BYOC clusters, Redpanda deploys into your existing cloud network: -* AWS or GCP: Virtual Private Cloud (VPC) +* AWS and GCP: Virtual Private Cloud (VPC) * Azure: Virtual Network (VNet)
12-12: Tighten terminology: “data plane,” subnets, and storage examples
- “Your data never leaves your environment” can be read as absolute. “Your data plane remains in your environment” is more precise.
- Use “subnets (subnetworks in GCP)” for cross-cloud clarity.
- Clarify object storage examples.
Apply this diff:
-Your data never leaves your environment, giving you extra security and control. See xref:get-started:byoc-arch.adoc[BYOC architecture] for details. Redpanda manages provisioning, monitoring, upgrades, and security policies and resources for your VPC or VNet, including subnetworks, IAM roles, and storage buckets/accounts. You get hands-off operations with a 99.99% uptime guarantee while keeping full control of your data. +Your data plane remains in your environment, giving you additional security and control. See xref:get-started:byoc-arch.adoc[BYOC architecture] for details. Redpanda manages provisioning, monitoring, upgrades, and security policies, and it manages required resources in your VPC or VNet, including subnets (subnetworks in GCP), IAM roles, and object storage resources (for example, S3 buckets or Azure Storage accounts). You get hands-off operations with a 99.99% uptime guarantee while keeping full control of your data.
14-14: Soften absolute claim about resource creation in BYOVPC/BYOVNet“Does not create or change any resources” is very absolute. If the product behavior is “you pre-provision and Redpanda doesn’t create resources,” great—otherwise soften to networking resources or clarify prerequisites. Also, “provides more security” is subjective; “tighter control and isolation” is clearer.
Apply this diff (adjust if product explicitly guarantees zero resource creation):
-If you want to manage the networking infrastructure yourself, create a Bring Your Own Virtual Private Cloud (BYOVPC) or Bring Your Own Virtual Network (BYOVNet) cluster. With BYOVPC/BYOVNet, the Redpanda agent does not create or change any resources in your account. This is ideal for organizations with stringent compliance requirements or existing network configurations, when you need full control over the network lifecycle. Compared to standard BYOC, BYOVPC/BYOVNet provides more security, but the configuration is more complex. See the xref:get-started:cloud-overview.adoc#shared-responsibility-model[shared responsibility model] to understand what you manage versus what Redpanda manages. +If you want to manage the networking infrastructure yourself, create a Bring Your Own Virtual Private Cloud (BYOVPC) or Bring Your Own Virtual Network (BYOVNet) cluster. With BYOVPC/BYOVNet, the Redpanda agent does not create or change resources in your account; you provision the required infrastructure up front. This is ideal for organizations with stringent compliance requirements or existing network configurations, when you need full control over the network lifecycle. Compared to standard BYOC, BYOVPC/BYOVNet can provide tighter control and isolation, but the configuration is more complex. See the xref:get-started:cloud-overview.adoc#shared-responsibility-model[shared responsibility model] to understand what you manage versus what Redpanda manages.Note: The BYOVPC/BYOVNet terminology is correct across providers per prior learnings and should be preserved.
16-16: Add rationale to the IMPORTANT admonitionBriefly stating the “why” helps users comply.
Apply this diff:
-IMPORTANT: Don't deploy other workloads on the BYOC infrastructure that Redpanda manages. +IMPORTANT: Don't deploy other workloads on the BYOC infrastructure that Redpanda manages, to avoid resource contention and to keep the environment supportable.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/get-started/pages/cluster-types/byoc/index.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.
📚 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/get-started/pages/cluster-types/byoc/index.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/get-started/pages/cluster-types/byoc/index.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
🔇 Additional comments (4)
modules/get-started/pages/cluster-types/byoc/index.adoc (4)
12-12: Confirm 99.99% uptime wording matches current SLA/SLOIf this is an SLO/SLA commitment, confirm the exact number and whether “guarantee” is the right term. If it’s an SLO, “target” may be more accurate.
Can you confirm with PM/Legal or the latest public SLA whether BYOC carries a 99.99% “guarantee” vs “target” and whether it applies to all regions/providers?
7-16: Nice addition—meets the “Get started” objective and clarifies BYOVPC/BYOVNetThis intro adds the missing context for users landing here from the docs home “Get started” link and uses correct cross-provider terminology.
12-14: Xrefs and anchor validated
- modules/get-started/pages/byoc-arch.adoc exists (xref:get-started:byoc-arch.adoc[BYOC architecture] will resolve to the top of that page)
- The “Shared responsibility model” heading at line 112 in modules/get-started/pages/cloud-overview.adoc generates the
shared-responsibility-modelanchor used by xref:get-started:cloud-overview.adoc#shared-responsibility-model[shared responsibility model]
4-4: Verify that the BYOC page-alias resolves correctly
I ran a search in the repo and didn’t find any existing or inbound references to the old path—only the alias declaration remains. Please ensure:
- Cross-references like
xref:deploy:deployment-option/cloud/provision-a-byoc-cluster[BYOC cluster]
resolve without errors in your local build.- External/inbound URLs pointing to
/deployment-option/cloud/provision-a-byoc-cluster/
are redirected to the new/cluster-types/byoc/page (via your web-server or redirect rules).If either check fails, update the alias or add the missing redirect.
| Your data never leaves your environment, giving you extra security and control. See xref:get-started:byoc-arch.adoc[BYOC architecture] for details. Redpanda manages provisioning, monitoring, upgrades, and security policies and resources for your VPC or VNet, including subnetworks, IAM roles, and storage buckets/accounts. You get hands-off operations with a 99.99% uptime guarantee while keeping full control of your data. | ||
|
|
||
| If you want to manage the networking infrastructure yourself, create a Bring Your Own Virtual Private Cloud (BYOVPC) or Bring Your Own Virtual Network (BYOVNet) cluster. With BYOVPC/BYOVNet, the Redpanda agent does not create or change any resources in your account. This is ideal for organizations with stringent compliance requirements or existing network configurations, when you need full control over the network lifecycle. Compared to standard BYOC, BYOVPC/BYOVNet provides more security, but the configuration is more complex. See the xref:get-started:cloud-overview.adoc#shared-responsibility-model[shared responsibility model] to understand what you manage versus what Redpanda manages. |
There was a problem hiding this comment.
I like the idea of starting a new line/paragrah with "Compared to standard BYOC..." to make it a bit more scannable, but also realize that makes this content longer and pushes the links on this page even farther down.
Description
This pull request adds introductory info for BYOC/BYOVPC/BYOVNet for people landing on the BYOC index page from the new Get started with BYOC link on our docs home page.
Resolves https://redpandadata.atlassian.net/browse/DOC-95
Review deadline:
Page previews
Checks