mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-06 06:46:26 +01:00
OADP-71: Introduction
This commit is contained in:
Avital Pinnick
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
82122266bb
commit
5ee4e094e7
@@ -2085,6 +2085,8 @@ Topics:
|
||||
# - Name: Application backup and restore
|
||||
# Dir: application_backup_and_restore
|
||||
# Topics:
|
||||
# - Name: OADP features and plugins
|
||||
# File: oadp-features-plugins
|
||||
# - Name: Installing OADP
|
||||
# Dir: installing
|
||||
# Topics:
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[id="oadp-features-plugins"]
|
||||
= OADP features and plug-ins
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: oadp-features-plugins
|
||||
|
||||
toc::[]
|
||||
|
||||
The OpenShift API for Data Protection (OADP) supports the following features and plug-ins.
|
||||
|
||||
include::modules/oadp-features.adoc[leveloffset=+1]
|
||||
include::modules/oadp-plugins.adoc[leveloffset=+1]
|
||||
@@ -5,9 +5,8 @@ include::modules/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
[id="backup-restore-operations-overview"]
|
||||
== Overview of backup and restore operations in {product-title}
|
||||
[id="control-plane-backup-restore-operations-overview"]
|
||||
== Control plane backup and restore operations
|
||||
|
||||
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.
|
||||
|
||||
@@ -27,3 +26,37 @@ You might run into several situations where {product-title} does not work as ex
|
||||
* You have lost the majority of your control plane hosts, leading to etcd quorum loss.
|
||||
|
||||
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.
|
||||
|
||||
// [id="application-backup-restore-operations-overview"]
|
||||
// == Application backup and restore operations
|
||||
//
|
||||
// As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
|
||||
//
|
||||
// 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].
|
||||
//
|
||||
// You can install OADP with xref:../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-plugins_oadp-features-plugins[default plugins] that support cloud providers, Container Snapshot Interface (CSI) snapshots, and {product-title} resources.
|
||||
//
|
||||
// .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, a component of OpenShift Container Storage
|
||||
// ** S3-compatible object storage, such as Noobaa or Minio
|
||||
//
|
||||
// :FeatureName: The CloudStorage API for S3 storage
|
||||
// include::modules/technology-preview.adoc[]
|
||||
//
|
||||
// * 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:
|
||||
//
|
||||
// ** Amazon Web Services
|
||||
// ** Microsoft Azure
|
||||
// ** Google Cloud Platform
|
||||
// ** Cloud storage that supports CSI snapshots, such as Ceph RBD or Ceph FS
|
||||
// +
|
||||
// If you do not want to back up PVs with snapshots, you can use link:https://restic.net/[Restic].
|
||||
|
||||
27
modules/oadp-features.adoc
Normal file
27
modules/oadp-features.adoc
Normal file
@@ -0,0 +1,27 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
|
||||
|
||||
[id="oadp-features_{context}"]
|
||||
= OADP features
|
||||
|
||||
OpenShift API for Data Protection (OADP) supports the following features:
|
||||
|
||||
Backup::
|
||||
You can back up all resources in your cluster or you can filter the resources by type, namespace, or label.
|
||||
+
|
||||
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).
|
||||
+
|
||||
For storage providers that do not support snapshots, OADP backs up resources and PV data with Restic.
|
||||
|
||||
Restore::
|
||||
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.
|
||||
|
||||
Schedule::
|
||||
You can schedule backups at specified intervals.
|
||||
|
||||
Hooks::
|
||||
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.
|
||||
|
||||
Plugins::
|
||||
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.
|
||||
34
modules/oadp-plugins.adoc
Normal file
34
modules/oadp-plugins.adoc
Normal file
@@ -0,0 +1,34 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
|
||||
|
||||
[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.
|
||||
|
||||
OADP also provides plug-ins for {product-title} resource backups and Container Snapshot Interface (CSI) snapshots.
|
||||
|
||||
[cols="3", options="header"]
|
||||
.OADP plug-ins
|
||||
|===
|
||||
|OADP plug-in |Function |Storage location
|
||||
|
||||
.2+|`aws` |Backs up and restores Kubernetes objects by using object store. |AWS S3
|
||||
|Backs up and restores volumes by using snapshots. |AWS EBS
|
||||
|
||||
.2+|`azure` |Backs up and restores Kubernetes objects by using object store. |Microsoft Azure Blob storage
|
||||
|Backs up and restores volumes by using snapshots. |Microsoft Azure Managed Disks
|
||||
|
||||
.2+|`gcp` |Backs up and restores Kubernetes objects by using object store. |Google Cloud Storage
|
||||
|Backs up and restores volumes by using snapshots. |Google Compute Engine Disks
|
||||
|
||||
|`openshift` |Backs up and restores {product-title} resources by using object store. ^[1]^ |Object store
|
||||
|
||||
|`csi` |Backs up and restores volumes by using CSI snapshots. ^[2]^ |Cloud storage that supports CSI snapshots
|
||||
|===
|
||||
[.small]
|
||||
--
|
||||
1. Mandatory.
|
||||
2. The `csi` plug-in uses the link:https://velero.io/docs/main/csi/[Velero CSI beta snapshot API].
|
||||
--
|
||||
Reference in New Issue
Block a user