Skip to content

Commit 0e4e679

Browse files
apinnickapinnick
authored
Merge pull request #37971 from apinnick/oadp106-installation
OADP-106: OADP installation
2 parents 0afd555 + 97014fa commit 0e4e679

22 files changed

+997
-111
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2096,6 +2096,21 @@ Topics:
20962096
# - Name: Application backup and restore
20972097
# Dir: application_backup_and_restore
20982098
# Topics:
2099+
# - Name: Installing OADP
2100+
# Dir: installing
2101+
# Topics:
2102+
# - Name: About installing OADP
2103+
# File: about-installing-oadp
2104+
# - Name: Installing OADP with AWS
2105+
# File: installing-oadp-aws
2106+
# - Name: Installing OADP with Azure
2107+
# File: installing-oadp-azure
2108+
# - Name: Installing OADP with GCP
2109+
# File: installing-oadp-gcp
2110+
# - Name: Installing OADP with MCG
2111+
# File: installing-oadp-mcg
2112+
# - Name: Installing OADP with OCS
2113+
# File: installing-oadp-ocs
20992114
# - Name: Configuring OADP
21002115
# File: configuring-oadp
21012116
- Name: Control plane backup and restore

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="about-installing-oadp"]
2+
= About installing OADP
3+
include::modules/common-attributes.adoc[]
4+
:context: about-installing-oadp
5+
6+
toc::[]
7+
8+
As a cluster administrator, you install the Openshift API for Data Protection (OADP) by installing the OADP Operator and then installing the Data Protection Application. The OADP Operator installs link:https://velero.io/docs/v1.7/[Velero 1.7].
9+
10+
To back up Kubernetes resources and internal images, you must have S3-compatible object storage, such as the following storage providers:
11+
12+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#installing-oadp-aws[Amazon Web Services]
13+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc#installing-oadp-azure[Microsoft Azure]
14+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc#installing-oadp-gcp[Google Cloud Platform]
15+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway]
16+
17+
:FeatureName: The CloudStorage API for S3 storage
18+
include::modules/technology-preview.adoc[]
19+
20+
To back up persistent volumes (PVs) with snapshots, your cloud provider must support either a native snapshot API or Container Snapshot Interface (CSI) snapshots, such as the following providers:
21+
22+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#installing-oadp-aws[Amazon Web Services]
23+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc#installing-oadp-azure[Microsoft Azure]
24+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc#installing-oadp-gcp[Google Cloud Platform]
25+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#oadp-about-vsl_installing-oadp-ocs[Ceph RBD or Ceph FS storage]
26+
27+
If your cloud provider does not support snapshots or if your storage is NFS, you can create backups with link:https://restic.net/[Restic].
28+
29+
[discrete]
30+
== Additional resources
31+
32+
* Overview of backup storage locations and volume snapshot locations in the link:https://velero.io/docs/v1.7/locations/[Velero documentation]

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="installing-oadp-aws"]
2+
= Installing the Openshift API for Data Protection with Amazon Web Services
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-oadp-aws
5+
:installing-oadp-aws:
6+
:credentials: cloud-credentials
7+
:provider: aws
8+
9+
toc::[]
10+
11+
You install the Openshift API for Data Protection (OADP) with Amazon Web Services (AWS) by installing the OADP Operator, configuring AWS for Velero, and then installing the Data Protection Application.
12+
13+
:FeatureName: The CloudStorage API for S3 storage
14+
include::modules/technology-preview.adoc[]
15+
16+
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.
17+
18+
If you are not using snapshots or if your storage is NFS, you can create backups with link:https://restic.net/[Restic].
19+
20+
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
21+
include::modules/migration-configuring-aws-s3.adoc[leveloffset=+1]
22+
23+
[id="configuring-dpa-aws"]
24+
== Configuring the Data Protection Application
25+
26+
include::modules/oadp-configuring-default-plug-ins.adoc[leveloffset=+2]
27+
include::modules/oadp-about-bsl.adoc[leveloffset=+2]
28+
include::modules/oadp-about-vsl.adoc[leveloffset=+2]
29+
30+
include::modules/oadp-installing-dpa.adoc[leveloffset=+1]
31+
32+
:installing-oadp-aws!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="installing-oadp-azure"]
2+
= Installing the Openshift API for Data Protection with Azure
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-oadp-azure
5+
:installing-oadp-azure:
6+
:credentials: cloud-credentials-azure
7+
:provider: azure
8+
9+
toc::[]
10+
11+
You install the Openshift API for Data Protection (OADP) with Microsoft Azure by installing the OADP Operator, configuring Azure for Velero, and then installing the Data Protection Application.
12+
13+
:FeatureName: The CloudStorage API for S3 storage
14+
include::modules/technology-preview.adoc[]
15+
16+
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.
17+
18+
If you are not using snapshots or if your storage is NFS, you can create backups with link:https://restic.net/[Restic].
19+
20+
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
21+
include::modules/migration-configuring-azure.adoc[leveloffset=+1]
22+
23+
[id="configuring-dpa-azure"]
24+
== Configuring the Data Protection Application
25+
26+
include::modules/oadp-configuring-default-plug-ins.adoc[leveloffset=+2]
27+
include::modules/oadp-about-bsl.adoc[leveloffset=+2]
28+
include::modules/oadp-about-vsl.adoc[leveloffset=+2]
29+
30+
include::modules/oadp-installing-dpa.adoc[leveloffset=+1]
31+
32+
:installing-oadp-azure!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="installing-oadp-gcp"]
2+
= Installing the Openshift API for Data Protection with Google Cloud Platform
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-oadp-gcp
5+
:installing-oadp-gcp:
6+
:credentials: cloud-credentials-gcp
7+
:provider: gcp
8+
9+
toc::[]
10+
11+
You install the Openshift API for Data Protection (OADP) with Google Cloud Platform (GCP) by installing the OADP Operator, configuring GCP for Velero, and then installing the Data Protection Application.
12+
13+
:FeatureName: The CloudStorage API for S3 storage
14+
include::modules/technology-preview.adoc[]
15+
16+
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.
17+
18+
If you are not using snapshots or if your storage is NFS, you can create backups with link:https://restic.net/[Restic].
19+
20+
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
21+
include::modules/migration-configuring-gcp.adoc[leveloffset=+1]
22+
23+
[id="configuring-dpa-gcp"]
24+
== Configuring the Data Protection Application
25+
26+
include::modules/oadp-configuring-default-plug-ins.adoc[leveloffset=+2]
27+
include::modules/oadp-about-bsl.adoc[leveloffset=+2]
28+
include::modules/oadp-about-vsl.adoc[leveloffset=+2]
29+
30+
include::modules/oadp-installing-dpa.adoc[leveloffset=+1]
31+
32+
:installing-oadp-gcp!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[id="installing-oadp-mcg"]
2+
= Installing the Openshift API for Data Protection with Google Cloud Platform
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-oadp-mcg
5+
:installing-oadp-mcg:
6+
:credentials: cloud-credentials
7+
:provider: aws
8+
9+
toc::[]
10+
11+
You install the Openshift API for Data Protection (OADP) with Multicloud Object Gateway (MCG) by installing the OADP Operator, retrieving the MCG credentials, and then installing the Data Protection Application.
12+
13+
MCG is a component of OpenShift Container Storage (OCS). You can configure MCG as a backup location.
14+
15+
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.
16+
17+
If you are not using snapshots or if your storage is NFS, you can create backups with link:https://restic.net/[Restic].
18+
19+
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
20+
include::modules/migration-configuring-mcg.adoc[leveloffset=+1]
21+
22+
[id="configuring-dpa-mcg"]
23+
== Configuring the Data Protection Application
24+
25+
include::modules/oadp-configuring-default-plug-ins.adoc[leveloffset=+2]
26+
include::modules/oadp-about-bsl.adoc[leveloffset=+2]
27+
28+
include::modules/oadp-installing-dpa.adoc[leveloffset=+1]
29+
30+
:installing-oadp-mcg!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="installing-oadp-ocs"]
2+
= Installing the Openshift API for Data Protection with OpenShift Container Storage
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-oadp-ocs
5+
:installing-oadp-ocs:
6+
:credentials: cloud-credentials-gcp
7+
:provider: gcp
8+
9+
toc::[]
10+
11+
You install the Openshift API for Data Protection (OADP) with OpenShift Container Storage (OCS) by installing the OADP Operator, installing the Data Protection Application, and configuring the snapshot location.
12+
13+
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.
14+
15+
You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] or any S3-compatible object storage as a backup location.
16+
17+
You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#oadp-about-vsl_installing-oadp-ocs[Ceph RBD or Ceph FS storage] as a snapshot location.
18+
19+
If you are not using snapshots or if your storage is NFS, you can create backups with link:https://restic.net/[Restic].
20+
21+
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
22+
23+
[id="configuring-dpa-ocs"]
24+
== Configuring the Data Protection Application
25+
26+
include::modules/oadp-configuring-default-plug-ins.adoc[leveloffset=+2]
27+
include::modules/oadp-about-bsl.adoc[leveloffset=+2]
28+
include::modules/oadp-about-vsl.adoc[leveloffset=+2]
29+
30+
include::modules/oadp-installing-dpa.adoc[leveloffset=+1]
31+
32+
:installing-oadp-ocs!:

‎backup_and_restore/application_backup_and_restore/installing/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/

0 commit comments

Comments
 (0)