DOC-1007 clarify BYOVPC limitations (#196)

* DOC-1007 clarify BYOVPC limitations * prereq: only primary CIDR ranges supported for VPC * Update modules/develop/partials/availability-message.adoc Co-authored-by: Angela Simms <[email protected]> * fix typo --------- Co-authored-by: Angela Simms <[email protected]>
redpanda-data · Feb 7, 2025 · 4f2f0db · 4f2f0db
1 parent 753cb58
commit 4f2f0db
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 12 deletions.
diff --git a/modules/develop/pages/connect/about.adoc b/modules/develop/pages/connect/about.adoc
@@ -2,10 +2,10 @@
 :tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--PipelineService
 :description: Learn about Redpanda Connect in Redpanda Cloud and its wide range of connectors.
 
-include::develop:partial$availability-message.adoc[]
-
 Redpanda Connect in Redpanda Cloud lets you quickly build and deploy streaming data pipelines on your clusters from a fully-integrated UI or using the pass:a,m[xref:{tag-pipeline-service}[Data Plane API\]]. 
 
+include::develop:partial$availability-message.adoc[]
+
 Choose from a xref:develop:connect/components/catalog.adoc[wide range of connectors] to suit your use case, including connectors to: 
 
 * Integrate data sources (xref:components:inputs/about.adoc[inputs])

diff --git a/modules/develop/partials/availability-message.adoc b/modules/develop/partials/availability-message.adoc
@@ -1,2 +1,9 @@
-NOTE: Redpanda Connect is currently in a limited availability (LA) release for  
-BYOC and Dedicated clusters. While it is also available as a beta feature for Serverless Standard and Pro clusters, it is not suitable for production deployments.
+[NOTE]
+====
+
+* Redpanda Connect is available in limited availability (LA) for BYOC and Dedicated clusters. Features in LA are production-ready and are covered by Redpanda Support for early adopters. To unlock Redpanda Connect for your account, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].  
+* Redpanda Connect is not available for BYOVPC clusters. 
+* Redpanda Connect is available in beta for Serverless clusters. Features in beta are not covered by Redpanda Support and should not be used in production environments.
+==== 
+
+
diff --git a/modules/get-started/pages/cloud-overview.adoc b/modules/get-started/pages/cloud-overview.adoc
@@ -307,7 +307,7 @@ NOTE: The `rpk cloud` commands are not supported in Self-Managed deployments.
 
 == Features in limited availability
 
-Features in limited availability are production-ready and are covered by Redpanda Support for early adoptors. 
+Features in limited availability are production-ready and are covered by Redpanda Support for early adopters. 
 
 The following features are currently in limited availability in Redpanda Cloud:
 

diff --git a/modules/get-started/pages/cluster-types/byoc/aws/index.adoc b/modules/get-started/pages/cluster-types/byoc/aws/index.adoc
@@ -1,4 +1,4 @@
 = BYOC: AWS
-:description: Learn how to create a BYOC cluster on AWS.
+:description: Learn how to create a BYOC or BYOVPC cluster on AWS.
 :page-layout: index
 :page-categories: Deployment 
diff --git a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc
@@ -4,7 +4,7 @@
 :page-cloud: true
 :page-beta: true
 
-include::shared:partial$feature-flag.adoc[]
+include::shared:partial$feature-flag-rpcn.adoc[]
 
 This topic explains how to create a Bring Your Own Virtual Private Cloud (BYOVPC) cluster. This setup allows you to deploy the Redpanda glossterm:data plane[] into your existing VPC and take full control of managing the networking lifecycle. Compared to a standard Bring Your Own Cluster (BYOC) setup, where Redpanda manages the networking lifecycle for you, this option provides more security.
 
@@ -27,6 +27,7 @@ The https://github.com/redpanda-data/cloud-examples/tree/main/customer-managed/a
 
 * Existing clusters cannot be moved to a BYOVPC cluster.
 * After creating a BYOVPC cluster, you cannot change to a different VPC.
+* Only primary CIDR ranges are supported for the VPC.
 
 == Set environment variables
 

diff --git a/modules/get-started/pages/cluster-types/byoc/azure/index.adoc b/modules/get-started/pages/cluster-types/byoc/azure/index.adoc
@@ -1,4 +1,4 @@
 = BYOC: Azure
