Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OADP 3144 - Installing OADP on an AWS STS cluster manually #71534

Merged
merged 1 commit into from Mar 28, 2024
Merged

OADP 3144 - Installing OADP on an AWS STS cluster manually #71534

merged 1 commit into from Mar 28, 2024

Conversation

CarmiWisemon
Copy link
Contributor

@CarmiWisemon CarmiWisemon commented Feb 13, 2024 •
edited

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 13, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Feb 13, 2024 •
edited

🤖 Thu Mar 28 17:49:37 - Prow CI generated the docs preview:
https://71534--ocpdocs-pr.netlify.app

@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 5, 2024
@CarmiWisemon CarmiWisemon force-pushed the oadp3144-aws-sts branch 2 times, most recently from d81564f to b381064 Compare March 10, 2024 12:12
@CarmiWisemon CarmiWisemon reopened this Mar 11, 2024
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 12, 2024
@CarmiWisemon CarmiWisemon force-pushed the oadp3144-aws-sts branch 2 times, most recently from d7953e6 to 6bc0fff Compare March 14, 2024 12:40
@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 14, 2024
@PrasadJoshi12
Copy link

PrasadJoshi12 commented Mar 19, 2024 •
edited

@CarmiWisemon Restic, Kopia and DataMover is not supported in case of AWS STS. We need to add the similar warning we added in ROSA doc.

@CarmiWisemon
Copy link
Contributor Author

@CarmiWisemon Restic, Kopia and DataMover is not supported in case of AWS STS. We need to add the similar warning we added in ROSA doc.

Important
Restic and Kopia are not supported in the OADP with AWS STS environment. Verify that the Restic and Kopia node agent is disabled. For backing up volumes, OADP with AWS STS supports only native snapshots and Container Storage Interface (CSI) snapshots.

Important
In an Amazon AWS cluster that uses STS authentication, restoring backed-up data in a different AWS region is not supported.

The Data Mover feature is not currently supported for AWS STS clusters. You can use native AWS S3 tools for moving data.

@PrasadJoshi12 Do you want both of these admonitions?

@CarmiWisemon CarmiWisemon force-pushed the oadp3144-aws-sts branch 3 times, most recently from 29f59e2 to b81cb51 Compare March 20, 2024 12:14
@CarmiWisemon
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Mar 27, 2024
@stevsmit stevsmit added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Mar 28, 2024
@stevsmit stevsmit added this to the Continuous Release milestone Mar 28, 2024
stevsmit
stevsmit reviewed Mar 28, 2024
View reviewed changes
backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.adoc Outdated

To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.

You can install {oadp-short} on an AWS {sts-first} (AWS STS) cluster manually. Amazon {aws-short} provides {aws-short} STS as a web service that enables you to request temporary, limited-privilege credentials for users. You use STS to provide trusted users with temporary access to resources via API calls, your {aws-short} console or the {aws-short} command line interface (CLI).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use commas between three or more items in a series, including before the conjunction that introduces the last item, to ensure that readers can clearly separate the items. For example, write "Such functions include storage management, program management, and security". Source: https://www.ibm.com/docs/en/ibm-style?topic=punctuation-commas

Suggested change
You can install {oadp-short} on an AWS {sts-first} (AWS STS) cluster manually. Amazon {aws-short} provides {aws-short} STS as a web service that enables you to request temporary, limited-privilege credentials for users. You use STS to provide trusted users with temporary access to resources via API calls, your {aws-short} console or the {aws-short} command line interface (CLI).
You can install {oadp-short} on an AWS {sts-first} (AWS STS) cluster manually. Amazon {aws-short} provides {aws-short} STS as a web service that enables you to request temporary, limited-privilege credentials for users. You use STS to provide trusted users with temporary access to resources via API calls, your {aws-short} console, or the {aws-short} command line interface (CLI).

backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.adoc Outdated

This process is performed in the following two stages:

. Prepare {aws-short} credentials
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on https://www.ibm.com/docs/en/ibm-style?topic=punctuation-periods#lists

Suggested change
. Prepare {aws-short} credentials
. Prepare {aws-short} credentials.

backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.adoc Outdated
This process is performed in the following two stages:

