Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
= Configuring the OpenShift API for Data Protection with OpenShift Data Foundation
include::_attributes/common-attributes.adoc[]
:context: installing-oadp-ocs
:installing-oadp-ocs:
:credentials: cloud-credentials
:provider: gcp
:provider: oadp-ocs

toc::[]

Expand Down Expand Up @@ -45,3 +46,5 @@ include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-creating-object-bucket-claim.adoc[leveloffset=+2]
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]


:installing-oadp-ocs!:
14 changes: 11 additions & 3 deletions modules/oadp-installing-dpa-1-3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
// * 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-3_{context}"]
= Installing the Data Protection Application 1.3
Expand All @@ -24,6 +25,7 @@ ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-
** `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::[]
Expand All @@ -39,6 +41,7 @@ If you do not want to specify backup or snapshot locations during the installati
. 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+"]
Expand Down Expand Up @@ -95,6 +98,7 @@ spec:
<11> Specify a snapshot location, unless you use CSI snapshots or a File System Backup (FSB) to back up PVs.
<12> The snapshot location must be in the same region as the PVs.
endif::[]

ifdef::installing-oadp-azure[]
+
[source,yaml,subs="attributes+"]
Expand Down Expand Up @@ -155,6 +159,7 @@ spec:
<13> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
<14> You do not need to specify a snapshot location if you use CSI snapshots or Restic to back up PVs.
endif::[]

ifdef::installing-oadp-gcp[]
+
[source,yaml,subs="attributes+"]
Expand Down Expand Up @@ -210,6 +215,7 @@ spec:
<13> The snapshot location must be in the same region as the PVs.
<14> Google workload identity federation supports internal image backup. Set this field to `false` if you do not want to use image backup.
endif::[]

ifdef::installing-oadp-mcg[]
+
[source,yaml,subs="attributes+"]
Expand Down Expand Up @@ -260,6 +266,7 @@ spec:
<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::[]

ifdef::installing-oadp-ocs[]
+
[source,yaml,subs="attributes+"]
Expand Down Expand Up @@ -296,7 +303,7 @@ spec:
----
<1> The default namespace for OADP is `openshift-adp`. The namespace is a variable and is configurable.
<2> Optional: The `kubevirt` plugin is used with {VirtProductName}.
<32> Specify the default plugin for the backup provider, for example, `gcp`, if appropriate.
<3> Specify the default plugin for the backup provider, for example, `gcp`, if appropriate.
<4> 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.
<5> The `openshift` plugin is mandatory.
<6> 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.
Expand All @@ -309,6 +316,7 @@ spec:
<13> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<14> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]

ifdef::virt-installing-configuring-oadp[]
+
[source,yaml,subs="attributes+"]
Expand Down Expand Up @@ -404,8 +412,8 @@ replicaset.apps/velero-588db7f655 1 1
$ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
----
.Example output
[source,yaml]
+
[source,yaml]
----
{"conditions":[{"lastTransitionTime":"2023-10-27T01:23:57Z","message":"Reconcile complete","reason":"Complete","status":"True","type":"Reconciled"}]}
----
Expand All @@ -419,8 +427,8 @@ $ oc get dpa dpa-sample -n openshift-adp -o jsonpath='{.status}'
$ oc get backupStorageLocation -n openshift-adp
----
.Example output
[source,yaml]
+
[source,yaml]
----
NAME PHASE LAST VALIDATED AGE DEFAULT
dpa-sample-1 Available 1s 3d16h true
Expand Down