openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OADP-6773 Remove unused modules 4.15

Browse Source
This commit is contained in:
Valentina Ashirova
2025-09-29 11:59:19 +02:00
parent 1f146e5be7
commit ea6e5ccf8e
36 changed files with 0 additions and 1921 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
View File

@@ -48,10 +48,6 @@ You can create backup hooks to run commands before or after the backup operation
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].
// include::modules/oadp-creating-backup-cr.adoc[leveloffset=+1]
// include::modules/oadp-backing-up-pvs-csi.adoc[leveloffset=+1]
// include::modules/oadp-backing-up-applications-restic.adoc[leveloffset=+1]
[id="known-issues-backing-up-applications"]
== Known issues

2
backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
View File

@@ -19,7 +19,6 @@ To install the OADP Operator in a restricted network environment, you must first
include::modules/oadp-s3-and-gov-cloud.adoc[leveloffset=+1]
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
include::modules/migration-configuring-aws-s3.adoc[leveloffset=+1]
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]
@@ -47,7 +46,6 @@ For more details, see xref:../../../backup_and_restore/application_backup_and_re
include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
// include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
include::modules/oadp-configuring-aws-md5sum.adoc[leveloffset=+1]

1
backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
View File

@@ -33,7 +33,6 @@ For more details, see xref:../../../backup_and_restore/application_backup_and_re
include::modules/oadp-self-signed-certificate.adoc[leveloffset=+1]
// include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-configuring-client-burst-qps.adoc[leveloffset=+1]
include::modules/oadp-configuring-imagepullpolicy.adoc[leveloffset=+1]

2
backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
View File

@@ -17,7 +17,6 @@ You configure GCP for Velero, create a default `Secret`, and then install the Da
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.
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
include::modules/migration-configuring-gcp.adoc[leveloffset=+1]
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]
@@ -36,7 +35,6 @@ For more details, see xref:../../../backup_and_restore/application_backup_and_re
include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
// include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
include::modules/oadp-gcp-wif-cloud-authentication.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-configuring-client-burst-qps.adoc[leveloffset=+1]

2
backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
View File

@@ -22,7 +22,6 @@ You can create a `Secret` CR for the backup location and install the Data Protec
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. For details, see xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
include::modules/migration-configuring-mcg.adoc[leveloffset=+1]
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]
@@ -41,7 +40,6 @@ For more details, see xref:../../../backup_and_restore/application_backup_and_re
include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
// include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-configuring-client-burst-qps.adoc[leveloffset=+1]
include::modules/oadp-configuring-imagepullpolicy.adoc[leveloffset=+1]

2
backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
View File

@@ -22,7 +22,6 @@ You can create a `Secret` CR for the backup location and install the Data Protec
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. For details, see xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
[role="_additional-resources"]
@@ -46,7 +45,6 @@ For more details, see xref:../../../backup_and_restore/application_backup_and_re
include::modules/oadp-odf-cpu-memory-requirements.adoc[leveloffset=+3]
include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
// include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-configuring-client-burst-qps.adoc[leveloffset=+1]
include::modules/oadp-configuring-imagepullpolicy.adoc[leveloffset=+1]

65
backup_and_restore/application_backup_and_restore/installing/oadp-12-data-mover-ceph-doc.adoc
View File

@@ -1,65 +0,0 @@
:_mod-docs-content-type: ASSEMBLY
[id="oadp-12-data-mover-ceph-doc"]
= Using OADP 1.2 Data Mover with Ceph storage
include::_attributes/common-attributes.adoc[]
:context: backing-up-applications
toc::[]
You can use OADP 1.2 Data Mover to back up and restore application data for clusters that use CephFS, CephRBD, or both.
OADP 1.2 Data Mover leverages Ceph features that support large-scale environments. One of these is the shallow copy method, which is available for {product-title} 4.12 and later. This feature supports backing up and restoring `StorageClass` and `AccessMode` resources other than what is found on the source persistent volume claim (PVC).
[IMPORTANT]
====
The CephFS shallow copy feature is a backup feature. It is not part of restore operations.
====
include::modules/oadp-ceph-prerequisites.adoc[leveloffset=+1]
[id="defining-crs-for-12-data-mover"]
== Defining custom resources for use with OADP 1.2 Data Mover
When you install {rh-storage-first}, it automatically creates default CephFS and a CephRBD `StorageClass` and `VolumeSnapshotClass` custom resources (CRs). You must define these CRs for use with OpenShift API for Data Protection (OADP) 1.2 Data Mover.
After you define the CRs, you must make several other changes to your environment before you can perform your back up and restore operations.
include::modules/oadp-ceph-preparing-cephfs-crs.adoc[leveloffset=+2]
include::modules/oadp-ceph-preparing-cephrbd-crs.adoc[leveloffset=+2]
include::modules/oadp-ceph-preparing-crs-additional.adoc[leveloffset=+2]
[id="oadp-ceph-back-up-restore-cephfs"]
== Backing up and restoring data using OADP 1.2 Data Mover and CephFS storage
You can use OpenShift API for Data Protection (OADP) 1.2 Data Mover to back up and restore data using CephFS storage by enabling the shallow copy feature of CephFS.
include::snippets/oadp-ceph-cr-prerequisites.adoc[]
:context: !backing-up-applications
:context: cephfs
include::modules/oadp-ceph-cephfs-back-up-dba.adoc[leveloffset=+2]
include::modules/oadp-ceph-cephfs-back-up.adoc[leveloffset=+2]
include::modules/oadp-ceph-cephfs-restore.adoc[leveloffset=+2]
[id="oadp-ceph-split"]
== Backing up and restoring data using OADP 1.2 Data Mover and split volumes (CephFS and Ceph RBD)
You can use OpenShift API for Data Protection (OADP) 1.2 Data Mover to backup and restore data in an environment that has _split volumes_, that is, an environment that uses both CephFS and CephRBD.
include::snippets/oadp-ceph-cr-prerequisites.adoc[]
:context: !cephfs
:context: split
include::modules/oadp-ceph-split-back-up-dba.adoc[leveloffset=+2]
include::modules/oadp-ceph-cephfs-back-up.adoc[leveloffset=+2]
include::modules/oadp-ceph-cephfs-restore.adoc[leveloffset=+2]
:context: !split
:context: backing-up-applications
include::modules/oadp-deletion-policy-1-2.adoc[leveloffset=+1]

26
backup_and_restore/application_backup_and_restore/installing/oadp-cleaning-up-after-data-mover-1-1-backup-doc.adoc
View File

@@ -1,26 +0,0 @@
[id="oadp-cleaning-up-after-data-mover-1-1-backup-doc"]
= Cleaning up after a backup using OADP 1.1 Data Mover
include::_attributes/common-attributes.adoc[]
:context: datamover11
toc::[]
For OADP 1.1 Data Mover, you must perform a data cleanup after you perform a backup.
The cleanup consists of deleting the following resources:
* Snapshots in a bucket
* Cluster resources
* Volume snapshot backups (VSBs) after a backup procedure that is either run by a schedule or is run repetitively
include::modules/oadp-cleaning-up-after-data-mover-snapshots.adoc[leveloffset=+1]
[id="deleting-cluster-resources-data-mover"]
== Deleting cluster resources
OADP 1.1 Data Mover might leave cluster resources whether or not it successfully backs up your container storage interface (CSI) volume snapshots to a remote object store.
include::modules/oadp-deleting-cluster-resources-following-success.adoc[leveloffset=+2]
include::modules/oadp-deleting-cluster-resources-following-failure.adoc[leveloffset=+2]
include::modules/oadp-vsb-cleanup-after-scheduler.adoc[leveloffset=+1]

45
modules/migration-combining-must-gather.adoc
View File

