DOC-646 Document AWS BYOC prereqs (#96)

* DOC-646 AWS BYOC user requirements * add bullet for IAM policies * minor edits * Update modules/get-started/pages/cluster-types/byoc/aws/create-byoc-cluster-aws.adoc Co-authored-by: Kat Batuigas <[email protected]> * clarifying edit from doc review "This page lists the IAM permissions Redpanda needs to create a BYOC cluster. No IAM permissions are required for Redpanda Cloud users." --------- Co-authored-by: Kat Batuigas <[email protected]>
redpanda-data · Oct 29, 2024 · 994f151 · 994f151
1 parent 410ed9a
commit 994f151
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/modules/get-started/pages/cluster-types/byoc/aws/create-byoc-cluster-aws.adoc b/modules/get-started/pages/cluster-types/byoc/aws/create-byoc-cluster-aws.adoc
@@ -6,6 +6,21 @@ To create a Redpanda cluster in your virtual private cloud (VPC), follow the ins
 
 See also: xref:get-started:cloud-overview.adoc#redpanda-cloud-architecture[Redpanda Cloud architecture].
 
+== Prerequisites
+
+With BYOC, Redpanda manages security policies and resources for your VPC, including subnetworks, service accounts, IAM roles, firewall rules, and storage buckets. Before you deploy a BYOC cluster on AWS, check that the user creating the cluster has the following prerequisites: 
+
+* A minimum version of Redpanda `rpk` v24.1. See xref:manage:rpk/rpk-install.adoc[].
+* The permissions necessary to launch infrastructure for running Redpanda. See xref:security:authorization/cloud-iam-policies.adoc[IAM policies].
+* The AWS variables necessary to authenticate. Use either:
++
+--
+** `AWS_PROFILE` or
+** `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+
+To verify access, you should be able to successfully run `aws sts get-caller-identity` for your region. See the https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/get-caller-identity.html[AWS CLI reference^].
+--
+
 == Create a BYOC cluster
 
 . Log in to https://cloud.redpanda.com[Redpanda Cloud^].

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
@@ -10,7 +10,7 @@ Before you deploy a BYOC cluster on Azure, check all prerequisites to ensure tha
 
 === Verify rpk version
 
-Confirm you have a minimum version of Redpanda `rpk` v24.1. See xref:reference:rpk/rpk-version.adoc[`rpk version`] or xref:manage:rpk/intro-to-rpk.adoc[].
+Confirm you have a minimum version of Redpanda `rpk` v24.1. See xref:manage:rpk/rpk-install.adoc[].
 
 === Prepare your Azure subscription
 

diff --git a/modules/manage/pages/rpk/rpk-install.adoc b/modules/manage/pages/rpk/rpk-install.adoc
@@ -1,4 +1,4 @@
-= Install rpk
+= Install or Update rpk
 :page-aliases: get-started:rpk-install.adoc, quickstart:rpk-install.adoc
 :page-categories: rpk
 include::ROOT:get-started:rpk-install.adoc[tag=single-source]
diff --git a/modules/security/partials/iam-policies.adoc b/modules/security/partials/iam-policies.adoc
@@ -4,7 +4,7 @@ agent access, so that brokers can communicate with the BYOC clusters.
 
 See also: xref:get-started:cloud-overview.adoc#byoc-architecture[BYOC architecture]
 
-NOTE: This page lists the IAM permissions Redpanda uses. Nothing is required by Redpanda Cloud users. 
+NOTE: This page lists the IAM permissions Redpanda needs to create a BYOC cluster. No IAM permissions are required for Redpanda Cloud users. 
 
 ifdef::env-aws[]
 == AWS IAM policies