From e567492a089635904e20a15889945d99acda2bc3 Mon Sep 17 00:00:00 2001 From: Tiger Kaovilai Date: Mon, 15 Sep 2025 17:51:38 -0400 Subject: [PATCH] DNM: aws sts docs Signed-off-by: Tiger Kaovilai --- .../oadp-aws-sts-cloud-authentication.adoc | 113 +++++------------- .../oadp-rosa-sts-cloud-authentication.adoc | 43 ++++--- 2 files changed, 53 insertions(+), 103 deletions(-) diff --git a/docs/config/aws/oadp-aws-sts-cloud-authentication.adoc b/docs/config/aws/oadp-aws-sts-cloud-authentication.adoc index a09b888cb18..a70a32f93ab 100644 --- a/docs/config/aws/oadp-aws-sts-cloud-authentication.adoc +++ b/docs/config/aws/oadp-aws-sts-cloud-authentication.adoc @@ -194,31 +194,43 @@ echo "Role ARN: $ROLE_ARN" oc create namespace openshift-adp ---- -. Annotate the service accounts to use AWS STS: +[id="oadp-aws-console-installation_{context}"] +== Installing OADP Operator via OpenShift Web Console + +When installing the OADP operator through the OpenShift web console with tokenized authentication support, you will be presented with cloud provider-specific configuration fields. + +[NOTE] +==== +For OpenShift 4.15 and later, the web console supports tokenized authentication during operator installation, allowing you to provide cloud credentials directly through the installation form. +==== + +.Console Installation Fields for AWS + +During operator installation, the web console will display the following field: + +*role ARN*:: +**Field Label:** "role ARN" + -[source,bash] ----- -oc annotate serviceaccount velero -n openshift-adp \ - eks.amazonaws.com/role-arn="${ROLE_ARN}" --overwrite +**Help Text:** "The role ARN required for the operator to access the cloud API." ++ +**Value to Enter:** Use the `ROLE_ARN` value from the prerequisite setup steps above (e.g., `arn:aws:iam::123456789012:role/openshift-adp-controller-manager`). -oc annotate serviceaccount openshift-adp-controller-manager -n openshift-adp \ - eks.amazonaws.com/role-arn="${ROLE_ARN}" --overwrite ----- +This field corresponds to the IAM role you created in the prerequisite steps. The role ARN format is `arn:aws:iam::${AWS_ACCOUNT_ID}:role/${ROLE_NAME}`. [id="oadp-aws-cloud-storage-api_{context}"] == Alternative: Using Cloud Storage API for Automated Bucket Management -Instead of manually creating S3 buckets, you can use the OADP Cloud Storage API to automatically manage bucket creation and configuration. This approach requires OADP operator version with Cloud Storage API support. +Instead of manually creating S3 buckets, you can use the OADP CloudStorage API to automatically manage bucket creation and configuration. -.Prerequisites for Cloud Storage API +[NOTE] +==== +For comprehensive documentation on the CloudStorage API, including detailed configuration options, troubleshooting, and advanced usage, see link:../oadp-cloudstorage-api.html[OADP CloudStorage API]. +==== -* OADP operator with Cloud Storage API functionality enabled -* The same AWS STS configuration as above +.AWS-Specific CloudStorage Configuration -.Procedure for Cloud Storage API +For AWS with STS authentication, create a CloudStorage resource using the variables from the STS setup above: -. Create a CloudStorage resource instead of manually creating buckets: -+ [source,yaml] ---- cat <