@@ -1,45 +0,0 @@
// Module included in the following assemblies:
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
:_mod-docs-content-type: CONCEPT
[id="migration-combining-must-gather_{context}"]
= Combining options when using the must-gather tool
Currently, it is not possible to combine must-gather scripts, for example specifying a timeout threshold while permitting insecure TLS connections. In some situations, you can get around this limitation by setting up internal variables on the must-gather command line, such as the following examples:
* For {oadp-short} 1.3:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-3} -- skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds>
----
* For {oadp-short} 1.4:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} -- skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds>
----
In these examples, set the `skip_tls` variable before running the `gather_with_timeout` script. The result is a combination of `gather_with_timeout` and `gather_without_tls`.
The only other variables that you can specify this way are the following:
* `logs_since`, with a default value of `72h`
* `request_timeout`, with a default value of `0s`
If `DataProtectionApplication` custom resource (CR) is configured with `s3Url` and `insecureSkipTLS: true`, the CR does not collect the necessary logs because of a missing CA certificate. To collect those logs, run the `must-gather` command with the following option:
* For {oadp-short} 1.3:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-3} -- /usr/bin/gather_without_tls true
----
* For {oadp-short} 1.4:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather_without_tls true
----

24
modules/migration-creating-ca-bundle.adoc
View File

@@ -1,24 +0,0 @@
// Module included in the following assemblies:
//
// * migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc
// * migration_toolkit_for_containers/migrating-applications-with-mtc
:_mod-docs-content-type: PROCEDURE
[id="creating-ca-bundle_{context}"]
= Creating a CA certificate bundle file for self-signed certificates
If you use a self-signed certificate to secure a cluster or a replication repository for the {mtc-first}, certificate verification might fail with the following error message: `Certificate signed by unknown authority`.
You can create a custom CA certificate bundle file and upload it in the {mtc-short} web console when you add a cluster or a replication repository.
.Procedure
Download a CA certificate from a remote endpoint and save it as a CA bundle file:
[source,terminal]
----
$ echo -n | openssl s_client -connect <host_FQDN>:<port> \ <1>
| sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > <ca_bundle.cert> <2>
----
<1> Specify the host FQDN and port of the endpoint, for example, `api.my-cluster.example.com:6443`.
<2> Specify the name of the CA bundle file.

41
modules/oadp-backing-up-applications-restic.adoc
View File

@@ -1,41 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-backing-up-applications-restic_{context}"]
= Backing up applications with Restic
You back up Kubernetes resources, internal images, and persistent volumes with Restic by editing the `Backup` custom resource (CR).
You do not need to specify a snapshot location in the `DataProtectionApplication` CR.
[IMPORTANT]
====
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].
====
.Prerequisites
* You must install the OpenShift API for Data Protection (OADP) Operator.
* You must not disable the default Restic installation by setting `spec.configuration.restic.enable` to `false` in the `DataProtectionApplication` CR.
* The `DataProtectionApplication` CR must be in a `Ready` state.
.Procedure
* Edit the `Backup` CR, as in the following example:
+
[source,yaml]
----
apiVersion: velero.io/v1
kind: Backup
metadata:
name: <backup>
labels:
velero.io/storage-location: default
namespace: openshift-adp
spec:
defaultVolumesToFsBackup: true <1>
...
----
<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`.

20
modules/oadp-backing-up-dpa-configuration-1-2-0.adoc
View File

@@ -1,20 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/oadp-release-notes-1-2.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-backing-up-dpa-configuration-1-2-0_{context}"]
= Backing up the DPA configuration
You must back up your current `DataProtectionApplication` (DPA) configuration.
.Procedure
* Save your current DPA configuration by running the following command:
+
.Example
[source,terminal]
----
$ oc get dpa -n openshift-adp -o yaml > dpa.orig.backup
----

41
modules/oadp-backing-up-pvs-csi.adoc
View File

@@ -1,41 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-backing-up-pvs-csi_{context}"]
= Backing up persistent volumes with CSI snapshots
:context: backing-up-applications
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.
.Prerequisites
* The cloud provider must support CSI snapshots.
* You must enable CSI in the `DataProtectionApplication` CR.
.Procedure
* Add the `metadata.labels.velero.io/csi-volumesnapshot-class: "true"` key-value pair to the `VolumeSnapshotClass` CR:
+
.Example configuration file
[source,yaml,subs="attributes+"]
----
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
name: <volume_snapshot_class_name>
labels:
velero.io/csi-volumesnapshot-class: "true" <1>
annotations:
snapshot.storage.kubernetes.io/is-default-class: true <2>
driver: <csi_driver>
deletionPolicy: <deletion_policy_type> <3>
----
<1> Must be set to `true`.
<2> Must be set to `true`.
<3> OADP supports the `Retain` and `Delete` deletion policy types for CSI and Data Mover backup and restore. For the OADP 1.2 Data Mover, set the deletion policy type to `Retain`.
.Next steps
* You can now create a `Backup` CR.

83
modules/oadp-ceph-cephfs-back-up-dba.adoc
View File

@@ -1,83 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-cephfs-back-up-dba_{context}"]
= Creating a DPA for use with CephFS storage
You must create a Data Protection Application (DPA) CR before you use the OpenShift API for Data Protection (OADP) 1.2 Data Mover to back up and restore data using CephFS storage.
.Procedure
. For the OADP 1.2 Data Mover, you must verify that the `deletionPolicy` field of the `VolumeSnapshotClass` CR is set to `Retain` by running the following command:
+
[source,terminal]
----
$ oc get volumesnapshotclass -A -o jsonpath='{range .items[*]}{"Name: "}{.metadata.name}{" "}{"Retention Policy: "}{.deletionPolicy}{"\n"}{end}'
----
. Verify that the labels of the `VolumeSnapshotClass` CR are set to `true` by running the following command:
+
[source,terminal]
----
$ oc get volumesnapshotclass -A -o jsonpath='{range .items[*]}{"Name: "}{.metadata.name}{" "}{"labels: "}{.metadata.labels}{"\n"}{end}'
----
. Verify that the `storageclass.kubernetes.io/is-default-class` annotation of the `StorageClass` CR is set to `true` by running the following command:
+
[source,terminal]
----
$ oc get storageClass -A -o jsonpath='{range .items[*]}{"Name: "}{.metadata.name}{" "}{"annotations: "}{.metadata.annotations}{"\n"}{end}'
----
. Create a Data Protection Application (DPA) CR similar to the following example:
+
.Example DPA CR
+
[source,yaml]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: velero-sample
namespace: openshift-adp
spec:
backupLocations:
- velero:
config:
profile: default
region: us-east-1
credential:
key: cloud
name: cloud-credentials
default: true
objectStorage:
bucket: <my_bucket>
prefix: velero
provider: aws
configuration:
restic:
enable: false # <1>
velero:
defaultPlugins:
- openshift
- aws
- csi
- vsm
features:
dataMover:
credentialName: <restic_secret_name> # <2>
enable: true # <3>
volumeOptionsForStorageClasses: # <4>
ocs-storagecluster-cephfs:
sourceVolumeOptions:
accessMode: ReadOnlyMany
cacheAccessMode: ReadWriteMany
cacheStorageClassName: ocs-storagecluster-cephfs
storageClassName: ocs-storagecluster-cephfs-shallow
----
<1> There is no default value for the `enable` field. Valid values are `true` or `false`.
<2> Use the Restic `Secret` that you created when you prepared your environment for working with OADP 1.2 Data Mover and Ceph. If you do not use your Restic `Secret`, the CR uses the default value `dm-credential` for this parameter.
<3> There is no default value for the `enable` field. Valid values are `true` or `false`.
<4> Optional parameter. You can define a different set of `VolumeOptionsForStorageClass` labels for each `storageClass` volume. This configuration provides a backup for volumes with different providers. The optional `VolumeOptionsForStorageClass` parameter is typically used with CephFS but can be used for any storage type.

67
modules/oadp-ceph-cephfs-back-up.adoc
View File

@@ -1,67 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
ifeval::["{context}" == "cephfs"]
:cephfs:
endif::[]
ifeval::["{context}" == "split"]
:split:
endif::[]
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-cephfs-back-up_{context}"]
ifdef::cephfs[]
= Backing up data using OADP 1.2 Data Mover and CephFS storage
You can use OpenShift API for Data Protection (OADP) 1.2 Data Mover to back up data using CephFS storage by enabling the shallow copy feature of CephFS storage.
endif::cephfs[]
ifdef::split[]
= Backing up data using OADP 1.2 Data Mover and split volumes
You can use OpenShift API for Data Protection (OADP) 1.2 Data Mover to back up data in an environment that has split volumes.
endif::split[]
.Procedure
. Create a `Backup` CR as in the following example:
+
.Example `Backup` CR
+
[source,yaml]
----
apiVersion: velero.io/v1
kind: Backup
metadata:
name: <backup_name>
namespace: <protected_ns>
spec:
includedNamespaces:
- <app_ns>
storageLocation: velero-sample-1
----
. Monitor the progress of the `VolumeSnapshotBackup` CRs by completing the following steps:
.. To check the progress of all the `VolumeSnapshotBackup` CRs, run the following command:
+
[source,terminal]
----
$ oc get vsb -n <app_ns>
----
.. To check the progress of a specific `VolumeSnapshotBackup` CR, run the following command:
+
[source,terminal]
----
$ oc get vsb <vsb_name> -n <app_ns> -ojsonpath="{.status.phase}`
----
. Wait several minutes until the `VolumeSnapshotBackup` CR has the status `Completed`.
. Verify that there is at least one snapshot in the object store that is given in the Restic `Secret`. You can check for this snapshot in your targeted `BackupStorageLocation` storage provider that has a prefix of `/<OADP_namespace>`.
ifeval::["{context}" == "cephfs"]
:!cephfs:
endif::[]
ifeval::["{context}" == "split"]
:!split:
endif::[]

