Skip to content

Commit 9a3f8de

Browse files
authored
Merge pull request #41614 from apinnick/oadp-ga-release
uncomment OADP for 1.0 GA
2 parents 6af25f9 + 4478267 commit 9a3f8de

File tree

2 files changed

+79
-79
lines changed

2 files changed

+79
-79
lines changed

_topic_maps/_topic_map.yml

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2099,37 +2099,37 @@ Topics:
20992099
File: graceful-cluster-shutdown
21002100
- Name: Restarting a cluster gracefully
21012101
File: graceful-cluster-restart
2102-
# - Name: Application backup and restore
2103-
# Dir: application_backup_and_restore
2104-
# Topics:
2105-
# - Name: OADP features and plugins
2106-
# File: oadp-features-plugins
2107-
# - Name: Installing and configuring OADP
2108-
# Dir: installing
2109-
# Topics:
2110-
# - Name: About installing OADP
2111-
# File: about-installing-oadp
2112-
# - Name: Installing and configuring OADP with AWS
2113-
# File: installing-oadp-aws
2114-
# - Name: Installing and configuring OADP with Azure
2115-
# File: installing-oadp-azure
2116-
# - Name: Installing and configuring OADP with GCP
2117-
# File: installing-oadp-gcp
2118-
# - Name: Installing and configuring OADP with MCG
2119-
# File: installing-oadp-mcg
2120-
# - Name: Installing and configuring OADP with OCS
2121-
# File: installing-oadp-ocs
2122-
# - Name: Uninstalling OADP
2123-
# File: uninstalling-oadp
2124-
# - Name: Backing up and restoring
2125-
# Dir: backing_up_and_restoring
2126-
# Topics:
2127-
# - Name: Backing up applications
2128-
# File: backing-up-applications
2129-
# - Name: Restoring applications
2130-
# File: restoring-applications
2131-
# - Name: Troubleshooting
2132-
# File: troubleshooting
2102+
- Name: Application backup and restore
2103+
Dir: application_backup_and_restore
2104+
Topics:
2105+
- Name: OADP features and plugins
2106+
File: oadp-features-plugins
2107+
- Name: Installing and configuring OADP
2108+
Dir: installing
2109+
Topics:
2110+
- Name: About installing OADP
2111+
File: about-installing-oadp
2112+
- Name: Installing and configuring OADP with AWS
2113+
File: installing-oadp-aws
2114+
- Name: Installing and configuring OADP with Azure
2115+
File: installing-oadp-azure
2116+
- Name: Installing and configuring OADP with GCP
2117+
File: installing-oadp-gcp
2118+
- Name: Installing and configuring OADP with MCG
2119+
File: installing-oadp-mcg
2120+
- Name: Installing and configuring OADP with OCS
2121+
File: installing-oadp-ocs
2122+
- Name: Uninstalling OADP
2123+
File: uninstalling-oadp
2124+
- Name: Backing up and restoring
2125+
Dir: backing_up_and_restoring
2126+
Topics:
2127+
- Name: Backing up applications
2128+
File: backing-up-applications
2129+
- Name: Restoring applications
2130+
File: restoring-applications
2131+
- Name: Troubleshooting
2132+
File: troubleshooting
21332133
- Name: Control plane backup and restore
21342134
Dir: control_plane_backup_and_restore
21352135
Topics:

backup_and_restore/index.adoc

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
include::modules/common-attributes.adoc[]
55
:context: backup-restore-overview
66
:backup-restore-overview:
7-
:velero-domain: velero.netlify.app
7+
:velero-domain: velero.io
88

99
toc::[]
1010

@@ -30,52 +30,52 @@ You might run into several situations where {product-title} does not work as ex
3030

3131
You can always recover from a disaster situation by xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restoring your cluster to its previous state] using the saved etcd snapshots.
3232

33-
// [id="application-backup-restore-operations-overview"]
34-
// == Application backup and restore operations
35-
//
36-
// As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
37-
//
38-
// xref links are broken so that the PR will build. Travis tries to verify commented out xrefs.
39-
// 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].
40-
//
41-
// [id="oadp-requirements"]
42-
// === OADP requirements
43-
//
44-
// OADP has the following requirements:
45-
//
46-
// * You must be logged in as a user with a `cluster-admin` role.
47-
// * You must have object storage for storing backups, such as one of the following storage types:
48-
//
49-
// ** Amazon Web Services
50-
// ** Microsoft Azure
51-
// ** Google Cloud Platform
52-
// ** Multicloud Object Gateway
53-
// ** S3-compatible object storage, such as Noobaa or Minio
54-
//
55-
// :FeatureName: The `CloudStorage` API for S3 storage
56-
// include::snippets/technology-preview.adoc[]
57-
//
58-
// * 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:
59-
//
60-
// ** Amazon Web Services
61-
// ** Microsoft Azure
62-
// ** Google Cloud Platform
63-
// ** CSI snapshot-enabled cloud storage, such as Ceph RBD or Ceph FS
64-
//
65-
// [NOTE]
66-
// ====
67-
// 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.
68-
// ====
69-
//
70-
// [id="backing-up-and-restoring-applications"]
71-
// === Backing up and restoring applications
72-
//
73-
// 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:
74-
//
75-
// * 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
76-
// * xref: ../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-scheduling-backups_backing-up-applications[Scheduled backups]
77-
// * 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]
78-
//
79-
// 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.
33+
[id="application-backup-restore-operations-overview"]
34+
== Application backup and restore operations
35+
36+
As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
37+
38+
// Velero 1.7 is no longer latest version. However, it is the officially supported version, so do not change the version number without confirmation from PM.
39+
OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using link:https://{velero-domain}/docs/v1.7/[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].
40+
41+
[id="oadp-requirements"]
42+
=== OADP requirements
43+
44+
OADP has the following requirements:
45+
46+
* You must be logged in as a user with a `cluster-admin` role.
47+
* You must have object storage for storing backups, such as one of the following storage types:
48+
49+
** Amazon Web Services
50+
** Microsoft Azure
51+
** Google Cloud Platform
52+
** Multicloud Object Gateway
53+
** S3-compatible object storage, such as Noobaa or Minio
54+
55+
:FeatureName: The `CloudStorage` API for S3 storage
56+
include::snippets/technology-preview.adoc[]
57+
58+
* 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:
59+
60+
** Amazon Web Services
61+
** Microsoft Azure
62+
** Google Cloud Platform
63+
** CSI snapshot-enabled cloud storage, such as Ceph RBD or Ceph FS
64+
65+
[NOTE]
66+
====
67+
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.
68+
====
69+
70+
[id="backing-up-and-restoring-applications"]
71+
=== Backing up and restoring applications
72+
73+
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:
74+
75+
* 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
76+
* xref:../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-scheduling-backups_backing-up-applications[Scheduled backups]
77+
* 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]
78+
79+
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.
8080

8181
:backup-restore-overview!:

0 commit comments

Comments
 (0)