Merge pull request #41186 from apinnick/oadp-release

apinnick · web-flow · commit 3fd7063bc053 · 2022-02-07T16:49:09.000+02:00
Uncomment OADP for GA
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2099,37 +2099,37 @@ Topics:
   File: graceful-cluster-shutdown
 - Name: Restarting a cluster gracefully
   File: graceful-cluster-restart
-# - Name: Application backup and restore
-#   Dir: application_backup_and_restore
-#   Topics:
-#   - Name: OADP features and plugins
-#     File: oadp-features-plugins
-#   - Name: Installing and configuring OADP
-#     Dir: installing
-#     Topics:
-#     - Name: About installing OADP
-#       File: about-installing-oadp
-#     - Name: Installing and configuring OADP with AWS
-#       File: installing-oadp-aws
-#     - Name: Installing and configuring OADP with Azure
-#       File: installing-oadp-azure
-#     - Name: Installing and configuring OADP with GCP
-#       File: installing-oadp-gcp
-#     - Name: Installing and configuring OADP with MCG
-#       File: installing-oadp-mcg
-#     - Name: Installing and configuring OADP with OCS
-#       File: installing-oadp-ocs
-#     - Name: Uninstalling OADP
-#       File: uninstalling-oadp
-#   - Name: Backing up and restoring
-#     Dir: backing_up_and_restoring
-#     Topics:
-#     - Name: Backing up applications
-#       File: backing-up-applications
-#     - Name: Restoring applications
-#       File: restoring-applications
-#   - Name: Troubleshooting
-#     File: troubleshooting
+- Name: Application backup and restore
+  Dir: application_backup_and_restore
+  Topics:
+  - Name: OADP features and plugins
+    File: oadp-features-plugins
+  - Name: Installing and configuring OADP
+    Dir: installing
+    Topics:
+    - Name: About installing OADP
+      File: about-installing-oadp
+    - Name: Installing and configuring OADP with AWS
+      File: installing-oadp-aws
+    - Name: Installing and configuring OADP with Azure
+      File: installing-oadp-azure
+    - Name: Installing and configuring OADP with GCP
+      File: installing-oadp-gcp
+    - Name: Installing and configuring OADP with MCG
+      File: installing-oadp-mcg
+    - Name: Installing and configuring OADP with OCS
+      File: installing-oadp-ocs
+    - Name: Uninstalling OADP
+      File: uninstalling-oadp
+  - Name: Backing up and restoring
+    Dir: backing_up_and_restoring
+    Topics:
+    - Name: Backing up applications
+      File: backing-up-applications
+    - Name: Restoring applications
+      File: restoring-applications
+  - Name: Troubleshooting
+    File: troubleshooting
 - Name: Control plane backup and restore
   Dir: control_plane_backup_and_restore
   Topics:
diff --git a/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc b/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
@@ -3,6 +3,7 @@
 = Backing up applications
 include::modules/common-attributes.adoc[]
 :context: backing-up-applications
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc b/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc
@@ -3,6 +3,7 @@
 = Restoring applications
 include::modules/common-attributes.adoc[]
 :context: restoring-applications
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc b/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc
@@ -3,10 +3,11 @@
 = About installing OADP
 include::modules/common-attributes.adoc[]
 :context: about-installing-oadp
+:velero-domain: velero.io
 
 toc::[]
 
-As a cluster administrator, you install the Openshift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs link:https://velero.io/docs/v1.7/[Velero 1.7].
+As a cluster administrator, you install the Openshift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
 
 To back up Kubernetes resources and internal images, you must have object storage as a backup location, such as one of the following storage types:
 
@@ -35,4 +36,4 @@ You create a `Secret` object for your storage provider credentials and then you
 [discrete]
 == Additional resources
 
-* Overview of backup locations and snapshot locations in the link:https://velero.io/docs/v1.7/locations/[Velero documentation].
+* Overview of backup locations and snapshot locations in the link:https://{velero-domain}/docs/v1.7/locations/[Velero documentation].
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
@@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[]
 :installing-oadp-aws:
 :credentials: cloud-credentials
 :provider: aws
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
@@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[]
 :installing-oadp-azure:
 :credentials: cloud-credentials-azure
 :provider: azure
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
@@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[]
 :installing-oadp-gcp:
 :credentials: cloud-credentials-gcp
 :provider: gcp
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
@@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[]
 :installing-oadp-mcg:
 :credentials: cloud-credentials
 :provider: aws
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
@@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[]
 :installing-oadp-ocs:
 :credentials: cloud-credentials
 :provider: gcp
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/uninstalling-oadp.adoc b/backup_and_restore/application_backup_and_restore/installing/uninstalling-oadp.adoc
@@ -1,3 +1,4 @@
+:_content-type: ASSEMBLY
 [id="uninstalling-oadp"]
 = Uninstalling the Openshift API for Data Protection
 include::modules/common-attributes.adoc[]
diff --git a/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc b/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
@@ -3,6 +3,7 @@
 = OADP features and plug-ins
 include::modules/common-attributes.adoc[]
 :context: oadp-features-plugins
+:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting.adoc
@@ -6,6 +6,7 @@ include::modules/common-attributes.adoc[]
 :oadp-troubleshooting:
 :namespace: openshift-adp
 :local-product: OADP
+:velero-domain: velero.io
 :must-gather: registry.access.redhat.com/oadp-operator/oadp-must-gather-rhel8:v1.0
 
 toc::[]
diff --git a/backup_and_restore/index.adoc b/backup_and_restore/index.adoc
@@ -4,6 +4,7 @@
 include::modules/common-attributes.adoc[]
 :context: backup-restore-overview
 :backup-restore-overview:
+:velero-domain: velero.netlify.app
 
 toc::[]
 
@@ -34,45 +35,46 @@ You can always recover from a disaster situation by xref:../backup_and_restore/c
 
 As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
 
-// Break the OADP features xref if this is commented out because Travis still tries to validate it  and the build breaks. It must be fixed for release.
-// OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using link:https://velero.io/[Velero 1.7]. OADP backs up and restores persistent volumes (PVs) by using snapshots or Restic. For details, see xref:  ../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
-//
-// .OADP requirements
-//
-// OADP has the following requirements:
-//
-// * You must be logged in as a user with a `cluster-admin` role.
-// * You must have object storage for storing backups, such as one of the following storage types:
-//
-// ** Amazon Web Services
-// ** Microsoft Azure
-// ** Google Cloud Platform
-// ** Multicloud Object Gateway
-// ** S3-compatible object storage, such as Noobaa or Minio
-//
-// :FeatureName: The `CloudStorage` API for S3 storage
-// include::snippets/technology-preview.adoc[]
-//
-// * To back up PVs with snapshots, you must have cloud storage that has a native snapshot API or supports Container Storage Interface (CSI) snapshots, such as the following providers:
-//
-// ** Amazon Web Services
-// ** Microsoft Azure
-// ** Google Cloud Platform
-// ** CSI snapshot-enabled cloud storage, such as Ceph RBD or Ceph FS
-//
-// [NOTE]
-// ====
-// If you do not want to back up PVs by using snapshots, you can use link:https://restic.net/[Restic], which is installed by the OADP Operator by default.
-// ====
-//
-// .Backing up and restoring applications
-//
-// You back up applications by creating a xref:  ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-creating-backup-cr_backing-up-applications[`Backup`]  custom resource (CR). You can configure the following backup options:
-//
-// * xref:  ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-creating-backup-hooks_backing-up-applications[Backup hooks] to run commands before or after the backup operation
-// * xref:  ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-scheduling-backups_backing-up-applications[Scheduled backups]
-// * xref:  ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-applications-restic_backing-up-applications[Restic backups]
-//
-// You restore applications by creating a xref:  ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-cr_restoring-applications[`Restore`] CR. You can configure xref:  ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[restore hooks] to run commands in init containers or in the application container during the restore operation.
+OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using link:https://{velero-domain}/[Velero 1.7]. OADP backs up and restores persistent volumes (PVs) by using snapshots or Restic. For details, see xref:../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
+
+[id="oadp-requirements"]
+=== OADP requirements
+
+OADP has the following requirements:
+
+* You must be logged in as a user with a `cluster-admin` role.
+* You must have object storage for storing backups, such as one of the following storage types:
+
+** Amazon Web Services
+** Microsoft Azure
+** Google Cloud Platform
+** Multicloud Object Gateway
+** S3-compatible object storage, such as Noobaa or Minio
+
+:FeatureName: The `CloudStorage` API for S3 storage
+include::snippets/technology-preview.adoc[]
+
+* To back up PVs with snapshots, you must have cloud storage that has a native snapshot API or supports Container Storage Interface (CSI) snapshots, such as the following providers:
+
+** Amazon Web Services
+** Microsoft Azure
+** Google Cloud Platform
+** CSI snapshot-enabled cloud storage, such as Ceph RBD or Ceph FS
+
+[NOTE]
+====
+If you do not want to back up PVs by using snapshots, you can use link:https://restic.net/[Restic], which is installed by the OADP Operator by default.
+====
+
+[id="backing-up-and-restoring-applications"]
+=== Backing up and restoring applications
+
+You back up applications by creating a xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-creating-backup-cr_backing-up-applications[`Backup`]  custom resource (CR). You can configure the following backup options:
+
+* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-creating-backup-hooks_backing-up-applications[Backup hooks] to run commands before or after the backup operation
+* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-scheduling-backups_backing-up-applications[Scheduled backups]
+* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-applications-restic_backing-up-applications[Restic backups]
+
+You restore applications by creating a xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-cr_restoring-applications[`Restore`] CR. You can configure xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[restore hooks] to run commands in init containers or in the application container during the restore operation.
 
 :backup-restore-overview!:
diff --git a/modules/oadp-backing-up-pvs-csi.adoc b/modules/oadp-backing-up-pvs-csi.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-backing-up-pvs-csi_{context}"]
 = Backing up persistent volumes with CSI snapshots
 
diff --git a/modules/oadp-creating-backup-cr.adoc b/modules/oadp-creating-backup-cr.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-creating-backup-cr_{context}"]
 = Creating a Backup CR
 
