Skip to content

Commit ca879bd

Browse files
authored
Merge pull request #64198 from anarnold97/Re-structure-of-OADP-introduction
OADP-2130: Restructure of the OADP Introduction
2 parents 0c15d85 + b46db75 commit ca879bd

File tree

3 files changed

+39
-2
lines changed

3 files changed

+39
-2
lines changed

_attributes/common-attributes.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ endif::openshift-origin[]
4343
:hybrid-console: Red Hat Hybrid Cloud Console
4444
:hybrid-console-second: Hybrid Cloud Console
4545
:oadp-first: OpenShift API for Data Protection (OADP)
46+
:oadp-full: OpenShift API for Data Protection
4647
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
4748
:product-registry: OpenShift image registry
4849
:rh-storage-first: Red Hat OpenShift Data Foundation
@@ -60,7 +61,7 @@ endif::openshift-origin[]
6061
:secondary-scheduler-operator: Secondary Scheduler Operator
6162
// Backup and restore
6263
:velero-domain: velero.io
63-
:velero-version: 1.9
64+
:velero-version: 1.11
6465
:launch: image:app-launcher.png[title="Application Launcher"]
6566
:mtc-short: MTC
6667
:mtc-full: Migration Toolkit for Containers

_topic_maps/_topic_map.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2717,9 +2717,11 @@ Topics:
27172717
File: graceful-cluster-shutdown
27182718
- Name: Restarting a cluster gracefully
27192719
File: graceful-cluster-restart
2720-
- Name: Application backup and restore
2720+
- Name: OADP Application backup and restore
27212721
Dir: application_backup_and_restore
27222722
Topics:
2723+
- Name: Introduction to OpenShift API for Data Protection
2724+
File: oadp-intro
27232725
- Name: OADP release notes
27242726
File: oadp-release-notes
27252727
- Name: OADP features and plugins
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:_content-type: ASSEMBLY
2+
[id="oadp-introduction"]
3+
= Introduction to {oadp-full}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: oadp-api
6+
:namespace: openshift-adp
7+
:local-product: OADP
8+
9+
toc::[]
10+
11+
The {oadp-first} product safeguards customer applications on {product-title}. It offers comprehensive disaster recovery protection, covering {product-title} applications, application-related cluster resources, persistent volumes, and internal images. OADP is also capable of backing up both containerized applications and virtual machines (VMs).
12+
13+
However, OADP does not serve as a disaster recovery solution for xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd] or OpenShift Operators.
14+
15+
16+
[id="oadp-apis_{context}"]
17+
= {oadp-full} APIs
18+
19+
{oadp-first} provides APIs that enable multiple approaches to customizing backups and preventing the inclusion of unnecessary or inappropriate resources.
20+
21+
OADP provides the following APIs:
22+
23+
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backup]
24+
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[Restore]
25+
* Schedule
26+
* BackupStorageLocation
27+
* VolumeSnapshotLocation
28+
29+
[role="_additional-resources"]
30+
.Additional resources
31+
32+
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
33+
// once finished re-work come back and add doc links to the APIs
34+

0 commit comments

Comments
 (0)