83
modules/oadp-ceph-cephfs-restore.adoc
View File

@@ -1,83 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
ifeval::["{context}" == "cephfs"]
:cephfs:
endif::[]
ifeval::["{context}" == "split"]
:split:
endif::[]
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-cephfs-restore_{context}"]
ifdef::cephfs[]
= Restoring data using OADP 1.2 Data Mover and CephFS storage
You can use OpenShift API for Data Protection (OADP) 1.2 Data Mover to restore data using CephFS storage if the shallow copy feature of CephFS storage was enabled for the back up procedure. The shallow copy feature is not used in the restore procedure.
endif::cephfs[]
ifdef::split[]
= Restoring data using OADP 1.2 Data Mover and split volumes
You can use OpenShift API for Data Protection (OADP) 1.2 Data Mover to restore data in an environment that has split volumes, if the shallow copy feature of CephFS storage was enabled for the back up procedure. The shallow copy feature is not used in the restore procedure.
endif::split[]
.Procedure
. Delete the application namespace by running the following command:
+
[source,terminal]
----
$ oc delete vsb -n <app_namespace> --all
----
. Delete any `VolumeSnapshotContent` CRs that were created during backup by running the following command:
+
[source,terminal]
----
$ oc delete volumesnapshotcontent --all
----
. Create a `Restore` CR as in the following example:
+
.Example `Restore` CR
+
[source,yaml]
----
apiVersion: velero.io/v1
kind: Restore
metadata:
name: <restore_name>
namespace: <protected_ns>
spec:
backupName: <previous_backup_name>
----
. Monitor the progress of the `VolumeSnapshotRestore` CRs by doing the following:
.. To check the progress of all the `VolumeSnapshotRestore` CRs, run the following command:
+
[source,terminal]
----
$ oc get vsr -n <app_ns>
----
.. To check the progress of a specific `VolumeSnapshotRestore` CR, run the following command:
+
[source,terminal]
----
$ oc get vsr <vsr_name> -n <app_ns> -ojsonpath="{.status.phase}
----
. Verify that your application data has been restored by running the following command:
+
[source,terminal]
----
$ oc get route <route_name> -n <app_ns> -ojsonpath="{.spec.host}"
----
ifeval::["{context}" == "cephfs"]
:!cephfs:
endif::[]
ifeval::["{context}" == "split"]
:!split:
endif::[]

65
modules/oadp-ceph-preparing-cephfs-crs.adoc
View File

@@ -1,65 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-preparing-cephfs-crs_{context}"]
= Defining CephFS custom resources for use with OADP 1.2 Data Mover
When you install {rh-storage-first}, it automatically creates a default CephFS `StorageClass` custom resource (CR) and a default CephFS `VolumeSnapshotClass` CR. You can define these CRs for use with OpenShift API for Data Protection (OADP) 1.2 Data Mover.
.Procedure
. Define the `VolumeSnapshotClass` CR as in the following example:
+
.Example `VolumeSnapshotClass` CR
+
[source,yaml]
----
apiVersion: snapshot.storage.k8s.io/v1
deletionPolicy: <deletion_policy_type> <1>
driver: openshift-storage.cephfs.csi.ceph.com
kind: VolumeSnapshotClass
metadata:
annotations:
snapshot.storage.kubernetes.io/is-default-class: true <2>
labels:
velero.io/csi-volumesnapshot-class: true <3>
name: ocs-storagecluster-cephfsplugin-snapclass
parameters:
clusterID: openshift-storage
csi.storage.k8s.io/snapshotter-secret-name: rook-csi-cephfs-provisioner
csi.storage.k8s.io/snapshotter-secret-namespace: openshift-storage
----
<1> OADP supports the `Retain` and `Delete` deletion policy types for CSI and Data Mover backup and restore. For the OADP 1.2 Data Mover, set the deletion policy type to `Retain`.
<2> Must be set to `true`.
<3> Must be set to `true`.
. Define the `StorageClass` CR as in the following example:
+
.Example `StorageClass` CR
+
[source,yaml]
----
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: ocs-storagecluster-cephfs
annotations:
description: Provides RWO and RWX Filesystem volumes
storageclass.kubernetes.io/is-default-class: true <1>
provisioner: openshift-storage.cephfs.csi.ceph.com
parameters:
clusterID: openshift-storage
csi.storage.k8s.io/controller-expand-secret-name: rook-csi-cephfs-provisioner
csi.storage.k8s.io/controller-expand-secret-namespace: openshift-storage
csi.storage.k8s.io/node-stage-secret-name: rook-csi-cephfs-node
csi.storage.k8s.io/node-stage-secret-namespace: openshift-storage
csi.storage.k8s.io/provisioner-secret-name: rook-csi-cephfs-provisioner
csi.storage.k8s.io/provisioner-secret-namespace: openshift-storage
fsName: ocs-storagecluster-cephfilesystem
reclaimPolicy: Delete
allowVolumeExpansion: true
volumeBindingMode: Immediate
----
<1> Must be set to `true`.

63
modules/oadp-ceph-preparing-cephrbd-crs.adoc
View File

@@ -1,63 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-preparing-cephrbd-crs_{context}"]
= Defining CephRBD custom resources for use with OADP 1.2 Data Mover
When you install {rh-storage-first}, it automatically creates a default CephRBD `StorageClass` custom resource (CR) and a default CephRBD `VolumeSnapshotClass` CR. You can define these CRs for use with OpenShift API for Data Protection (OADP) 1.2 Data Mover.
.Procedure
. Define the `VolumeSnapshotClass` CR as in the following example:
+
.Example `VolumeSnapshotClass` CR
+
[source,yaml]
----
apiVersion: snapshot.storage.k8s.io/v1
deletionPolicy: <deletion_policy_type> <1>
driver: openshift-storage.rbd.csi.ceph.com
kind: VolumeSnapshotClass
metadata:
labels:
velero.io/csi-volumesnapshot-class: true <2>
name: ocs-storagecluster-rbdplugin-snapclass
parameters:
clusterID: openshift-storage
csi.storage.k8s.io/snapshotter-secret-name: rook-csi-rbd-provisioner
csi.storage.k8s.io/snapshotter-secret-namespace: openshift-storage
----
<1> OADP supports the `Retain` and `Delete` deletion policy types for CSI and Data Mover backup and restore. For the OADP 1.2 Data Mover, set the deletion policy type to `Retain`.
<2> Must be set to `true`.
. Define the `StorageClass` CR as in the following example:
+
.Example `StorageClass` CR
+
[source,yaml]
----
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: ocs-storagecluster-ceph-rbd
annotations:
description: 'Provides RWO Filesystem volumes, and RWO and RWX Block volumes'
provisioner: openshift-storage.rbd.csi.ceph.com
parameters:
csi.storage.k8s.io/fstype: ext4
csi.storage.k8s.io/provisioner-secret-namespace: openshift-storage
csi.storage.k8s.io/provisioner-secret-name: rook-csi-rbd-provisioner
csi.storage.k8s.io/node-stage-secret-name: rook-csi-rbd-node
csi.storage.k8s.io/controller-expand-secret-name: rook-csi-rbd-provisioner
imageFormat: '2'
clusterID: openshift-storage
imageFeatures: layering
csi.storage.k8s.io/controller-expand-secret-namespace: openshift-storage
pool: ocs-storagecluster-cephblockpool
csi.storage.k8s.io/node-stage-secret-namespace: openshift-storage
reclaimPolicy: Delete
allowVolumeExpansion: true
volumeBindingMode: Immediate
----

