OSDOCS-12690: Add OADP to ROSA docs by bhardesty · Pull Request #86003 · openshift/openshift-docs

bhardesty · 2024-12-09T21:55:07Z

This PR adds the OADP content from OCP to ROSA Classic and ROSA HCP. There is no new content.

Version(s):

enterprise-4.17+

Issue:
https://issues.redhat.com/browse/OSDOCS-12690

Link to docs preview:

QE review:

N/A

openshift-ci-robot · 2024-12-09T21:55:10Z

@bhardesty: This pull request references OSDOCS-12690 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set.

Details

In response to this:

This PR adds the OADP content from OCP to ROSA Classic and ROSA HCP. There is no new content.

Version(s):

enterprise-4.17+

Issue:
https://issues.redhat.com/browse/OSDOCS-12690

Link to docs preview:

OCP:

ROSA Classic:

ROSA HCP:

QE review:

QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2024-12-09T22:07:45Z

🤖 Tue Jan 07 23:09:50 - Prow CI generated the docs preview:
https://86003--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-vale-bot · 2024-12-10T17:30:55Z

modules/oadp-1-4-1-release-notes.adoc

+During the restore operation, the {ocp} controller updates the `spec.template.spec.containers[0].image` field in the `Deployment` resource with an updated `ImageStreamTag` hash. The update triggers the rollout of a new pod, terminating the pod on which `velero` runs the FSB along with the post-hook. 
+// TODO: Include this xref when the Images book is added to ROSA HCP.
+ifndef::openshift-rosa-hcp[]
+For more information about image stream trigger, see xref:../../../openshift_images/triggering-updates-on-imagestream-changes.adoc#triggering-updates-on-imagestream-changes[Triggering updates on image stream changes].


🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies.

openshift-ci-robot · 2024-12-10T18:02:50Z

@bhardesty: This pull request references OSDOCS-12690 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set.

Details

In response to this:

This PR adds the OADP content from OCP to ROSA Classic and ROSA HCP. There is no new content.

Version(s):

enterprise-4.17+

Issue:
https://issues.redhat.com/browse/OSDOCS-12690

Link to docs preview:

OCP: https://86003--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/oadp-intro

ROSA Classic: https://86003--ocpdocs-pr.netlify.app/openshift-rosa/latest/backup_and_restore/application_backup_and_restore/oadp-intro

ROSA HCP: https://86003--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/backup_and_restore/application_backup_and_restore/oadp-intro

QE review:

QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

bhardesty · 2024-12-11T22:02:41Z

@anarnold97 @weshayutin I've added what I believe is the relevant OADP content from the OCP docs to the ROSA docs. It should now all be reused properly, with single-sourcing. Let me know what you think. I'd suggest just focusing on the doc previews to see what the OADP content looks like in the ROSA docs.

anarnold97 · 2024-12-11T22:26:33Z

@bhardesty - thanks for the hard work. i will do a read-through tomorrow. slainte

weshayutin · 2024-12-19T19:04:20Z

See: https://86003--ocpdocs-pr.netlify.app/openshift-rosa/latest/backup_and_restore/application_backup_and_restore/oadp-rosa/oadp-rosa-backing-up-applications#installing-oadp-rosa-sts_oadp-rosa-backing-up-applications

We had a bug come in for OADP 1.4.2
Essentially filesystembackup will fail if the secret is configured w/

$ cat <<EOF > ${SCRATCH}/credentials
  [default]
  role_arn = ${ROLE_ARN}
  web_identity_token_file = /var/run/secrets/openshift/serviceaccount/token
EOF

@anarnold97 @bhardesty we'll need to update to

$ cat <<EOF > ${SCRATCH}/credentials
  [default]
  role_arn = ${ROLE_ARN}
  web_identity_token_file = /var/run/secrets/openshift/serviceaccount/token
  region = <aws_region> # e.g. us-west-2
EOF

For details please see: https://issues.redhat.com/browse/OADP-5354
Thank you both

weshayutin · 2024-12-19T19:09:28Z

This is an OADP-1.2.x spec, no longer supported

  spec:
    backupImages: true 
    features:
      dataMover:
        enable: false

latest good DPA examples can be found here: https://docs.openshift.com/container-platform/4.17/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.html#oadp-installing-dpa_installing-oadp-aws

weshayutin · 2024-12-19T19:10:33Z

Everything else looks very nicely streamlined for ROSA.. well done!

anarnold97 · 2024-12-19T19:57:40Z

@bhardesty - are you ok to make the changes or do you want to push to merge and then have me to make them?

Thanks

bhardesty · 2025-01-07T22:37:19Z

@anarnold97 I made the first change (adding the AWS region). I'm not entirely sure how the supported OADP spec should look in step 6, so I'll leave that to you.

openshift-ci · 2025-01-07T23:21:14Z

@bhardesty: all tests passed!

Full PR test history. Your PR dashboard.

Details

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-sigs/prow repository. I understand the commands that are listed here.

bhardesty · 2025-01-08T22:17:40Z

/label peer-review-needed

mburke5678 · 2025-01-09T16:28:55Z

/lgtm

openshift-ci-robot · 2025-01-10T19:21:41Z

