OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #69221

sbeskin-redhat · 2023-12-11T20:42:23Z

openshift-ci-robot · 2023-12-11T20:42:28Z

@sbeskin-redhat: This pull request references OADP-3184 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 task to target the "4.16.0" version, but no target version was set.

In response to this:

Resolves: https://issues.redhat.com/browse/OADP-3184
OADP 1.3
OCP 4.12+
Preview:

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-ci · 2023-12-11T20:44:51Z

Hi @sbeskin-redhat. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

sbeskin-redhat · 2024-01-03T19:08:58Z

/ok-to-test

openshift-ci · 2024-01-03T19:10:23Z

@sbeskin-redhat: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/ok-to-test

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.

sbeskin-redhat · 2024-01-04T13:39:34Z

/ok-to-test

ocpdocs-previewbot · 2024-01-14T17:51:13Z

🤖 Thu Jan 18 14:06:15 - Prow CI generated the docs preview: https://69221--ocpdocs-pr.netlify.app

sbeskin-redhat · 2024-01-14T17:59:41Z

/label peer-review-needed

bburt-rh · 2024-01-15T17:07:30Z

@sbeskin-redhat - I am removing the peer review labels and bouncing this back to you.

Please add the direct preview links to all of the changes being made in this PR and then ask again for a peer review. Reviewing the rendered preview is part of the peer review process.

This PR also needs QE review information in the description. It helps to follow the template provided when you first created the PR.

Thank you!

openshift-ci-robot · 2024-01-16T17:16:01Z

@sbeskin-redhat: This pull request references OADP-3184 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 task to target the "4.16.0" version, but no target version was set.

In response to this:

Resolves: https://issues.redhat.com/browse/OADP-3184
OADP 1.3
OCP 4.12+
Preview:
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-about-kopia
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-pvs-csi-doc
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-cr
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-hooks-doc
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-deleting-backups-doc
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/release-notes/oadp-release-notes-1-3
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/#control-plane-backup-restore-operations-overview
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications#oadp-creating-restore-cr_restoring-applications
https://69221--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications#oadp-creating-restore-hooks_restoring-applications

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.

sbeskin-redhat · 2024-01-16T17:37:45Z

/label peer-review-needed

kcarmichael08

Hi, I had some minor style/readability suggestions. Otherwise, LGTM!

kcarmichael08 · 2024-01-17T19:12:01Z

...restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc


-You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#backing-up-applications[Scheduling backups].
+You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#oadp-scheduling-backups-doc[Scheduling backups].


Suggested change

You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#oadp-scheduling-backups-doc[Scheduling backups].

You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#oadp-scheduling-backups-doc[Scheduling backups using Schedule CR].

kcarmichael08 · 2024-01-17T19:24:37Z

...up_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-about-kopia.adoc



 [id="oadp-kopia-integration"]
 == OADP integration with Kopia

 OADP 1.3 supports Kopia as the backup mechanism for pod volume backup in addition to Restic. You must choose one or the other at installation by setting the `uploaderType` field in the `DataProtectionApplication` custom resource (CR). The possible values are `restic` or `kopia`. If you do not specify an  `uploaderType`, OADP 1.3 defaults to using Kopia as the backup mechanism. The data is written to and read from a unified repository.

-.`DataProtectionApplication` configuration for Kopia
+.Configuration for Kopia in `DataProtectionApplication`


The example should be introduced (e.g., "The following example shows...")

kcarmichael08 · 2024-01-17T19:33:51Z

..._restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc

@@ -8,7 +8,7 @@ toc::[]

 You restore application backups by creating a `Restore` custom resource (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-cr_restoring-applications[Creating a Restore CR].

-You can create restore hooks to run commands in a container in a pod while restoring your application by editing the `Restore` (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks]
+You can create restore hooks to run commands in a container in a pod by editing the `Restore` (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks]


Suggested change

You can create restore hooks to run commands in a container in a pod by editing the `Restore` (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks]

You can create restore hooks to run commands in a container in a pod by editing the `Restore` (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks].

kcarmichael08 · 2024-01-17T19:37:55Z

modules/oadp-creating-restore-cr.adoc

@@ -66,7 +66,7 @@ $ bash dc-restic-post-restore.sh <restore-name>
 +
 [NOTE]
 ====
-In the course of the restore process, the OADP Velero plug-ins scale down the `DeploymentConfig` objects and restore the pods as standalone pods to prevent the cluster from deleting the restored `DeploymentConfig` pods immediately on restore and to allow Restic and post-restore hooks to complete their actions on the restored pods. The cleanup script removes these disconnected pods and scale any `DeploymentConfig` objects back up to the appropriate number of replicas.
+In the course of the restore process, the OADP Velero plug-ins scale down the `DeploymentConfig` objects and restore the pods as standalone pods. This is done to prevent the cluster from deleting the restored `DeploymentConfig` pods immediately on restore and to allow Restic and post-restore hooks to complete their actions on the restored pods. The cleanup script removes these disconnected pods and scale any `DeploymentConfig` objects back up to the appropriate number of replicas.


Suggested change

In the course of the restore process, the OADP Velero plug-ins scale down the `DeploymentConfig` objects and restore the pods as standalone pods. This is done to prevent the cluster from deleting the restored `DeploymentConfig` pods immediately on restore and to allow Restic and post-restore hooks to complete their actions on the restored pods. The cleanup script removes these disconnected pods and scale any `DeploymentConfig` objects back up to the appropriate number of replicas.

During the restore process, the OADP Velero plug-ins scale down the `DeploymentConfig` objects and restore the pods as standalone pods. This is done to prevent the cluster from deleting the restored `DeploymentConfig` pods immediately on restore and to allow Restic and post-restore hooks to complete their actions on the restored pods. The cleanup script shown in the following example removes these disconnected pods and scales any `DeploymentConfig` objects back up to the appropriate number of replicas.

kcarmichael08 · 2024-01-17T19:44:51Z

PS. Commits will need to be squashed into a single commit before merge review.

openshift-ci · 2024-01-18T14:09:46Z

@sbeskin-redhat: 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.

sbeskin-redhat · 2024-01-18T14:12:37Z

@kcarmichael08
Thank you, I've made the changes.

sbeskin-redhat · 2024-01-18T14:13:13Z

/label merge-review-needed

EricPonvelle · 2024-01-18T15:37:26Z

/cherrypick enterprise-4.12

EricPonvelle · 2024-01-18T15:37:30Z

/cherrypick enterprise-4.13

EricPonvelle · 2024-01-18T15:37:33Z

/cherrypick enterprise-4.14

EricPonvelle · 2024-01-18T15:37:36Z

/cherrypick enterprise-4.15

openshift-cherrypick-robot · 2024-01-18T15:38:13Z

@EricPonvelle: #69221 failed to apply on top of branch "enterprise-4.12":

Applying: MTA-3184
Using index info to reconstruct a base tree...
M	backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
M	backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc
M	backup_and_restore/index.adoc
Falling back to patching base and 3-way merge...
Auto-merging backup_and_restore/index.adoc
Auto-merging backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc
CONFLICT (content): Merge conflict in backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc
Auto-merging backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
CONFLICT (content): Merge conflict in backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 MTA-3184
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.12

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 · 2024-01-18T15:38:15Z

@EricPonvelle: #69221 failed to apply on top of branch "enterprise-4.13":

Applying: MTA-3184
Using index info to reconstruct a base tree...
M	backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
M	backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc
M	backup_and_restore/index.adoc
Falling back to patching base and 3-way merge...
Auto-merging backup_and_restore/index.adoc
Auto-merging backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc
CONFLICT (content): Merge conflict in backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc
Auto-merging backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 MTA-3184
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick 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 · 2024-01-18T15:38:22Z

@EricPonvelle: new pull request created: #70499

In response to this:

/cherrypick 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 · 2024-01-18T15:38:24Z

@EricPonvelle: new pull request created: #70500

In response to this:

/cherrypick 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-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 11, 2023

openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 11, 2023

sbeskin-redhat marked this pull request as draft December 12, 2023 07:14

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 12, 2023

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 19, 2023

openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 19, 2023

sbeskin-redhat force-pushed the OADP_3184 branch from 6ef6804 to 6ec7379 Compare December 19, 2023 17:35

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 19, 2023

sbeskin-redhat force-pushed the OADP_3184 branch from 554b9e3 to 5e4477c Compare January 14, 2024 17:41

sbeskin-redhat marked this pull request as ready for review January 14, 2024 17:45

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 14, 2024

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

bburt-rh added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 15, 2024

bburt-rh added branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jan 15, 2024

bburt-rh added this to the Continuous Release milestone Jan 15, 2024

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

kcarmichael08 added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 17, 2024

kcarmichael08 reviewed Jan 17, 2024

View reviewed changes

kcarmichael08 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jan 17, 2024

MTA-3184

b766448

sbeskin-redhat force-pushed the OADP_3184 branch from b221764 to b766448 Compare January 18, 2024 13:56

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

EricPonvelle 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 Jan 18, 2024

EricPonvelle merged commit 0b834b9 into openshift:main Jan 18, 2024
2 checks passed

openshift-cherrypick-robot mentioned this pull request Jan 18, 2024

[enterprise-4.14] OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #70499

Merged

openshift-cherrypick-robot mentioned this pull request Jan 18, 2024

[enterprise-4.15] OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #70500

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #69221

OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #69221

sbeskin-redhat commented Dec 11, 2023 •

edited

openshift-ci-robot commented Dec 11, 2023 •

edited by openshift-ci bot

openshift-ci bot commented Dec 11, 2023

sbeskin-redhat commented Jan 3, 2024

openshift-ci bot commented Jan 3, 2024

sbeskin-redhat commented Jan 4, 2024

ocpdocs-previewbot commented Jan 14, 2024 •

edited

sbeskin-redhat commented Jan 14, 2024

bburt-rh commented Jan 15, 2024

openshift-ci-robot commented Jan 16, 2024 •

edited by openshift-ci bot

sbeskin-redhat commented Jan 16, 2024

kcarmichael08 left a comment

kcarmichael08 Jan 17, 2024

kcarmichael08 Jan 17, 2024

kcarmichael08 Jan 17, 2024

kcarmichael08 Jan 17, 2024

kcarmichael08 commented Jan 17, 2024

openshift-ci bot commented Jan 18, 2024

sbeskin-redhat commented Jan 18, 2024

sbeskin-redhat commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024


		You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#backing-up-applications[Scheduling backups].
		You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#oadp-scheduling-backups-doc[Scheduling backups].

	You can create restore hooks to run commands in a container in a pod by editing the `Restore` (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks]
	You can create restore hooks to run commands in a container in a pod by editing the `Restore` (CR). See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks].

OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #69221

OADP-3184: [Doc improvements] - OADP backing up & OADP restoring #69221

Conversation

sbeskin-redhat commented Dec 11, 2023 • edited

openshift-ci-robot commented Dec 11, 2023 • edited by openshift-ci bot

openshift-ci bot commented Dec 11, 2023

sbeskin-redhat commented Jan 3, 2024

openshift-ci bot commented Jan 3, 2024

sbeskin-redhat commented Jan 4, 2024

ocpdocs-previewbot commented Jan 14, 2024 • edited

sbeskin-redhat commented Jan 14, 2024

bburt-rh commented Jan 15, 2024

openshift-ci-robot commented Jan 16, 2024 • edited by openshift-ci bot

sbeskin-redhat commented Jan 16, 2024

kcarmichael08 left a comment

Choose a reason for hiding this comment

kcarmichael08 Jan 17, 2024

Choose a reason for hiding this comment

kcarmichael08 Jan 17, 2024

Choose a reason for hiding this comment

kcarmichael08 Jan 17, 2024

Choose a reason for hiding this comment

kcarmichael08 Jan 17, 2024

Choose a reason for hiding this comment

kcarmichael08 commented Jan 17, 2024

openshift-ci bot commented Jan 18, 2024

sbeskin-redhat commented Jan 18, 2024

sbeskin-redhat commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

EricPonvelle commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

openshift-cherrypick-robot commented Jan 18, 2024

sbeskin-redhat commented Dec 11, 2023 •

edited

openshift-ci-robot commented Dec 11, 2023 •

edited by openshift-ci bot

ocpdocs-previewbot commented Jan 14, 2024 •

edited

openshift-ci-robot commented Jan 16, 2024 •

edited by openshift-ci bot