65
modules/oadp-ceph-preparing-crs-additional.adoc
View File

@@ -1,65 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-preparing-crs-additional_{context}"]
= Defining additional custom resources for use with OADP 1.2 Data Mover
After you redefine the default `StorageClass` and CephRBD `VolumeSnapshotClass` custom resources (CRs), you must create the following CRs:
* A CephFS `StorageClass` CR defined to use the shallow copy feature
* A Restic `Secret` CR
.Procedure
. Create a CephFS `StorageClass` CR and set the `backingSnapshot` parameter set to `true` as in the following example:
+
.Example CephFS `StorageClass` CR with `backingSnapshot` set to `true`
+
[source, yaml]
----
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: ocs-storagecluster-cephfs-shallow
annotations:
description: Provides RWO and RWX Filesystem volumes
storageclass.kubernetes.io/is-default-class: false
provisioner: openshift-storage.cephfs.csi.ceph.com
parameters:
csi.storage.k8s.io/provisioner-secret-namespace: openshift-storage
csi.storage.k8s.io/provisioner-secret-name: rook-csi-cephfs-provisioner
csi.storage.k8s.io/node-stage-secret-name: rook-csi-cephfs-node
csi.storage.k8s.io/controller-expand-secret-name: rook-csi-cephfs-provisioner
clusterID: openshift-storage
fsName: ocs-storagecluster-cephfilesystem
csi.storage.k8s.io/controller-expand-secret-namespace: openshift-storage
backingSnapshot: true <1>
csi.storage.k8s.io/node-stage-secret-namespace: openshift-storage
reclaimPolicy: Delete
allowVolumeExpansion: true
volumeBindingMode: Immediate
----
<1> Must be set to `true`.
+
[IMPORTANT]
====
Ensure that the CephFS `VolumeSnapshotClass` and `StorageClass` CRs have the same value for `provisioner`.
====
. Configure a Restic `Secret` CR as in the following example:
+
.Example Restic `Secret` CR
+
[source,yaml]
----
apiVersion: v1
kind: Secret
metadata:
name: <secret_name>
namespace: <namespace>
type: Opaque
stringData:
RESTIC_PASSWORD: <restic_password>
----

16
modules/oadp-ceph-prerequisites.adoc
View File

@@ -1,16 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: CONCEPT
[id="oadp-ceph-prerequisites_{context}"]
= Prerequisites for using OADP 1.2 Data Mover with Ceph storage
The following prerequisites apply to all back up and restore operations of data using {oadp-first} 1.2 Data Mover in a cluster that uses Ceph storage:
* You have installed {product-title} 4.12 or later.
* You have installed the OADP Operator.
* You have created a secret `cloud-credentials` in the namespace `openshift-adp.`
* You have installed {rh-storage-first}.
* You have installed the latest VolSync Operator by using Operator Lifecycle Manager.

67
modules/oadp-ceph-split-back-up-dba.adoc
View File

@@ -1,67 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-ceph-split-back-up-dba_{context}"]
= Creating a DPA for use with split volumes
You must create a Data Protection Application (DPA) CR before you use the OpenShift API for Data Protection (OADP) 1.2 Data Mover to back up and restore data using split volumes.
.Procedure
* Create a Data Protection Application (DPA) CR as in the following example:
+
.Example DPA CR for environment with split volumes
[source,yaml]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: velero-sample
namespace: openshift-adp
spec:
backupLocations:
- velero:
config:
profile: default
region: us-east-1
credential:
key: cloud
name: cloud-credentials
default: true
objectStorage:
bucket: <my-bucket>
prefix: velero
provider: aws
configuration:
restic:
enable: false
velero:
defaultPlugins:
- openshift
- aws
- csi
- vsm
features:
dataMover:
credentialName: <restic_secret_name> # <1>
enable: true
volumeOptionsForStorageClasses: # <2>
ocs-storagecluster-cephfs:
sourceVolumeOptions:
accessMode: ReadOnlyMany
cacheAccessMode: ReadWriteMany
cacheStorageClassName: ocs-storagecluster-cephfs
storageClassName: ocs-storagecluster-cephfs-shallow
ocs-storagecluster-ceph-rbd:
sourceVolumeOptions:
storageClassName: ocs-storagecluster-ceph-rbd
cacheStorageClassName: ocs-storagecluster-ceph-rbd
destinationVolumeOptions:
storageClassName: ocs-storagecluster-ceph-rbd
cacheStorageClassName: ocs-storagecluster-ceph-rbd
----
<1> Use the Restic `Secret` that you created when you prepared your environment for working with OADP 1.2 Data Mover and Ceph. If you do not, then the CR will use the default value `dm-credential` for this parameter.
<2> A different set of `VolumeOptionsForStorageClass` labels can be defined for each `storageClass` volume, thus allowing a backup to volumes with different providers. The `VolumeOptionsForStorageClass` parameter is meant for use with CephFS. However, the optional `VolumeOptionsForStorageClass` parameter could be used for any storage type.

16
modules/oadp-cleaning-up-after-data-mover-snapshots.adoc
View File

@@ -1,16 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-cleaning-up-after-data-mover-snapshots_{context}"]
= Deleting snapshots in a bucket
OADP 1.1 Data Mover might leave one or more snapshots in a bucket after a backup. You can either delete all the snapshots or delete individual snapshots.
.Procedure
* To delete all snapshots in your bucket, delete the `/<protected_namespace>` folder that is specified in the Data Protection Application (DPA) `.spec.backupLocation.objectStorage.bucket` resource.
* To delete an individual snapshot:
. Browse to the `/<protected_namespace>` folder that is specified in the DPA `.spec.backupLocation.objectStorage.bucket` resource.
. Delete the appropriate folders that are prefixed with `/<volumeSnapshotContent name>-pvc` where `<VolumeSnapshotContent_name>` is the `VolumeSnapshotContent` created by Data Mover per PVC.

56
modules/oadp-converting-to-new-dpa-1-2-0.adoc
View File

@@ -1,56 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/oadp-release-notes-1-2.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-converting-to-new-dpa-1-2-0_{context}"]
= Converting DPA to the new version
If you use the fields that were updated in the `spec.configuration.velero.args` stanza, you must configure your `DataProtectionApplication` (DPA) manifest to use the new parameter names.
.Procedure
. Click *Operators* → *Installed Operators* and select the OADP Operator.
. Select *Provided APIs*, click *Create instance* in the *DataProtectionApplication* box.
. Click *YAML View* to display the current DPA parameters.
+
.Example current DPA
[source,yaml]
----
spec:
configuration:
velero:
args:
default-volumes-to-fs-backup: true
default-restic-prune-frequency: 6000
fs-backup-timeout: 600
# ...
----
. Update the DPA parameters:
. Update the DPA parameter names without changing their values:
.. Change the `default-volumes-to-restic` key to `default-volumes-to-fs-backup`.
.. Change the `default-restic-prune-frequency` key to `default-repo-maintain-frequency`.
.. Change the `restic-timeout` key to `fs-backup-timeout`.
+
.Example updated DPA
[source,yaml]
----
spec:
configuration:
velero:
args:
default-volumes-to-fs-backup: true
default-repo-maintain-frequency: 6000
fs-backup-timeout: 600
# ...
----
. Wait for the DPA to reconcile successfully.
[NOTE]
====
The default timeout value for the Restic file system backup is one hour. In OADP 1.3.1 and later, the default timeout value for Restic and Kopia is four hours.
====