@bhardesty: This pull request references OSDOCS-12690 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set.

Details

In response to this:

This PR adds the OADP content from OCP to ROSA Classic and ROSA HCP. There is no new content.

Version(s):

enterprise-4.17+

Issue:
https://issues.redhat.com/browse/OSDOCS-12690

Link to docs preview:

OCP: https://86003--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/oadp-intro

ROSA Classic: https://86003--ocpdocs-pr.netlify.app/openshift-rosa/latest/backup_and_restore/application_backup_and_restore/oadp-intro

ROSA HCP: https://86003--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/backup_and_restore/application_backup_and_restore/oadp-intro

QE review:

N/A

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 openshift-eng/jira-lifecycle-plugin repository.

bhardesty · 2025-01-10T19:21:54Z

/label merge-review-needed

mburke5678 · 2025-01-10T23:14:28Z

/cherrypick enterprise-4.17

mburke5678 · 2025-01-10T23:14:33Z

/cherrypick enterprise-4.18

openshift-cherrypick-robot · 2025-01-10T23:15:12Z

@mburke5678: #86003 failed to apply on top of branch "enterprise-4.17":

Applying: OSDOCS-12690: Add OADP to ROSA docs
.git/rebase-apply/patch:492: trailing whitespace.
During the restore operation, the {ocp} controller updates the `spec.template.spec.containers[0].image` field in the `Deployment` resource with an updated `ImageStreamTag` hash. The update triggers the rollout of a new pod, terminating the pod on which `velero` runs the FSB along with the post-hook. 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map_rosa.yml
M	backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
M	welcome/about-hcp.adoc
Falling back to patching base and 3-way merge...
Auto-merging welcome/about-hcp.adoc
CONFLICT (content): Merge conflict in welcome/about-hcp.adoc
Removing rosa_backing_up_and_restoring_applications/snippets
Removing rosa_backing_up_and_restoring_applications/modules
Removing rosa_backing_up_and_restoring_applications/images
Removing rosa_backing_up_and_restoring_applications/backing-up-applications.adoc
Removing rosa_backing_up_and_restoring_applications/_attributes
Auto-merging backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
Auto-merging _topic_maps/_topic_map_rosa.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OSDOCS-12690: Add OADP to ROSA docs

Details

In response to this:

/cherrypick enterprise-4.17

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-sigs/prow repository.

openshift-cherrypick-robot · 2025-01-10T23:15:19Z

@mburke5678: new pull request created: #86928

Details

In response to this:

/cherrypick enterprise-4.18

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-sigs/prow repository.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 9, 2024

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 9, 2024

bhardesty force-pushed the osdocs-12690-oadp-rosa branch 4 times, most recently from 449fc6d to 83843f6 Compare December 10, 2024 17:14

ocpdocs-vale-bot reviewed Dec 10, 2024

View reviewed changes

OSDOCS-12690: Add OADP to ROSA docs

1930e14

bhardesty force-pushed the osdocs-12690-oadp-rosa branch from 83843f6 to 1930e14 Compare January 7, 2025 22:47

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 8, 2025

openshift-ci bot assigned mburke5678 Jan 9, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 9, 2025

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jan 10, 2025

mburke5678 merged commit 770c92a into openshift:main Jan 10, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Jan 10, 2025

[enterprise-4.18] OSDOCS-12690: Add OADP to ROSA docs #86928

Closed

This was referenced Jan 13, 2025

[enterprise-4.17] OSDOCS-12690: Add OADP to ROSA docs #86964

Merged

[enterprise-4.18] OSDOCS-12690: Add OADP to ROSA docs #86971

Merged

Conversation

bhardesty commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Dec 9, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-vale-bot Dec 10, 2024

Choose a reason for hiding this comment

Uh oh!

openshift-ci-robot commented Dec 10, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bhardesty commented Dec 11, 2024

Uh oh!

anarnold97 commented Dec 11, 2024

Uh oh!

weshayutin commented Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weshayutin commented Dec 19, 2024

Uh oh!

weshayutin commented Dec 19, 2024

Uh oh!

anarnold97 commented Dec 19, 2024

Uh oh!

bhardesty commented Jan 7, 2025

Uh oh!

openshift-ci bot commented Jan 7, 2025

Uh oh!

bhardesty commented Jan 8, 2025

Uh oh!

mburke5678 commented Jan 9, 2025

Uh oh!

openshift-ci-robot commented Jan 10, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bhardesty commented Jan 10, 2025

Uh oh!

Uh oh!

mburke5678 commented Jan 10, 2025

Uh oh!

mburke5678 commented Jan 10, 2025

Uh oh!

openshift-cherrypick-robot commented Jan 10, 2025

Uh oh!

openshift-cherrypick-robot commented Jan 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

bhardesty commented Dec 9, 2024 •

edited

Loading

openshift-ci-robot commented Dec 9, 2024 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Dec 9, 2024 •

edited

Loading

openshift-ci-robot commented Dec 10, 2024 •

edited by openshift-ci bot

Loading

weshayutin commented Dec 19, 2024 •

edited

Loading

openshift-ci-robot commented Jan 10, 2025 •

edited by openshift-ci bot

Loading