Skip to content

Commit a915b30

Browse files
Merge pull request #67067 from CarmiWisemon/oadp2943backuprewrite
2 parents 31ee517 + ac8beef commit a915b30

File tree

9 files changed

+27
-17
lines changed

9 files changed

+27
-17
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2821,7 +2821,7 @@ Topics:
28212821
File: oadp-creating-backup-cr
28222822
- Name: Backing up persistent volumes with CSI snapshots
28232823
File: oadp-backing-up-pvs-csi-doc
2824-
- Name: Backing up applications with Restic
2824+
- Name: Backing up applications with File System Backup
28252825
File: oadp-backing-up-applications-restic-doc
28262826
- Name: Creating backup hooks
28272827
File: oadp-creating-backup-hooks-doc

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ include::snippets/technology-preview.adoc[]
1818

1919
* If your cloud provider has a native snapshot API or supports CSI snapshots, the `Backup` CR backs up persistent volumes (PVs) by creating snapshots. For more information about working with CSI snapshots, see xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-pvs-csi-doc.adoc#oadp-backing-up-pvs-csi-doc[Backing up persistent volumes with CSI snapshots].
2020
21-
* If your cloud provider does not support snapshots or if your applications are on NFS data volumes, you can create backups by using Restic. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#oadp-backing-up-applications-restic-doc[Backing up applications with Restic].
21+
* If your cloud provider does not support snapshots or if your applications are on NFS data volumes, you can create backups by using Restic. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#oadp-backing-up-applications-restic-doc[Backing up applications with File System Backup: Kopia or Restic].
2222
2323
[IMPORTANT]
2424
====

backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,46 @@
11

2-
:_mod-docs-content-type: PROCEDURE
2+
:_mod-docs-content-type: ASSEMBLY
33
[id="oadp-backing-up-applications-restic-doc"]
4-
= Backing up applications with Restic
4+
= Backing up applications with File System Backup: Kopia or Restic
55
include::_attributes/common-attributes.adoc[]
66
:context: backing-up-applications
77

88
toc::[]
99

10-
If your cloud provider does not support snapshots or if your applications are on NFS data volumes, you can create backups by using Restic.
10+
You can use OADP to back up and restore Kubernetes volumes attached to pods from the file system of the volumes. This process is called File System Backup (FSB) or Pod Volume Backup (PVB) and is accomplished by using modules from the following open source backup tools: Restic and Kopia.
11+
12+
If your cloud provider does not support snapshots or if your applications are on NFS data volumes, you can create backups by using FSB.
1113

1214
[NOTE]
1315
====
14-
link:https://restic.net/[Restic] is installed by the OADP Operator by default.
16+
link:https://restic.net/[Restic] is installed by the OADP Operator by default. If you prefer, you can install link:https://kopia.io/[Kopia] instead.
1517
====
1618

17-
Restic integration with OADP provides a solution for backing up and restoring almost any type of Kubernetes volume. This integration is an addition to OADP’s capabilities, not a replacement for existing functionality.
19+
FSB integration with OADP provides a solution for backing up and restoring almost any type of Kubernetes volume. This integration is an additional capability of OADP and is not a replacement for existing functionality.
1820

19-
You back up Kubernetes resources, internal images, and persistent volumes with Restic by editing the `Backup` custom resource (CR).
21+
You back up Kubernetes resources, internal images, and persistent volumes with Kopia or Restic by editing the `Backup` custom resource (CR).
2022

2123
You do not need to specify a snapshot location in the `DataProtectionApplication` CR.
2224

25+
[NOTE]
26+
====
27+
In OADP version 1.3 and later, you can use either Kopia or Restic for backing up applications.
28+
29+
For the Built-in DataMover you must use Kopia.
30+
31+
In OADP version 1.2 and earlier, you can only use Restic for backing up applications.
32+
====
33+
2334
[IMPORTANT]
2435
====
25-
Restic does not support backing up `hostPath` volumes. For more information, see link:https://{velero-domain}/docs/v{velero-version}/restic/#limitations[additional Restic limitations].
36+
FSB does not support backing up `hostPath` volumes. For more information, see link:https://velero.io/docs/v1.12/file-system-backup/#limitations[FSB limitations].
2637
====
2738