83
modules/oadp-creating-backup-cr.adoc
View File

@@ -1,83 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-creating-backup-cr_{context}"]
= Creating a Backup CR
To back up Kubernetes resources, internal images, and persistent volumes (PVs), create a Backup custom resource (CR).
.Prerequisites
* You must install the OpenShift API for Data Protection (OADP) Operator.
* The `DataProtectionApplication` CR must be in a `Ready` state.
* Backup location prerequisites:
** You must have S3 object storage configured for Velero.
** You must have a backup location configured in the `DataProtectionApplication` CR.
* Snapshot location prerequisites:
** Your cloud provider must have a native snapshot API or support Container Storage Interface (CSI) snapshots.
** For CSI snapshots, you must create a `VolumeSnapshotClass` CR to register the CSI driver.
** You must have a volume location configured in the `DataProtectionApplication` CR.
.Procedure
. Retrieve the `backupStorageLocations` CRs by entering the following command:
+
[source,terminal]
----
$ oc get backupstoragelocations.velero.io -n openshift-adp
----
+
.Example output
+
[source,terminal]
----
NAMESPACE NAME PHASE LAST VALIDATED AGE DEFAULT
openshift-adp velero-sample-1 Available 11s 31m
----
. Create a `Backup` CR, as in the following example:
+
[source,yaml]
----
apiVersion: velero.io/v1
kind: Backup
metadata:
name: <backup>
labels:
velero.io/storage-location: default
namespace: openshift-adp
spec:
hooks: {}
includedNamespaces:
- <namespace> <1>
includedResources: [] <2>
excludedResources: [] <3>
storageLocation: <velero-sample-1> <4>
ttl: 720h0m0s
labelSelector: <5>
matchLabels:
app=<label_1>
app=<label_2>
app=<label_3>
orLabelSelectors: <6>
- matchLabels:
app=<label_1>
app=<label_2>
app=<label_3>
----
<1> Specify an array of namespaces to back up.
<2> Optional: Specify an array of resources to include in the backup. Resources might be shortcuts (for example, 'po' for 'pods') or fully-qualified. If unspecified, all resources are included.
<3> Optional: Specify an array of resources to exclude from the backup. Resources might be shortcuts (for example, 'po' for 'pods') or fully-qualified.
<4> Specify the name of the `backupStorageLocations` CR.
<5> Map of {key,value} pairs of backup resources that have *all* of the specified labels.
<6> Map of {key,value} pairs of backup resources that have *one or more* of the specified labels.
. Verify that the status of the `Backup` CR is `Completed`:
+
[source,terminal]
----
$ oc get backups.velero.io -n openshift-adp <backup> -o jsonpath='{.status.phase}'
----

60
modules/oadp-creating-backup-hooks.adoc
View File

@@ -1,60 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-creating-backup-hooks_{context}"]
= Creating backup hooks
You create backup hooks to run commands in a container in a pod by editing the `Backup` custom resource (CR).
_Pre_ hooks run before the pod is backed up. _Post_ hooks run after the backup.
.Procedure
* Add a hook to the `spec.hooks` block of the `Backup` CR, as in the following example:
+
[source,yaml]
----
apiVersion: velero.io/v1
kind: Backup
metadata:
name: <backup>
namespace: openshift-adp
spec:
hooks:
resources:
- name: <hook_name>
includedNamespaces:
- <namespace> <1>
excludedNamespaces: <2>
- <namespace>
includedResources:
- pods <3>
excludedResources: [] <4>
labelSelector: <5>
matchLabels:
app: velero
component: server
pre: <6>
- exec:
container: <container> <7>
command:
- /bin/uname <8>
- -a
onError: Fail <9>
timeout: 30s <10>
post: <11>
...
----
<1> Optional: You can specify namespaces to which the hook applies. If this value is not specified, the hook applies to all namespaces.
<2> Optional: You can specify namespaces to which the hook does not apply.
<3> Currently, pods are the only supported resource that hooks can apply to.
<4> Optional: You can specify resources to which the hook does not apply.
<5> Optional: This hook only applies to objects matching the label. If this value is not specified, the hook applies to all namespaces.
<6> Array of hooks to run before the backup.
<7> Optional: If the container is not specified, the command runs in the first container in the pod.
<8> This is the entrypoint for the init container being added.
<9> Allowed values for error handling are `Fail` and `Continue`. The default is `Fail`.
<10> Optional: How long to wait for the commands to run. The default is `30s`.
<11> This block defines an array of hooks to run after the backup, with the same parameters as the pre-backup hooks.

78
modules/oadp-deleting-cluster-resources-following-failure.adoc
View File

@@ -1,78 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-deleting-cluster-resources-following-failure_{context}"]
= Deleting cluster resources following a partially successful or a failed backup and restore that used Data Mover
If your backup and restore operation that uses Data Mover either fails or only partially succeeds, you must clean up any `VolumeSnapshotBackup` (VSB) or `VolumeSnapshotRestore` custom resource definitions (CRDs) that exist in the application namespace, and clean up any extra resources created by these controllers.
.Procedure
. Clean up cluster resources that remain after a backup operation where you used Data Mover by entering the following commands:
.. Delete VSB CRDs on the application namespace, the namespace with the application PVCs to backup and restore:
+
[source,terminal]
----
$ oc delete vsb -n <app_namespace> --all
----
.. Delete `VolumeSnapshot` CRs:
+
[source,terminal]
----
$ oc delete volumesnapshot -A --all
----
.. Delete `VolumeSnapshotContent` CRs:
+
[source,terminal]
----
$ oc delete volumesnapshotcontent --all
----
.. Delete any PVCs on the protected namespace, the namespace the Operator is installed on.
+
[source,terminal]
----
$ oc delete pvc -n <protected_namespace> --all
----
.. Delete any `ReplicationSource` resources on the namespace.
+
[source,terminal]
----
$ oc delete replicationsource -n <protected_namespace> --all
----
. Clean up cluster resources that remain after a restore operation using Data Mover by entering the following commands:
.. Delete VSR CRDs:
+
[source,terminal]
----
$ oc delete vsr -n <app-ns> --all
----
.. Delete `VolumeSnapshot` CRs:
+
[source,terminal]
----
$ oc delete volumesnapshot -A --all
----
.. Delete `VolumeSnapshotContent` CRs:
+
[source,terminal]
----
$ oc delete volumesnapshotcontent --all
----
.. Delete any `ReplicationDestination` resources on the namespace.
+
[source,terminal]
----
$ oc delete replicationdestination -n <protected_namespace> --all
----

32
modules/oadp-deleting-cluster-resources-following-success.adoc
View File

@@ -1,32 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-deleting-cluster-resources-following-success_{context}"]
= Deleting cluster resources following a successful backup and restore that used Data Mover
You can delete any `VolumeSnapshotBackup` or `VolumeSnapshotRestore` CRs that remain in your application namespace after a successful backup and restore where you used Data Mover.
.Procedure
. Delete cluster resources that remain on the application namespace, the namespace with the application PVCs to backup and restore, after a backup where you use Data Mover:
+
[source,terminal]
----
$ oc delete vsb -n <app_namespace> --all
----
. Delete cluster resources that remain after a restore where you use Data Mover:
+
[source,terminal]
----
$ oc delete vsr -n <app_namespace> --all
----
. If needed, delete any `VolumeSnapshotContent` resources that remain after a backup and restore where you use Data Mover:
+
[source,terminal]
----
$ oc delete volumesnapshotcontent --all
----

23
modules/oadp-deletion-policy-1-2.adoc
View File

