Skip to content

Commit bc74952

Browse files
committed
This is a combination of 5 commits.
OADP-2134: correcting format of DPA
1 parent 24c7d3d commit bc74952

File tree

1 file changed

+31
-38
lines changed

1 file changed

+31
-38
lines changed

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

Lines changed: 31 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88

99
:FeatureName: Data Mover for CSI snapshots
1010

11-
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.
11+
The OADP Data Mover enables customers to back up Container Storage Interface (CSI) volume snapshots to a remote object store.
12+
13+
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.
1214

1315
The Data Mover solution uses the Restic option of VolSync.
1416

@@ -75,26 +77,27 @@ The VolSync Operator is required for using OADP Data Mover.
7577
7678
.Procedure
7779

78-
. Configure a Restic secret by creating a `.yaml` file as following:
80+
. Configure a Restic secret by creating a `.yaml` file:
7981
+
8082
[source,yaml]
8183
----
8284
apiVersion: v1
8385
kind: Secret
8486
metadata:
8587
name: <secret_name>
86-
namespace: openshift-adp
8788
type: Opaque
8889
stringData:
89-
RESTIC_PASSWORD: <secure_restic_password>
90+
# The repository encryption key
91+
RESTIC_PASSWORD: my-secure-restic-password
9092
----
9193
+
94+
. Create a DPA CR similar to the following example. The default plugins include CSI.
95+
. 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`.
96+
+
9297
[NOTE]
9398
====
94-
By default, the Operator looks for a secret named `dm-credential`. If you are using a different name, you need to specify the name through a Data Protection Application (DPA) CR using `dpa.spec.features.dataMover.credentialName`.
99+
In this DPA, the `CSI` and `VSM` are included as `defaultPlugins`. Also included is the `dataMover.enable` flag.
95100
====
96-
97-
. Create a DPA CR similar to the following example. The default plugins include CSI.
98101
+
99102
.Example Data Protection Application (DPA) CR
100103
[source,yaml]
@@ -105,6 +108,19 @@ metadata:
105108
name: velero-sample
106109
namespace: openshift-adp
107110
spec:
111+
features:
112+
dataMover:
113+
enable: true
114+
credentialName: <secret-name>
115+
maxConcurrentBackupVolumes: "3" <1>
116+
maxConcurrentRestoreVolumes: "3" <2>
117+
pruneInterval: "14" <3>
118+
volumeOptionsForStorageClasses: <4>
119+
gp2-csi-copy-1:
120+
destinationVolumeOptions:
121+
storageClassName: csi-copy-2
122+
sourceVolumeOptions:
123+
storageClassName: csi-copy-1
108124
backupLocations:
109125
- velero:
110126
config:
@@ -120,42 +136,19 @@ spec:
120136
provider: aws
121137
configuration:
122138
restic:
123-
enable: <true_or_false>
139+
enable: false
124140
velero:
125-
itemOperationSyncFrequency: "10s"
126-
defaultPlugins:
141+
defaultPlugins:
127142
- openshift
128143
- aws
129144
- csi
130-
- vsm <1>
131-
features:
132-
dataMover:
133-
credentialName: restic-secret
134-
enable: true
135-
maxConcurrentBackupVolumes: "3" <2>
136-
maxConcurrentRestoreVolumes: "3" <3>
137-
pruneInterval: "14" <4>
138-
volumeOptions: <5>
139-
sourceVolumeOptions:
140-
accessMode: ReadOnlyMany
141-
cacheAccessMode: ReadWriteOnce
142-
cacheCapacity: 2Gi
143-
destinationVolumeOptions:
144-
storageClass: other-storageclass-name
145-
cacheAccessMode: ReadWriteMany
146-
snapshotLocations:
147-
- velero:
148-
config:
149-
profile: default
150-
region: us-west-2
151-
provider: aws
152-
145+
- vsm <5>
153146
----
154-
<1> OADP 1.2 only.
155-
<2> OADP 1.2 only. Optional: Specify the upper limit of the number of snapshots allowed to be queued for backup. The default value is 10.
156-
<3> OADP 1.2 only. Optional: Specify the upper limit of the number of snapshots allowed to be queued for restore. The default value is 10.
157-
<4> OADP 1.2 only. 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.
158-
<5> OADP 1.2 only. Optional: Specify VolumeSync volume options for backup and restore.
147+
<1> OADP 1.2 only. Optional: Specify the upper limit of the number of snapshots allowed to be queued for backup. The default value is 10.
148+
<2> OADP 1.2 only. Optional: Specify the upper limit of the number of snapshots allowed to be queued for restore. The default value is 10.
149+
<3> OADP 1.2 only. 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.
150+
<4> OADP 1.2 only. Optional: Specify VolumeSync volume options for backup and restore.
151+
<5> OADP 1.2 only.
159152

160153
+
161154
The OADP Operator installs two custom resource definitions (CRDs), `VolumeSnapshotBackup` and `VolumeSnapshotRestore`.

0 commit comments

Comments
 (0)