diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 1e982f2cb8..c2f273ef62 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3483,20 +3483,11 @@ Topics: Topics: - Name: Backing up applications on AWS STS using OADP File: oadp-aws-sts - - Name: OADP 1.2 Data Mover + - Name: OADP Data Mover Dir: installing Topics: - - Name: Introduction to OADP Data Mover - File: data-mover-intro - - Name: Using Data Mover for CSI snapshots - File: oadp-using-data-mover-for-csi-snapshots-doc - - Name: Using OADP 1.2 Data Mover with Ceph storage - File: oadp-12-data-mover-ceph-doc - - Name: OADP 1.3 Data Mover and later - Dir: installing - Topics: - - Name: About the OADP 1.3 Data Mover - File: about-oadp-1-3-data-mover + - Name: About the OADP Data Mover + File: about-oadp-data-mover - Name: Backing up and restoring volumes by using CSI snapshots data movement File: oadp-backup-restore-csi-snapshots - Name: Overriding Kopia algorithms diff --git a/backup_and_restore/application_backup_and_restore/installing/about-oadp-1-3-data-mover.adoc b/backup_and_restore/application_backup_and_restore/installing/about-oadp-data-mover.adoc similarity index 65% rename from backup_and_restore/application_backup_and_restore/installing/about-oadp-1-3-data-mover.adoc rename to backup_and_restore/application_backup_and_restore/installing/about-oadp-data-mover.adoc index 6e4f321bf2..a5b8861b8a 100644 --- a/backup_and_restore/application_backup_and_restore/installing/about-oadp-1-3-data-mover.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/about-oadp-data-mover.adoc @@ -1,27 +1,27 @@ :_mod-docs-content-type: ASSEMBLY -[id="about-oadp-1-3-data-mover"] -= About the OADP 1.3 Data Mover +[id="about-oadp-data-mover"] += About the {oadp-short} Data Mover include::_attributes/common-attributes.adoc[] -:context: about-oadp-1-3-data-mover +:context: about-oadp-data-mover toc::[] -OADP 1.3 includes a built-in Data Mover that you can use to move Container Storage Interface (CSI) volume snapshots to a remote object store. The built-in Data Mover allows you to restore stateful applications from the remote object store if a failure, accidental deletion, or corruption of the cluster occurs. It uses xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-about-kopia.adoc#oadp-about-kopia[Kopia] as the uploader mechanism to read the snapshot data and write to the unified repository. +{oadp-short} includes a built-in Data Mover that you can use to move Container Storage Interface (CSI) volume snapshots to a remote object store. The built-in Data Mover allows you to restore stateful applications from the remote object store if a failure, accidental deletion, or corruption of the cluster occurs. It uses xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-about-kopia.adoc#oadp-about-kopia[Kopia] as the uploader mechanism to read the snapshot data and write to the unified repository. -OADP supports CSI snapshots on the following: +{oadp-short} supports CSI snapshots on the following: -* Red Hat OpenShift Data Foundation +* {odf-full} * Any other cloud storage provider with the Container Storage Interface (CSI) driver that supports the Kubernetes Volume Snapshot API [IMPORTANT] ==== -The OADP built-in Data Mover, which was introduced in OADP 1.3 as a Technology Preview, is now fully supported for both containerized and virtual machine workloads. +The {oadp-short} built-in Data Mover, which was introduced in {oadp-short} 1.3 as a Technology Preview, is now fully supported for both containerized and virtual machine workloads. ==== -[id="enabling-oadp-1-3-data-mover"] +[id="enabling-oadp-data-mover"] == Enabling the built-in Data Mover -To enable the built-in Data Mover, you must include the CSI plugin and enable the node agent in the `DataProtectionApplication` custom resource (CR). The node agent is a Kubernetes daemonset that hosts data movement modules. These include the Data Mover controller, uploader, and the repository. +To enable the built-in Data Mover, you must include the CSI plugin and enable the node agent in the `DataProtectionApplication` custom resource (CR). The node agent is a Kubernetes daemonset that hosts data movement modules. These include the Data Mover controller, uploader, and the repository. .Example `DataProtectionApplication` manifest [source,yaml] @@ -49,7 +49,7 @@ spec: <1> The flag to enable the node agent. <2> The type of uploader. The possible values are `restic` or `kopia`. The built-in Data Mover uses Kopia as the default uploader mechanism regardless of the value of the `uploaderType` field. <3> The CSI plugin included in the list of default plugins. -<4> In OADP 1.3.1 and later, set to `true` if you use Data Mover only for volumes that opt out of `fs-backup`. Set to `false` if you use Data Mover by default for volumes. +<4> In {oadp-short} 1.3.1 and later, set to `true` if you use Data Mover only for volumes that opt out of `fs-backup`. Set to `false` if you use Data Mover by default for volumes. [id="built-in-data-mover-crs"] == Built-in Data Mover controller and custom resource definitions (CRDs) @@ -60,7 +60,7 @@ The built-in Data Mover feature introduces three new API objects defined as CRDs * `DataUpload`: Represents a data upload of a volume snapshot. The CSI plugin creates one `DataUpload` object per CSI snapshot. The `DataUpload` CR includes information about the specified snapshot, the specified Data Mover, the specified backup repository, the progress of the current data upload, and the result of the current data upload after the process is complete. -* `BackupRepository`: Represents and manages the lifecycle of the backup repositories. OADP creates a backup repository per namespace when the first CSI snapshot backup or restore for a namespace is requested. +* `BackupRepository`: Represents and manages the lifecycle of the backup repositories. {oadp-short} creates a backup repository per namespace when the first CSI snapshot backup or restore for a namespace is requested. include::modules/oadp-incremental-backup-support.adoc[leveloffset=+1] 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 index 7574b33bca..ee98527780 100644 --- 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 @@ -48,7 +48,7 @@ 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-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] @@ -60,7 +60,7 @@ include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] [role="_additional-resources_2"] .Additional resources -* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] +* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] * xref:../../../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs[Running tasks in pods using jobs]. :!installing-oadp-aws: 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 index 9c016d1bf3..899a3751c1 100644 --- 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 @@ -36,7 +36,7 @@ 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-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-node-agents.adoc[leveloffset=+2] @@ -46,7 +46,7 @@ include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] +* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] * xref:../../../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs[Running tasks in pods using jobs]. * xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations] 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 index f7c3ead99c..8d39cf3d46 100644 --- 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 @@ -36,7 +36,7 @@ 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-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] @@ -47,7 +47,7 @@ include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] +* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] * xref:../../../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs[Running tasks in pods using jobs]. * xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations] 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 index 7eede8065b..83eea37223 100644 --- 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 @@ -43,7 +43,7 @@ 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-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-node-agents.adoc[leveloffset=+2] @@ -56,7 +56,7 @@ include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] * link:https://access.redhat.com/solutions/6719951[Performance tuning guide for Multicloud Object Gateway]. -* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] +* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] * xref:../../../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs[Running tasks in pods using jobs]. * xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations] 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 index ab9e5b5b38..3cf64bb4fa 100644 --- 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 @@ -46,7 +46,7 @@ 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-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-node-agents.adoc[leveloffset=+2] @@ -57,7 +57,7 @@ include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] +* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins] * xref:../../../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs[Running tasks in pods using jobs]. * xref:../../../backup_and_restore/application_backup_and_restore/installing/configuring-oadp-multiple-bsl.adoc#configuring-oadp-multiple-bsl[Configuring the {oadp-first} with multiple backup storage locations] diff --git a/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc b/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc index 80c7faa3f4..d773453857 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc @@ -37,7 +37,7 @@ include::modules/oadp-storage-class-mapping-oadp.adoc[leveloffset=+3] * xref:../../backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc#oadp-different-kubernetes-api-versions[Working with different Kubernetes API versions on the same cluster]. -* xref:../../backup_and_restore/application_backup_and_restore/installing/oadp-using-data-mover-for-csi-snapshots-doc.adoc#backing-up-applications[Using Data Mover for CSI snapshots]. +* xref:../../backup_and_restore/application_backup_and_restore/installing/oadp-backup-restore-csi-snapshots.adoc#oadp-1-3-backing-csi-snapshots_oadp-backup-restore-csi-snapshots[Using Data Mover for CSI snapshots]. * xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with File System Backup: Kopia or Restic]. diff --git a/backup_and_restore/application_backup_and_restore/oadp-intro.adoc b/backup_and_restore/application_backup_and_restore/oadp-intro.adoc index ab17fc13ff..471e6465bd 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-intro.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-intro.adoc @@ -2,6 +2,7 @@ [id="oadp-introduction"] = Introduction to {oadp-full} include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: oadp-api :namespace: openshift-adp :local-product: OADP @@ -26,6 +27,8 @@ OADP provides the following APIs: * xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-about-backup-snapshot-locations_installing-oadp-aws[BackupStorageLocation] * xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-pvs-csi-doc.adoc#oadp-backing-up-pvs-csi-doc[VolumeSnapshotLocation] +include::modules/oadp-operator-supported.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources diff --git a/modules/oadp-installing-dpa-1-3.adoc b/modules/oadp-installing-dpa-1-3.adoc index 0da3399672..a6a6322266 100644 --- a/modules/oadp-installing-dpa-1-3.adoc +++ b/modules/oadp-installing-dpa-1-3.adoc @@ -9,8 +9,8 @@ // * virt/backup_restore/virt-backup-restore-overview.adoc :_mod-docs-content-type: PROCEDURE -[id="oadp-installing-dpa-1-3_{context}"] -= Installing the Data Protection Application 1.3 +[id="oadp-installing-dpa_{context}"] += Installing the Data Protection Application You install the Data Protection Application (DPA) by creating an instance of the `DataProtectionApplication` API. diff --git a/modules/oadp-operator-supported.adoc b/modules/oadp-operator-supported.adoc new file mode 100644 index 0000000000..c75c0f243f --- /dev/null +++ b/modules/oadp-operator-supported.adoc @@ -0,0 +1,86 @@ +// 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-short} 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 +|10 Jul 2024 +|Release of 1.5 +|Release of 1.6 +a| +27 Jun 2026 + +EUS must be on {OCP-short} 4.16 +a| +27 Jun 2027 + +EUS Term 2 must be on {OCP-short} 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-short} 4.14 +a| +31 Oct 2026 + +EUS Term 2 must be on {OCP-short} 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].