@@ -1,23 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: CONCEPT
[id="oadp-deletion-policy-1-2_{context}"]
= Deletion policy for OADP 1.2
The deletion policy determines rules for removing data from a system, specifying when and how deletion occurs based on factors such as retention periods, data sensitivity, and compliance requirements. It manages data removal effectively while meeting regulations and preserving valuable information.
[id="oadp-deletion-policy-guidelines-1-2_{context}"]
== Deletion policy guidelines for OADP 1.2
Review the following deletion policy guidelines for the OADP 1.2:
* To use OADP 1.2.x Data Mover to backup and restore, set the `deletionPolicy` field to `Retain` in the `VolumeSnapshotClass` custom resource (CR).
* In OADP 1.2.x, to use CSI backup and restore, you can set the `deletionPolicy` field to either `Retain` or `Delete` in the `VolumeSnapshotClass` CR.
[IMPORTANT]
====
OADP 1.2.x Data Mover to backup and restore is a Technology Preview feature and is not supported without a support exception.
====

381
modules/oadp-installing-dpa-1-2-and-earlier.adoc
View File

@@ -1,381 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-installing-dpa-1-2-and-earlier_{context}"]
= Installing the Data Protection Application 1.2 and earlier
You install the Data Protection Application (DPA) by creating an instance of the `DataProtectionApplication` API.
.Prerequisites
* You must install the OADP Operator.
* You must configure object storage as a backup location.
* If you use snapshots to back up PVs, your cloud provider must support either a native snapshot API or Container Storage Interface (CSI) snapshots.
* If the backup and snapshot locations use the same credentials, you must create a `Secret` with the default name, `{credentials}`.
ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs[]
* If the backup and snapshot locations use different credentials, you must create two `Secrets`:
** `Secret` with a custom name for the backup location. You add this `Secret` to the `DataProtectionApplication` CR.
** `Secret` with another custom name for the snapshot location. You add this `Secret` to the `DataProtectionApplication` CR.
endif::[]
ifdef::installing-oadp-aws[]
* If the backup and snapshot locations use different credentials, you must create a `Secret` with the default name, `{credentials}`, which contains separate profiles for the backup and snapshot location credentials.
endif::[]
+
[NOTE]
====
If you do not want to specify backup or snapshot locations during the installation, you can create a default `Secret` with an empty `credentials-velero` file. If there is no default `Secret`, the installation will fail.
====
+
[NOTE]
====
Velero creates a secret named `velero-repo-credentials` in the OADP namespace, which contains a default backup repository password.
You can update the secret with your own password encoded as base64 *before* you run your first backup targeted to the backup repository. The value of the key to update is `Data[repository-password]`.
After you create your DPA, the first time that you run a backup targeted to the backup repository, Velero creates a backup repository whose secret is `velero-repo-credentials`, which contains either the default password or the one you replaced it with.
If you update the secret password *after* the first backup, the new password will not match the password in `velero-repo-credentials`, and therefore, Velero will not be able to connect with the older backups.
====
.Procedure
. Click *Operators* -> *Installed Operators* and select the OADP Operator.
. Under *Provided APIs*, click *Create instance* in the *DataProtectionApplication* box.
. Click *YAML View* and update the parameters of the `DataProtectionApplication` manifest:
ifdef::installing-oadp-aws[]
+
[source,yaml,subs="attributes+"]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: <dpa_sample>
namespace: openshift-adp
spec:
configuration:
velero:
defaultPlugins:
- openshift # <1>
- aws
resourceTimeout: 10m # <2>
restic:
enable: true # <3>
podConfig:
nodeSelector: <node_selector> # <4>
backupLocations:
- name: default
velero:
provider: {provider}
default: true
objectStorage:
bucket: <bucket_name> # <5>
prefix: <prefix> # <6>
config:
region: <region>
profile: "default"
s3ForcePathStyle: "true" # <7>
s3Url: <s3_url> # <8>
credential:
key: cloud
name: {credentials} # <9>
snapshotLocations: # <10>
- velero:
provider: {provider}
config:
region: <region> # <11>
profile: "default"
credential:
key: cloud
name: {credentials} # <12>
----
<1> The `openshift` plugin is mandatory.
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
<3> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
<5> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<6> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
<7> Specify whether to force path style URLs for S3 objects (Boolean). Not Required for AWS S3. Required only for S3 compatible storage.
<8> Specify the URL of the object store that you are using to store backups. Not required for AWS S3. Required only for S3 compatible storage.
<9> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
<10> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
<11> The snapshot location must be in the same region as the PVs.
<12> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the snapshot location. If your backup and snapshot locations use different credentials, create separate profiles in the `credentials-velero` file.
endif::[]
ifdef::installing-oadp-azure[]
+
[source,yaml,subs="attributes+"]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: <dpa_sample>
namespace: openshift-adp
spec:
configuration:
velero:
defaultPlugins:
- azure
- openshift # <1>
resourceTimeout: 10m # <2>
restic:
enable: true # <3>
podConfig:
nodeSelector: <node_selector> # <4>
backupLocations:
- velero:
config:
resourceGroup: <azure_resource_group> # <5>
storageAccount: <azure_storage_account_id> # <6>
subscriptionId: <azure_subscription_id> # <7>
storageAccountKeyEnvVar: AZURE_STORAGE_ACCOUNT_ACCESS_KEY
credential:
key: cloud
name: {credentials} # <8>
provider: {provider}
default: true
objectStorage:
bucket: <bucket_name> # <9>
prefix: <prefix> # <10>
snapshotLocations: # <11>
- velero:
config:
resourceGroup: <azure_resource_group>
subscriptionId: <azure_subscription_id>
incremental: "true"
name: default
provider: {provider}
credential:
key: cloud
name: {credentials} # <12>
----
<1> The `openshift` plugin is mandatory.
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
<3> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
<5> Specify the Azure resource group.
<6> Specify the Azure storage account ID.
<7> Specify the Azure subscription ID.
<8> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
<9> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<10> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
<11> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
<12> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
endif::[]
ifdef::installing-oadp-gcp[]
+
[source,yaml,subs="attributes+"]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: <dpa_sample>
namespace: openshift-adp
spec:
configuration:
velero:
defaultPlugins:
- gcp
- openshift # <1>
resourceTimeout: 10m # <2>
restic:
enable: true # <3>
podConfig:
nodeSelector: <node_selector> # <4>
backupLocations:
- velero:
provider: {provider}
default: true
credential:
key: cloud # <5>
name: {credentials} # <6>
objectStorage:
bucket: <bucket_name> # <7>
prefix: <prefix> # <8>
snapshotLocations: # <9>
- velero:
provider: {provider}
default: true
config:
project: <project>
snapshotLocation: us-west1 # <10>
credential:
key: cloud
name: {credentials} # <11>
----
<1> The `openshift` plugin is mandatory.
<2> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
<3> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
<4> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
<5> Secret key that contains credentials. For Google workload identity federation cloud authentication use `service_account.json`.
<6> Secret name that contains credentials. If you do not specify this value, the default name, `{credentials}`, is used.
<7> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<8> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
<9> Specify a snapshot location, unless you use CSI snapshots or Restic to back up PVs.
<10> The snapshot location must be in the same region as the PVs.
<11> Specify the name of the `Secret` object that you created. If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the snapshot location.
endif::[]
ifdef::installing-oadp-mcg[]
+
[source,yaml,subs="attributes+"]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: <dpa_sample>
namespace: openshift-adp
spec:
configuration:
velero:
defaultPlugins:
- aws # <1>
- openshift # <2>
resourceTimeout: 10m # <3>
restic:
enable: true # <4>
podConfig:
nodeSelector: <node_selector> # <5>
backupLocations:
- velero:
config:
profile: "default"
region: <region_name> <6>
s3Url: <url> # <7>
insecureSkipTLSVerify: "true"
s3ForcePathStyle: "true"
provider: {provider}
default: true
credential:
key: cloud
name: {credentials} # <8>
objectStorage:
bucket: <bucket_name> # <9>
prefix: <prefix> # <10>
----
<1> An object store plugin corresponding to your storage locations is required. For all S3 providers, the required plugin is `aws`. For {azure-short} and {gcp-short} object stores, the `azure` or `gcp` plugin is required.
<2> The `openshift` plugin is mandatory.
<3> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
<4> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
<5> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
<6> Specify the region, following the naming convention of the documentation of your object storage server.
<7> Specify the URL of the S3 endpoint.
<8> If you do not specify this value, the default name, `{credentials}`, is used. If you specify a custom name, the custom name is used for the backup location.
<9> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<10> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]
ifdef::installing-oadp-ocs[]
+
[source,yaml,subs="attributes+"]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: <dpa_sample>
namespace: openshift-adp
spec:
configuration:
velero:
defaultPlugins:
- aws # <1>
- kubevirt # <2>
- csi # <3>
- openshift # <4>
resourceTimeout: 10m # <5>
restic:
enable: true # <6>
podConfig:
nodeSelector: <node_selector> # <7>
backupLocations:
- velero:
provider: {provider} # <8>
default: true
credential:
key: cloud
name: <default_secret> # <9>
objectStorage:
bucket: <bucket_name> # <10>
prefix: <prefix> # <11>
----
<1> An object store plugin corresponding to your storage locations is required. For all S3 providers, the required plugin is `aws`. For {azure-short} and {gcp-short} object stores, the `azure` or `gcp` plugin is required.
<2> Optional: The `kubevirt` plugin is used with {VirtProductName}.
<3> Specify the `csi` default plugin if you use CSI snapshots to back up PVs. The `csi` plugin uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
<4> The `openshift` plugin is mandatory.
<5> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m.
<6> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
<7> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
<8> Specify the backup provider.
<9> Specify the correct default name for the `Secret`, for example, `cloud-credentials-gcp`, if you use a default plugin for the backup provider. If specifying a custom name, then the custom name is used for the backup location. If you do not specify a `Secret` name, the default name is used.
<10> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]
. Click *Create*.
[id="verifying-oadp-installation-1-2_{context}"]
.Verification
. Verify the installation by viewing the {oadp-first} resources by running the following command:
+
[source,terminal]
----
$ oc get all -n openshift-adp
----
+
.Example output
+
----
NAME READY STATUS RESTARTS AGE
pod/oadp-operator-controller-manager-67d9494d47-6l8z8 2/2 Running 0 2m8s
pod/restic-9cq4q 1/1 Running 0 94s
pod/restic-m4lts 1/1 Running 0 94s
pod/restic-pv4kr 1/1 Running 0 95s
pod/velero-588db7f655-n842v 1/1 Running 0 95s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/oadp-operator-controller-manager-metrics-service ClusterIP 172.30.70.140 <none> 8443/TCP 2m8s
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
daemonset.apps/restic 3 3 3 3 3 <none> 96s
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/oadp-operator-controller-manager 1/1 1 1 2m9s
deployment.apps/velero 1/1 1 1 96s
NAME DESIRED CURRENT READY AGE
replicaset.apps/oadp-operator-controller-manager-67d9494d47 1 1 1 2m9s
replicaset.apps/velero-588db7f655 1 1 1 96s
----
. Verify that the `DataProtectionApplication` (DPA) is reconciled by running the following command:
+
[source,terminal]
----
$ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
----
.Example output
[source,yaml]
+
----
{"conditions":[{"lastTransitionTime":"2023-10-27T01:23:57Z","message":"Reconcile complete","reason":"Complete","status":"True","type":"Reconciled"}]}
----
. Verify the `type` is set to `Reconciled`.
. Verify the backup storage location and confirm that the `PHASE` is `Available` by running the following command:
+
[source,terminal]
----
$ oc get backupstoragelocations.velero.io -n openshift-adp
----
+
.Example output
[source,terminal]
----
NAME PHASE LAST VALIDATED AGE DEFAULT
dpa-sample-1 Available 1s 3d16h true
----

