DOC-792 BYO VNET phase 2 (#149)

* DOC-792 BYO VNET phase 2 * incorporate changes from gist file * collapsed files/output + update BYOVPC for GCP * minor edit, to be consistent with AWS version * minor edits * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * incorporate feedback from doc review * Update modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc Co-authored-by: Jake Cahill <[email protected]> * incorporate review feedback --------- Co-authored-by: Jake Cahill <[email protected]>
redpanda-data · Dec 17, 2024 · 3a3a053 · 3a3a053
1 parent 868d863
commit 3a3a053
Show file tree

Hide file tree

Showing 6 changed files with 277 additions and 105 deletions.
diff --git a/modules/get-started/pages/cloud-overview.adoc b/modules/get-started/pages/cloud-overview.adoc
@@ -15,7 +15,7 @@ Redpanda offers three types of fully-managed cloud clusters:
 * <<Dedicated Cloud>>: Single-tenant clusters hosted in Redpanda Cloud. This provides more control over your deployment. 
 * <<Bring Your Own Cloud (BYOC)>>: Clusters hosted in your private cloud. This provides more control over your deployment and offers full data sovereignty. 
 +
-NOTE: With standard BYOC clusters, Redpanda manages security policies and resources for your VPC or VNet, including subnetworks, IAM roles, and storage buckets/accounts. For the highest level of security, you can manage these resources yourself with a customer-managed BYOVPC cluster.
+NOTE: With standard BYOC clusters, Redpanda manages security policies and resources for your VPC or VNet, including subnetworks, IAM roles, and storage buckets/accounts. A Bring Your Own Virtual Private Cloud (BYOVPC) cluster allows you to deploy the Redpanda glossterm:data plane[] into your existing VPC/VNet and take full control of managing the networking lifecycle. Compared to a standard BYOC setup, this option provides more security.
 
 === Serverless
 

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
@@ -6,15 +6,15 @@
 
 include::shared:partial$feature-flag.adoc[]
 
-With a standard BYOC cluster, Redpanda manages the VPC lifecycle. For additional security, you can deploy the Redpanda glossterm:data plane[] into your existing shared VPC and manage the VPC lifecycle yourself. 
+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.
 
 When you create a BYOCVPC cluster, you specify your VPC and service account. The Redpanda Cloud agent doesn't create any new resources or alter any settings in your account. With BYOVPC: 
 
 * You provide your own VPC in your AWS account.
 * You maintain more control over your account, because Redpanda requires fewer permissions than standard BYOC clusters.
 * You control your security resources and policies, including subnets, service accounts, IAM roles, firewall rules, and storage buckets.
 
-The https://github.com/redpanda-data/cloud-examples/tree/main/customer-managed/aws[Redpanda repository^] contains the code that deploys the resources you must create for a BYOVPC cluster. You create these resources in advance and provide them to Redpanda during cluster creation. The code is provided in https://developer.hashicorp.com/terraform[Terraform^]. There may be resources in the repository that already exist in your environment that you don't want to create (for example, the VPC). Variables are provided for this purpose.
+The https://github.com/redpanda-data/cloud-examples/tree/main/customer-managed/aws[Redpanda Cloud Examples repository^] contains https://developer.hashicorp.com/terraform[Terraform^] code that deploys the resources required for a BYOVPC cluster on AWS. You'll need to create these resources in advance and give them to Redpanda during cluster creation. Variables are provided in the code so you can exclude resources that already exist in your environment, such as the VPC.
 
 == Prerequisites
 
@@ -45,7 +45,7 @@ The https://github.com/redpanda-data/cloud-examples/blob/main/customer-managed/a
 
 == Configure Terraform
 
-NOTE: You may want to configure https://developer.hashicorp.com/terraform/language/state/remote[remote state^] for this Terraform. For simplicity, these instructions assume local state.
+NOTE: For simplicity, these instructions assume that Terraform is configured to use local state. You may want to configure https://developer.hashicorp.com/terraform/language/state/remote[remote state^]. 
 
 Define a JSON file called `byovnet.auto.tfvars.json` inside the Terraform directory that contains information about the VPC. Optionally, you can enable PrivateLink. For example: 
 
@@ -105,7 +105,7 @@ export REDPANDA_CLIENT_SECRET=
 
 == Authenticate with Redpanda Cloud
 
-Get a Bearer token from Redpanda's authentication endpoint using the Redpanda credentials:
+Get a glossterm:bearer token[] from the Cloud API authentication endpoint using your Redpanda credentials:
 
 ```bash
 export BEARER_TOKEN=$(curl --request POST \
@@ -281,7 +281,7 @@ Finished apply	{"provisioner": "redpanda-agent"}
 The Redpanda cluster is deploying. This can take up to 45 minutes. View status at https://cloud.redpanda.com/clusters/${REDPANDA_ID}/overview.
 ```
 
-The agent VM now is running and handles the remaining provisioning steps. This can take up to 45 minutes. When provisioning completes, the cluster status updates to `Running`. If the cluster remains in `Creating` status after 45 minutes, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^].
+The Redpanda Cloud agent now is running and handles the remaining steps. This can take up to 45 minutes. When provisioning completes, the cluster status updates to `Running`. If the cluster remains in `Creating` status after 45 minutes, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].
 
 === Validation checks
 
@@ -324,7 +324,7 @@ curl -X GET "https://api.redpanda.com/v1beta2/clusters/${REDPANDA_ID}" \
 
 == Delete cluster
 
-To delete the Redpanda cluster with the Cloud API, run:
+To delete the cluster, first send a DELETE request to the Cloud API, and retrieve the `resource_id` of the DELETE operation. Then run the `rpk` command to destroy the cluster identified by the `resource_id`.
 
 ```bash
 export REDPANDA_ID=$(curl -X DELETE "https://api.redpanda.com/v1beta2/clusters/${REDPANDA_ID}" \

diff --git a/modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc b/modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc
@@ -4,7 +4,7 @@
 
 include::shared:partial$feature-flag.adoc[]
 
-NOTE: With standard BYOC clusters, Redpanda manages security policies and resources for your virtual network (VNet), including subnetworks, managed identities, IAM roles, security groups, and storage accounts. For the most security, you can manage these resources yourself with a xref:get-started:cluster-types/byoc/azure/vnet-azure.adoc[customer-managed VNet on Azure].
+NOTE: With standard BYOC clusters, Redpanda manages security policies and resources for your virtual network (VNet), including subnetworks, managed identities, IAM roles, security groups, and storage accounts. For the most security, you can manage these resources yourself with a xref:get-started:cluster-types/byoc/azure/vnet-azure.adoc[BYOVPC cluster on Azure].
 
 == Prerequisites