2839
.Prerequisites
2940

3041
* You must install the OpenShift API for Data Protection (OADP) Operator.
31-
* You must not disable the default Restic installation by setting `spec.configuration.restic.enable` to `false` in the `DataProtectionApplication` CR.
42+
* You must not disable the default `nodeAgent` installation by setting `spec.configuration.nodeAgent.enable` to `false` in the `DataProtectionApplication` CR.
43+
* You must select Kopia or Restic as the uploader by setting `spec.configuration.nodeAgent.uploaderType` to `kopia` or `restic` in the `DataProtectionApplication` CR.
3244
* The `DataProtectionApplication` CR must be in a `Ready` state.
3345
3446
.Procedure

backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To back up PVs with snapshots, you must have a cloud provider that supports eith
3434
3535
include::snippets/oadp-ocp-compat.adoc[]
3636

37-
If your cloud provider does not support snapshots or if your storage is NFS, you can back up applications with xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Restic backups] on object storage.
37+
If your cloud provider does not support snapshots or if your storage is NFS, you can back up applications with xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with File System Backup: Kopia or Restic] on object storage.
3838

3939
You create a default `Secret` and then you install the Data Protection Application.
4040

backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ For more information about API group versions, see xref:../../backup_and_restore
2929

3030
For more information about OADP Data Mover, see xref:../../backup_and_restore/application_backup_and_restore/installing/oadp-using-data-mover-for-csi-snapshots-doc.adoc#backing-up-applications[Using Data Mover for CSI snapshots].
3131

32-
For more information about using Restic with OADP, see xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with Restic].
32+
For more information about using Restic with OADP, see xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with File System Backup: Kopia or Restic].
3333

3434
:!oadp-advanced-topics:

backup_and_restore/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ You back up applications by creating a `Backup` custom resource (CR). See xref:.
8080

8181
* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#backing-up-applications[Scheduling backups]
8282

83-
* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Restic backups]
83+
* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with File System Backup: Kopia or Restic]
8484

8585
* You restore application backups by creating a `Restore` (CR). See xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-cr-doc#backing-up-applications[Creating a Restore CR].
8686
* You can configure xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications#oadp-creating-restore-hooks_restoring-applications[restore hooks] to run commands in init containers or in the application container during the restore operation.

modules/oadp-backing-up-applications-restic.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ spec:
3838
defaultVolumesToFsBackup: true <1>
3939
...
4040
----
41-
<1> In OADP version 1.2 and later, add the `defaultVolumesToFsBackup: true` setting within the `spec` block. In OADP version 1.1, add `defaultVolumesToRestic: true`.
41+
<1> In OADP version 1.2 and later, add the `defaultVolumesToFsBackup: true` setting within the `spec` block. In OADP version 1.1, add `defaultVolumesToRestic: true`.

modules/oadp-backing-up-pvs-csi.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77
= Backing up persistent volumes with CSI snapshots
88
:context: backing-up-applications
99

10-
toc::[]
11-
1210
You back up persistent volumes with Container Storage Interface (CSI) snapshots by editing the `VolumeSnapshotClass` custom resource (CR) of the cloud storage before you create the `Backup` CR.
1311

1412
.Prerequisites

virt/backup_restore/virt-backing-up-vms.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `Backup` CR performs the following actions:
1414
* Backs up VM disks by using one of the following options:
1515
1616
** xref:../../virt/backup_restore/virt-backing-up-vms.adoc#oadp-backing-up-pvs-csi_virt-backing-up-vms[Container Storage Interface (CSI) snapshots] on CSI-enabled cloud storage, such as Ceph RBD or Ceph FS.
17-
** xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Restic file system backups] on object storage.
17+
** xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with File System Backup: Kopia or Restic] on object storage.
1818

1919
[NOTE]
2020
====

0 commit comments

Comments
 (0)