Skip to content

Commit 76af63c

Browse files
apinnickapinnick
authored
Merge pull request #38238 from apinnick/oadp71-introduction
OADP-71: Introduction
2 parents 4cacac0 + 59c5d10 commit 76af63c

File tree

5 files changed

+114
-3
lines changed

5 files changed

+114
-3
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2095,9 +2095,13 @@ Topics:
20952095
File: graceful-cluster-shutdown
20962096
- Name: Restarting a cluster gracefully
20972097
File: graceful-cluster-restart
2098+
# OADP features/plugins is not commented out because commenting it out causes a build fail.
2099+
# Cause: Travis tries to validate commented out xref to OADP features in index file.
20982100
# - Name: Application backup and restore
20992101
# Dir: application_backup_and_restore
21002102
# Topics:
2103+
# - Name: OADP features and plugins
2104+
# File: oadp-features-plugins
21012105
# - Name: Installing OADP
21022106
# Dir: installing
21032107
# Topics:

‎backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[id="oadp-features-plugins"]
2+
= OADP features and plug-ins
3+
include::modules/common-attributes.adoc[]
4+
:context: oadp-features-plugins
5+
6+
toc::[]
7+
8+
The OpenShift API for Data Protection (OADP) supports the following features and plug-ins.
9+
10+
include::modules/oadp-features.adoc[leveloffset=+1]
11+
include::modules/oadp-plugins.adoc[leveloffset=+1]

‎backup_and_restore/index.adoc

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8-
9-
[id="backup-restore-operations-overview"]
10-
== Overview of backup and restore operations in {product-title}
8+
[id="control-plane-backup-restore-operations-overview"]
9+
== Control plane backup and restore operations
1110

1211
As a cluster administrator, you might need to stop an {product-title} cluster for a period and restart it later. Some reasons for restarting a cluster are that you need to perform maintenance on a cluster or want to reduce resource costs. In {product-title}, you can perform a xref:../backup_and_restore/graceful-cluster-shutdown.adoc#graceful-shutdown-cluster[graceful shutdown of a cluster] so that you can easily restart the cluster later.
1312

@@ -27,3 +26,39 @@ You might run into several situations where {product-title} does not work as ex
2726
* You have lost the majority of your control plane hosts, leading to etcd quorum loss.
2827

2928
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.
29+
30+
// [id="application-backup-restore-operations-overview"]
31+
// == Application backup and restore operations
32+
//
33+
// As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
34+
35+
// I am breaking the xref here because Travis tries to validate it even when commented out. It must be fixed for release.
36+
// 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:
37+
38+
// ../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
39+
40+
//
41+
// .OADP requirements
42+
//
43+
// OADP has the following requirements:
44+
//
45+
// * You must be logged in as a user with a `cluster-admin` role.
46+
// * You must have object storage for storing backups, such as one of the following storage types:
47+
//
48+
// ** Amazon Web Services
49+
// ** Microsoft Azure
50+
// ** Google Cloud Platform
51+
// ** Multicloud Object Gateway, a component of OpenShift Container Storage
52+
// ** S3-compatible object storage, such as Noobaa or Minio
53+
//
54+
// :FeatureName: The CloudStorage API for S3 storage
55+
// include::modules/technology-preview.adoc[]
56+
//
57+
// * If you want to back up PVs with snapshots, you must have a cloud provider that has a native snapshot API or supports CSI snapshots, such as the following providers:
58+
//
59+
// ** Amazon Web Services
60+
// ** Microsoft Azure
61+
// ** Google Cloud Platform
62+
// ** Cloud storage that supports CSI snapshots, such as Ceph RBD or Ceph FS
63+
// +
64+
// If you do not want to back up PVs with snapshots, you can use link:https://restic.net/[Restic].

‎modules/oadp-features.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
4+
5+
[id="oadp-features_{context}"]
6+
= OADP features
7+
8+
OpenShift API for Data Protection (OADP) supports the following features:
9+
10+
Backup::
11+
You can back up all resources in your cluster or you can filter the resources by type, namespace, or label.
12+
+
13+
OADP backs up Kubernetes objects and internal images by saving them as an archive file on object storage. OADP backs up persistent volumes (PVs) by creating snapshots with the native snapshot API or with the Container Snapshot Interface (CSI).
14+
+
15+
For storage providers that do not support snapshots, OADP backs up resources and PV data with Restic.
16+
17+
Restore::
18+
You can restore resources and PVs from a backup. You can restore all objects in a backup or filter the restored objects by namespace, PV, or label.
19+
20+
Schedule::
21+
You can schedule backups at specified intervals.
22+
23+
Hooks::
24+
You can use hooks to run commands in a container on a pod, for example, `fsfreeze` to freeze a file system. You can configure a hook to run before or after a backup or restore. Restore hooks can run in an init container or in the application container.
25+
26+
Plugins::
27+
You can install default Velero plug-ins for Amazon Web Services, Google Cloud Platform, or Microsoft Azure. You can install OADP plug-ins for {product-title} resources or CSI snapshots.

‎modules/oadp-plugins.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
4+
5+
[id="oadp-plugins_{context}"]
6+
= OADP plug-ins
7+
8+
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.
9+
10+
OADP also provides plug-ins for {product-title} resource backups and Container Snapshot Interface (CSI) snapshots.
11+
12+
[cols="3", options="header"]
13+
.OADP plug-ins
14+
|===
15+
|OADP plug-in |Function |Storage location
16+
17+
.2+|`aws` |Backs up and restores Kubernetes objects by using object store. |AWS S3
18+
|Backs up and restores volumes by using snapshots. |AWS EBS
19+
20+
.2+|`azure` |Backs up and restores Kubernetes objects by using object store. |Microsoft Azure Blob storage
21+
|Backs up and restores volumes by using snapshots. |Microsoft Azure Managed Disks
22+
23+
.2+|`gcp` |Backs up and restores Kubernetes objects by using object store. |Google Cloud Storage
24+
|Backs up and restores volumes by using snapshots. |Google Compute Engine Disks
25+
26+
|`openshift` |Backs up and restores {product-title} resources by using object store. ^[1]^ |Object store
27+
28+
|`csi` |Backs up and restores volumes by using CSI snapshots. ^[2]^ |Cloud storage that supports CSI snapshots
29+
|===
30+
[.small]
31+
--
32+
1. Mandatory.
33+
2. The `csi` plug-in uses the link:https://velero.io/docs/main/csi/[Velero CSI beta snapshot API].
34+
--

0 commit comments

Comments
 (0)