27
modules/oadp-installing-operator.adoc
View File

@@ -1,27 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-installing-operator_{context}"]
= Installing the OADP Operator
You install the OpenShift API for Data Protection (OADP) Operator on {product-title} {product-version} by using Operator Lifecycle Manager (OLM).
The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
.Prerequisites
* You must be logged in as a user with `cluster-admin` privileges.
.Procedure
. In the {product-title} web console, click *Operators* -> *OperatorHub*.
. Use the *Filter by keyword* field to find the *OADP Operator*.
. Select the *OADP Operator* and click *Install*.
. Click *Install* to install the Operator in the `openshift-adp` project.
. Click *Operators* -> *Installed Operators* to verify the installation.

87
modules/oadp-operator-supported.adoc
View File

@@ -1,87 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/oadp-intro.adoc
:_mod-docs-content-type: REFERENCE
[id="oadp-operator-supported_{context}"]
= Support for {oadp-full}
.Supported versions of {oadp-short}
[width="100%",cols="10%,12%,12%,13%,13%,20%,20%,options="header"]
|===
|Version
|OCP version
|General availability
|Full support ends
|Maintenance ends
|Extended Update Support (EUS)
|Extended Update Support Term 2 (EUS Term 2)
|1.4
a|
* 4.14
* 4.15
* 4.16
* 4.17
|10 Jul 2024
|Release of 1.5
|Release of 1.6
a|
27 Jun 2026
EUS must be on OCP 4.16
a|
27 Jun 2027
EUS Term 2 must be on OCP 4.16
|1.3
a|
* 4.12
* 4.13
* 4.14
* 4.15
|29 Nov 2023
|10 Jul 2024
|Release of 1.5
a|
31 Oct 2025
EUS must be on OCP 4.14
a|
31 Oct 2026
EUS Term 2 must be on OCP 4.14
|===
[id="oadp-operator-unsupported_{context}"]
== Unsupported versions of the {oadp-short} Operator
.Previous versions of the {oadp-short} Operator which are no longer supported
[width="100%",cols="25%,25%,25%,25%,options="header"]
|===
|Version
|General availability
|Full support ended
|Maintenance ended
|1.2
|14 Jun 2023
|29 Nov 2023
|10 Jul 2024
|1.1
|01 Sep 2022
|14 Jun 2023
|29 Nov 2023
|1.0
|09 Feb 2022
|01 Sep 2022
|14 Jun 2023
|===
For more details about EUS, see link:https://access.redhat.com/support/policy/updates/openshift#eus[Extended Update Support].
For more details about EUS Term 2, see link:https://access.redhat.com/support/policy/updates/openshift#eust2[Extended Update Support Term 2].

17
modules/oadp-upgrading-oadp-operator-1-2-0.adoc
View File

@@ -1,17 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/oadp-release-notes-1-2.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-upgrading-dpa-operator-1-2-0_{context}"]
= Upgrading the OADP Operator
Use the following sequence when upgrading the {oadp-first} Operator.
.Procedure
. Change your subscription channel for the OADP Operator from `stable-1.1` to `stable-1.2`.
. Allow time for the Operator and containers to update and restart.

250
modules/oadp-using-data-mover-for-csi-snapshots.adoc
View File

@@ -1,250 +0,0 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-using-data-mover-for-csi-snapshots_{context}"]
= Using Data Mover for CSI snapshots
:FeatureName: Data Mover for CSI snapshots
The OADP Data Mover enables customers to back up Container Storage Interface (CSI) volume snapshots to a remote object store.
When Data Mover is enabled, you can restore stateful applications, using CSI volume snapshots pulled from the object store if a failure, accidental deletion, or corruption of the cluster occurs.
The Data Mover solution uses the Restic option of VolSync.
Data Mover supports backup and restore of CSI volume snapshots only.
In OADP 1.2 Data Mover, `VolumeSnapshotBackups` (VSBs) and `VolumeSnapshotRestores` (VSRs) are queued by using the VolumeSnapshotMover (VSM). The VSM's performance is improved by specifying a concurrent number of VSBs and VSRs simultaneously `InProgress`. After all async plugin operations are complete, the backup is marked as complete.
:FeatureName: The OADP 1.2 Data Mover
include::snippets/technology-preview.adoc[leveloffset=+1]
[NOTE]
====
Red Hat recommends that customers who use OADP 1.2 Data Mover in order to back up and restore ODF CephFS volumes, upgrade or install {product-title} version 4.12 or later for improved performance. OADP Data Mover can leverage CephFS shallow volumes in {product-title} version 4.12 or later, which based on our testing, can improve the performance of backup times.
* https://issues.redhat.com/browse/RHSTOR-4287[CephFS ROX details]
//* https://github.com/ceph/ceph-csi/blob/devel/docs/cephfs-snapshot-backed-volumes.md[Provisioning and mounting CephFS snapshot-backed volumes]
//For more information about OADP 1.2 with CephS [name of topic], see ___.
====
.Prerequisites
* You have verified that the `StorageClass` and `VolumeSnapshotClass` custom resources (CRs) support CSI.
* You have verified that only one `volumeSnapshotClass` CR has the annotation `snapshot.storage.kubernetes.io/is-default-class: true`.
+
[NOTE]
====
In {product-title} version 4.12 or later, verify that this is the only default `volumeSnapshotClass`.
====
* You have verified that only one `storageClass` CR has the annotation `storageclass.kubernetes.io/is-default-class: true`.
* You have included the label `{velero-domain}/csi-volumesnapshot-class: 'true'` in your `VolumeSnapshotClass` CR.
* You have verified that the `OADP namespace` has the annotation `oc annotate --overwrite namespace/openshift-adp volsync.backube/privileged-movers='true'`.
* You have installed the VolSync Operator by using Operator Lifecycle Manager (OLM).
+
[NOTE]
====
The VolSync Operator is required for using OADP Data Mover.
====
* You have installed the OADP operator by using OLM.
.Procedure
. Configure a Restic secret by creating a `.yaml` file:
+
[source,yaml]
----
apiVersion: v1
kind: Secret
metadata:
name: <secret_name>
type: Opaque
stringData:
# The repository encryption key
RESTIC_PASSWORD: my-secure-restic-password
----
+
. Create a DPA CR similar to the following example. The default plugins include CSI.
. Add the restic secret name from the step above to your DPA CR as `spec.features.dataMover.credentialName`. If this step is not completed, then it will default to the secret name `dm-credential`.
+
[NOTE]
====
In this DPA, the `CSI` and `VSM` are included as `defaultPlugins`. Also included is the `dataMover.enable` flag.
====
+
.Example Data Protection Application (DPA) CR
[source,yaml]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: velero-sample
namespace: openshift-adp
spec:
features:
dataMover:
enable: true
credentialName: <secret-name>
maxConcurrentBackupVolumes: "3" <1>
maxConcurrentRestoreVolumes: "3" <2>
pruneInterval: "14" <3>
volumeOptionsForStorageClasses: <4>
gp2-csi-copy-1:
destinationVolumeOptions:
storageClassName: csi-copy-2
sourceVolumeOptions:
storageClassName: csi-copy-1
backupLocations:
- velero:
config:
profile: default
region: us-east-1
credential:
key: cloud
name: cloud-credentials
default: true
objectStorage:
bucket: <bucket_name>
prefix: <bucket-prefix>
provider: aws
configuration:
restic:
enable: false
velero:
defaultPlugins:
- openshift
- aws
- csi
- vsm
----
<1> Optional: Specify the upper limit of the number of snapshots allowed to be queued for backup. The default value is `10`.
<2> Optional: Specify the upper limit of the number of snapshots allowed to be queued for restore. The default value is `10`.
<3> Optional: Specify the number of days between running Restic pruning on the repository. The prune operation repacks the data to free space, but it can also generate significant I/O traffic as a part of the process. Setting this option allows a trade-off between storage consumption, from no longer referenced data, and access costs.
<4> Optional: Specify VolumeSync volume options for backup and restore.
+
The OADP Operator installs two custom resource definitions (CRDs), `VolumeSnapshotBackup` and `VolumeSnapshotRestore`.
+
.Example `VolumeSnapshotBackup` CRD
[source,yaml]
----
apiVersion: datamover.oadp.openshift.io/v1alpha1
kind: VolumeSnapshotBackup
metadata:
name: <vsb_name>
namespace: <namespace_name> <1>
spec:
volumeSnapshotContent:
name: <snapcontent_name>
protectedNamespace: <adp_namespace>
resticSecretRef:
name: <restic_secret_name>
----
<1> Specify the namespace where the volume snapshot exists.
+
.Example `VolumeSnapshotRestore` CRD
[source,yaml]
----
apiVersion: datamover.oadp.openshift.io/v1alpha1
kind: VolumeSnapshotRestore
metadata:
name: <vsr_name>
namespace: <namespace_name> <1>
spec:
protectedNamespace: <protected_ns> <2>
resticSecretRef:
name: <restic_secret_name>
volumeSnapshotMoverBackupRef:
sourcePVCData:
name: <source_pvc_name>
size: <source_pvc_size>
resticrepository: <your_restic_repo>
volumeSnapshotClassName: <vsclass_name>
----
<1> Specify the namespace where the volume snapshot exists.
<2> Specify the namespace where the Operator is installed. The default is `openshift-adp`.
. Back up a volume snapshot by performing the following steps:
.. Create a backup CR:
+
[source,yaml]
----
apiVersion: velero.io/v1
kind: Backup
metadata:
name: <backup_name>
namespace: <protected_ns> <1>
spec:
includedNamespaces:
- <app_ns>
storageLocation: velero-sample-1
----
<1> Specify the namespace where the Operator is installed. The default namespace is `openshift-adp`.
.. Wait up to 10 minutes and check whether the `VolumeSnapshotBackup` CR status is `Completed` by entering the following commands:
+
[source,terminal]
----
$ oc get vsb -n <app_ns>
----
+
[source,terminal]
----
$ oc get vsb <vsb_name> -n <app_ns> -o jsonpath="{.status.phase}"
----
+
A snapshot is created in the object store was configured in the DPA.
+
[NOTE]
====
If the status of the `VolumeSnapshotBackup` CR becomes `Failed`, refer to the Velero logs for troubleshooting.
====
. Restore a volume snapshot by performing the following steps:
.. Delete the application namespace and the `volumeSnapshotContent` that was created by the Velero CSI plugin.
.. Create a `Restore` CR and set `restorePVs` to `true`.
+
.Example `Restore` CR
[source,yaml]
----
apiVersion: velero.io/v1
kind: Restore
metadata:
name: <restore_name>
namespace: <protected_ns>
spec:
backupName: <previous_backup_name>
restorePVs: true
----
.. Wait up to 10 minutes and check whether the `VolumeSnapshotRestore` CR status is `Completed` by entering the following command:
+
[source,terminal]
----
$ oc get vsr -n <app_ns>
----
+
[source,terminal]
----
$ oc get vsr <vsr_name> -n <app_ns> -o jsonpath="{.status.phase}"
----
.. Check whether your application data and resources have been restored.
+
[NOTE]
====
If the status of the `VolumeSnapshotRestore` CR becomes 'Failed', refer to the Velero logs for troubleshooting.
====

0
modules/oadp-vsb-cleanup-after-scheduler.adoc
View File

0
modules/setting-resource-limits-and-requests.adoc
View File

27
modules/support-insecure-tls-connections.adoc
View File

@@ -1,27 +0,0 @@
// Module included in the following assemblies:
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
:_mod-docs-content-type: PROCEDURE
[id="support-insecure-tls-connections_{context}"]
= Using must-gather with insecure TLS connections
If a custom CA certificate is used, the `must-gather` pod fails to grab the output for `velero logs/describe`. To use the `must-gather` tool with insecure TLS connections, you can pass the `gather_without_tls` flag to the `must-gather` command.
.Procedure
* Pass the `gather_without_tls` flag, with value set to `true`, to the `must-gather` tool by using the following command:
.. For {oadp-short} 1.3, run the following command:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-3} -- /usr/bin/gather_without_tls <true/false>
----
+
.. For {oadp-short} 1.4, run the following command:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather_without_tls <true/false>
----
+
By default, the flag value is set to `false`. Set the value to `true` to allow insecure TLS connections.