. Prepare {aws-short} credentials
. Install the OADP Operator and give it an IAM role
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Install the OADP Operator and give it an IAM role
. Install the OADP Operator and give it an IAM role.

backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.adoc Outdated
[role="_additional-resources"]
.Additional resources

* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove period here

Suggested change
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console].
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console]

modules/cleanup-a-backup-oadp-aws-sts.adoc Outdated
----

+
[WARNING]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if this would be a WARNING or IMPORTANT admonition? Just a thought.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMPORTANT

modules/preparing-aws-sts-credentials-for-oadp.adoc

. Retrieve all the details of the `cluster` such as the `AWS_ACCOUNT_ID, OIDC_ENDPOINT` by running the following command:
+
[source,terminal]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a space between all of these except the last two. Should you add a space there>?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I corrected it.

modules/preparing-aws-sts-credentials-for-oadp.adoc Outdated
export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)
export ROLE_NAME="${CLUSTER_NAME}-openshift-oadp-aws-cloud-credentials"
----
. Create a temporary directory to store all the files by running the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra space + addition of "of"

Suggested change
. Create a temporary directory to store all the files by running the following command:
. Create a temporary directory to store all of the files by running the following command:

modules/preparing-aws-sts-credentials-for-oadp.adoc Outdated
$ export SCRATCH="/tmp/${CLUSTER_NAME}/oadp"
mkdir -p ${SCRATCH}
----
. Display all the gathered details by running the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Display all the gathered details by running the following command:
. Display all of the gathered details by running the following command:

modules/preparing-aws-sts-credentials-for-oadp.adoc
----
$ export POLICY_NAME="OadpVer1" <1>
----
<1> The variable can be set to any value.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What variable? This is just a question. Not sure if there's anything to fix

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OadpVer1

backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.adoc Outdated
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]

[id="oadp-aws-sts-backing-up-and-cleaning"]
== Example: Backing up workload on OADP AWS STS, with an optional cleanup
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "Example:" necessary here? I think we can do something like:

Suggested change
== Example: Backing up workload on OADP AWS STS, with an optional cleanup
== Backing up workload on OADP AWS STS, with an optional cleanup
The following examples. . .

@CarmiWisemon
Copy link
Contributor Author

/test validate-asciidoc

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Mar 28, 2024

@CarmiWisemon: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@stevsmit stevsmit merged commit 4ff33b6 into openshift:main Mar 28, 2024
2 checks passed
@stevsmit
Copy link
Member

/cherry-pick enterprise-4.13

@stevsmit
Copy link
Member

/cherry-pick enterprise-4.14

@stevsmit
Copy link
Member

/cherry-pick enterprise-4.15

@stevsmit
Copy link
Member

/cherry-pick enterprise-4.16

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Mar 28, 2024
Merged
@openshift-cherrypick-robot
Copy link

@stevsmit: new pull request created: #73903

In response to this:

/cherry-pick enterprise-4.13

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot
Copy link

@stevsmit: new pull request created: #73904

In response to this:

/cherry-pick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Mar 28, 2024
Merged
@openshift-cherrypick-robot
Copy link

@stevsmit: new pull request created: #73905

In response to this:

/cherry-pick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Mar 28, 2024
Merged
@openshift-cherrypick-robot
Copy link

@stevsmit: new pull request created: #73906

In response to this:

/cherry-pick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Mar 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gwynnemonahan gwynnemonahan gwynnemonahan left review comments

@PrasadJoshi12 PrasadJoshi12 PrasadJoshi12 approved these changes

@stevsmit stevsmit stevsmit left review comments

@anarnold97 anarnold97 anarnold97 left review comments

@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments

@shubham-pampattiwar shubham-pampattiwar shubham-pampattiwar approved these changes

Assignees
No one assigned
Labels
branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 merge-review-in-progress Signifies that the merge review team is reviewing this PR OADP Label for all OADP PRs peer-review-done Signifies that the peer review team has reviewed this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
Continuous Release
Development

Successfully merging this pull request may close these issues.

None yet
9 participants
@CarmiWisemon @ocpdocs-previewbot @PrasadJoshi12 @gwynnemonahan @stevsmit @openshift-cherrypick-robot @shubham-pampattiwar @anarnold97 @ocpdocs-vale-bot