diff --git a/modules/oadp-creating-backup-hooks.adoc b/modules/oadp-creating-backup-hooks.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/backing-up-applications.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-creating-backup-hooks_{context}"]
 = Creating backup hooks
 
diff --git a/modules/oadp-creating-restore-cr.adoc b/modules/oadp-creating-restore-cr.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-creating-restore-cr_{context}"]
 = Creating a Restore CR
 
diff --git a/modules/oadp-creating-restore-hooks.adoc b/modules/oadp-creating-restore-hooks.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-creating-restore-hooks_{context}"]
 = Creating restore hooks
 
diff --git a/modules/oadp-creating-secret.adoc b/modules/oadp-creating-secret.adoc
@@ -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
 
+:_content-type: PROCEDURE
 [id="oadp-creating-secret_{context}"]
 = Creating a secret for backup and snapshot locations
 
diff --git a/modules/oadp-enabling-csi-dpa.adoc b/modules/oadp-enabling-csi-dpa.adoc
@@ -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
 
+:_content-type: PROCEDURE
 [id="oadp-enabling-csi-dpa_{context}"]
 = Enabling CSI in the DataProtectionApplication CR
 
diff --git a/modules/oadp-features.adoc b/modules/oadp-features.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
 
+:_content-type: CONCEPT
 [id="oadp-features_{context}"]
 = OADP features
 
diff --git a/modules/oadp-installing-dpa.adoc b/modules/oadp-installing-dpa.adoc
@@ -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
 
+:_content-type: PROCEDURE
 [id="oadp-installing-dpa_{context}"]
 = Installing the Data Protection Application
 
@@ -252,7 +253,7 @@ spec:
           prefix: <prefix> <.>
 ----
 <.> Specify the default plug-in for the backup provider, for example, `gcp`, if appropriate.
-<.> Specify the `csi` default plug-in if you use CSI snapshots to back up PVs. The `csi` plug-in uses the link:https://velero.io/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
+<.> Specify the `csi` default plug-in if you use CSI snapshots to back up PVs. The `csi` plug-in uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
 <.> The `openshift` plug-in is mandatory in order to back up and restore namespaces on an {product-title} cluster.
 <.> Mandatory for CSI.
 <.> Set to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that each worker node has `Restic` pods running. You configure Restic for backups by adding `spec.defaultVolumesToRestic: true` to the `Backup` CR.
diff --git a/modules/oadp-installing-operator.adoc b/modules/oadp-installing-operator.adoc
@@ -6,12 +6,13 @@
 // * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
 // * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
 
+:_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.io/docs/v1.7/[Velero 1.7].
+The OADP Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
 
 .Prerequisites
 
diff --git a/modules/oadp-plugins.adoc b/modules/oadp-plugins.adoc
@@ -2,10 +2,11 @@
 //
 // * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
 
+:_content-type: CONCEPT
 [id="oadp-plugins_{context}"]
 = OADP plug-ins
 
-The OpenShift API for Data Protection (OADP) provides default Velero plug-ins that are integrated with storage providers to support backup and snapshot operations. You can create link:https://velero.io/docs/v1.7/custom-plugins/[custom plug-ins] based on the Velero plug-ins.
+The OpenShift API for Data Protection (OADP) provides default Velero plug-ins that are integrated with storage providers to support backup and snapshot operations. You can create link:https://{velero-domain}/docs/v1.7/custom-plugins/[custom plug-ins] based on the Velero plug-ins.
 
 OADP also provides plug-ins for {product-title} resource backups and Container Storage Interface (CSI) snapshots.
 
@@ -30,5 +31,5 @@ OADP also provides plug-ins for {product-title} resource backups and Container S
 [.small]
 --
 1. Mandatory.
-2. The `csi` plug-in uses the link:https://velero.io/docs/main/csi/[Velero CSI beta snapshot API].
+2. The `csi` plug-in uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot API].
 --
diff --git a/modules/oadp-scheduling-backups.adoc b/modules/oadp-scheduling-backups.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-scheduling-backups_{context}"]
 = Scheduling backups
 
diff --git a/modules/oadp-secrets-for-different-credentials.adoc b/modules/oadp-secrets-for-different-credentials.adoc
@@ -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
 
+:_content-type: PROCEDURE
 [id="oadp-secrets-for-different-credentials_{context}"]
 = Configuring secrets for different backup and snapshot location credentials
 
diff --git a/modules/oadp-self-signed-certificate.adoc b/modules/oadp-self-signed-certificate.adoc
@@ -2,6 +2,7 @@
 //
 // * backup_and_restore/application_backup_and_restore/configuring-oadp.adoc
 
+:_content-type: PROCEDURE
 [id="oadp-self-signed-certificate_{context}"]
 = Enabling self-signed CA certificates
 
diff --git a/modules/oadp-setting-resource-limits-and-requests.adoc b/modules/oadp-setting-resource-limits-and-requests.adoc

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+:_content-type: ASSEMBLY`
`1`	`2`	`[id="uninstalling-oadp"]`
`2`	`3`	`= Uninstalling the Openshift API for Data Protection`
`3`	`4`	`include::modules/common-attributes.adoc[]`