-:description: Learn how to create a BYOC cluster on Azure.
+:description: Learn how to create a BYOC or BYOVPC cluster on Azure.
 :page-layout: index
 :page-categories: Deployment 
diff --git a/modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc b/modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc
@@ -2,7 +2,7 @@
 :description: Connect Redpanda Cloud to your existing VNet for additional security.
 :page-beta: true
 
-include::shared:partial$feature-flag.adoc[]
+include::shared:partial$feature-flag-rpcn.adoc[]
 
 This topic explains how to create a Bring Your Own Virtual Private Cloud (BYOVPC) cluster. This setup allows you to deploy the Redpanda glossterm:data plane[] into your existing virtual network (VNet) and take full control of managing the networking lifecycle. Compared to a standard Bring Your Own Cluster (BYOC) setup, where Redpanda manages the networking lifecycle for you, this option provides more security.
 
@@ -35,6 +35,7 @@ See the code for the complete list of resources required to create and deploy Re
 
 * Existing clusters cannot be moved to a BYOVPC cluster.
 * After creating a BYOVPC cluster, you cannot change to a different VNet.
+* Only primary CIDR ranges are supported for the VNet.
 
 == Set environment variables
 

diff --git a/modules/get-started/pages/cluster-types/byoc/gcp/index.adoc b/modules/get-started/pages/cluster-types/byoc/gcp/index.adoc
@@ -1,4 +1,4 @@
 = BYOC: GCP
-:description: Learn how to create a BYOC cluster on GCP.
+:description: Learn how to create a BYOC or BYOVPC cluster on GCP.
 :page-layout: index
 :page-categories: Deployment 
diff --git a/modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc b/modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc
@@ -2,7 +2,7 @@
 :description: Connect Redpanda Cloud to your existing VPC for additional security.
 :page-aliases: deploy:deployment-option/cloud/vpc-byo-gcp.adoc, get-started:cluster-types/byoc/vpc-byo-gcp.adoc
 
-include::shared:partial$feature-flag.adoc[]
+include::shared:partial$feature-flag-rpcn.adoc[]
 
 This topic explains how to create a Bring Your Own Virtual Private Cloud (BYOVPC) cluster. This setup allows you to deploy the Redpanda glossterm:data plane[] into your existing VPC and take full control of managing the networking lifecycle. Compared to a standard Bring Your Own Cluster (BYOC) setup, where Redpanda manages the networking lifecycle for you, this option provides more security.
 
@@ -16,6 +16,7 @@ When you create a BYOCVPC cluster, you specify your VPC and service account. The
 
 * A standalone GCP project is recommended. If your host project (where your VPC project is created) and your service project (where your Redpanda cluster is created) are in different projects, you must first provision a shared VPC in Google Cloud. For more information, see the https://cloud.google.com/vpc/docs/provisioning-shared-vpc[Google shared VPC documentation^]. 
 * Redpanda creates a private Google Kubernetes Engine (GKE) cluster in your VPC. The subnet and secondary IP ranges you provide must allow public internet access. The configuration requires you to provide reserved CIDR ranges for the subnet and GKE Pods, Services, and master IP addresses. See the https://cloud.google.com/kubernetes-engine/docs/how-to/service-accounts[GKE service account documentation^] and <<Configure your VPC>>. 
+* Only primary CIDR ranges are supported for the VPC.
 * Redpanda requires access to certain Google APIs, storage buckets, and service accounts. See <<Configure the service project>>.
 
 == Limitations

diff --git a/modules/get-started/pages/cluster-types/byoc/index.adoc b/modules/get-started/pages/cluster-types/byoc/index.adoc
@@ -1,5 +1,5 @@
 = BYOC
-:description: Learn how to create a Bring Your Own Cloud (BYOC) cluster.
+:description: Learn how to create a Bring Your Own Cloud (BYOC) or Bring Your Own Virtual Private Cloud (BYOVPC) cluster.
 :page-layout: index
 :page-aliases: deploy:deployment-option/cloud/provision-a-byoc-cluster/index.adoc
 :page-categories: Deployment
diff --git a/modules/shared/partials/feature-flag-rpcn.adoc b/modules/shared/partials/feature-flag-rpcn.adoc
@@ -0,0 +1,6 @@
+[IMPORTANT]
+====
+
+* BYOVPC is an add-on feature that may require an additional purchase. To unlock this feature for your account, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].  
+* Redpanda Connect is not available for BYOVPC clusters. 
+====