mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-12690: Add OADP to ROSA docs
This commit is contained in:
Ben Hardesty
@@ -1244,12 +1244,100 @@ Topics:
|
||||
# - Name: Using the internal registry
|
||||
# File: rosa-using-internal-registry
|
||||
---
|
||||
Name: Backing up and restoring applications
|
||||
Dir: rosa_backing_up_and_restoring_applications
|
||||
Name: Backup and restore
|
||||
Dir: backup_and_restore
|
||||
Distros: openshift-rosa
|
||||
Topics:
|
||||
- Name: Backing up applications
|
||||
File: backing-up-applications
|
||||
- Name: OADP Application backup and restore
|
||||
Dir: application_backup_and_restore
|
||||
Topics:
|
||||
- Name: Introduction to OpenShift API for Data Protection
|
||||
File: oadp-intro
|
||||
- Name: OADP release notes
|
||||
Dir: release-notes
|
||||
Topics:
|
||||
- Name: OADP 1.4 release notes
|
||||
File: oadp-1-4-release-notes
|
||||
- Name: OADP performance
|
||||
Dir: oadp-performance
|
||||
Topics:
|
||||
- Name: OADP recommended network settings
|
||||
File: oadp-recommended-network-settings
|
||||
- Name: OADP features and plugins
|
||||
File: oadp-features-plugins
|
||||
- Name: OADP use cases
|
||||
Dir: oadp-use-cases
|
||||
Topics:
|
||||
- Name: Backing up an application using OADP with ROSA STS
|
||||
File: oadp-rosa-backup-restore
|
||||
# ODF not supported on ROSA Classic
|
||||
# - Name: Backing up an application using OADP and ODF
|
||||
# File: oadp-usecase-backup-using-odf
|
||||
- Name: Restoring a backup to a different namespace
|
||||
File: oadp-usecase-restore-different-namespace
|
||||
# ODF not supported on ROSA Classic
|
||||
# - Name: Including a self-signed CA certificate during backup
|
||||
# File: oadp-usecase-enable-ca-cert
|
||||
- Name: Installing and configuring OADP
|
||||
Dir: oadp-rosa
|
||||
Topics:
|
||||
- Name: Installing OADP
|
||||
File: oadp-rosa-backing-up-applications
|
||||
- Name: Uninstalling OADP
|
||||
Dir: installing
|
||||
Topics:
|
||||
- Name: Uninstalling OADP
|
||||
File: uninstalling-oadp
|
||||
- Name: OADP backing up
|
||||
Dir: backing_up_and_restoring
|
||||
Topics:
|
||||
- Name: Backing up applications
|
||||
File: backing-up-applications
|
||||
- Name: Creating a Backup CR
|
||||
File: oadp-creating-backup-cr
|
||||
# ROSA docs do not include CSI snapshots
|
||||
# - Name: Backing up persistent volumes with CSI snapshots
|
||||
# File: oadp-backing-up-pvs-csi-doc
|
||||
# - Name: Backing up applications with File System Backup
|
||||
# File: oadp-backing-up-applications-restic-doc
|
||||
- Name: Creating backup hooks
|
||||
File: oadp-creating-backup-hooks-doc
|
||||
- Name: Scheduling backups using Schedule CR
|
||||
File: oadp-scheduling-backups-doc
|
||||
- Name: Deleting backups
|
||||
File: oadp-deleting-backups
|
||||
# - Name: About Kopia
|
||||
# File: oadp-about-kopia
|
||||
- Name: OADP restoring
|
||||
Dir: backing_up_and_restoring
|
||||
Topics:
|
||||
- Name: Restoring applications
|
||||
File: restoring-applications
|
||||
# - Name: OADP and ROSA
|
||||
# Dir: oadp-rosa
|
||||
# Topics:
|
||||
# - Name: Backing up applications on ROSA STS using OADP
|
||||
# File: oadp-rosa-backing-up-applications
|
||||
# - Name: OADP and AWS STS
|
||||
# Dir: aws-sts
|
||||
# Topics:
|
||||
# - Name: Backing up applications on AWS STS using OADP
|
||||
# File: oadp-aws-sts
|
||||
# - Name: OADP Data Mover
|
||||
# Dir: installing
|
||||
# Topics:
|
||||
# - 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
|
||||
# File: overriding-kopia-algorithms
|
||||
# - Name: Troubleshooting
|
||||
# File: troubleshooting
|
||||
# - Name: OADP API
|
||||
# File: oadp-api
|
||||
# - Name: Advanced OADP features and functionalities
|
||||
# File: oadp-advanced-topics
|
||||
---
|
||||
Name: Nodes
|
||||
Dir: nodes
|
||||
|
||||
@@ -383,13 +383,6 @@ Topics:
|
||||
File: generic-ephemeral-vols
|
||||
- Name: Dynamic provisioning
|
||||
File: dynamic-provisioning
|
||||
# ---
|
||||
# Name: Backing up and restoring applications
|
||||
# Dir: rosa_backing_up_and_restoring_applications
|
||||
# Distros: openshift-rosa-hcp
|
||||
# Topics:
|
||||
# - Name: Backing up applications
|
||||
# File: backing-up-applications
|
||||
---
|
||||
Name: Registry
|
||||
Dir: registry
|
||||
@@ -402,6 +395,100 @@ Topics:
|
||||
- Name: Accessing the registry
|
||||
File: accessing-the-registry
|
||||
---
|
||||
Name: Backup and restore
|
||||
Dir: backup_and_restore
|
||||
Distros: openshift-rosa-hcp
|
||||
Topics:
|
||||
- Name: OADP Application backup and restore
|
||||
Dir: application_backup_and_restore
|
||||
Topics:
|
||||
- Name: Introduction to OpenShift API for Data Protection
|
||||
File: oadp-intro
|
||||
- Name: OADP release notes
|
||||
Dir: release-notes
|
||||
Topics:
|
||||
- Name: OADP 1.4 release notes
|
||||
File: oadp-1-4-release-notes
|
||||
- Name: OADP performance
|
||||
Dir: oadp-performance
|
||||
Topics:
|
||||
- Name: OADP recommended network settings
|
||||
File: oadp-recommended-network-settings
|
||||
- Name: OADP features and plugins
|
||||
File: oadp-features-plugins
|
||||
- Name: OADP use cases
|
||||
Dir: oadp-use-cases
|
||||
Topics:
|
||||
- Name: Backing up an application using OADP with ROSA STS
|
||||
File: oadp-rosa-backup-restore
|
||||
- Name: Backing up an application using OADP and ODF
|
||||
File: oadp-usecase-backup-using-odf
|
||||
- Name: Restoring a backup to a different namespace
|
||||
File: oadp-usecase-restore-different-namespace
|
||||
- Name: Including a self-signed CA certificate during backup
|
||||
File: oadp-usecase-enable-ca-cert
|
||||
- Name: Installing and configuring OADP
|
||||
Dir: oadp-rosa
|
||||
Topics:
|
||||
- Name: Installing OADP
|
||||
File: oadp-rosa-backing-up-applications
|
||||
# TODO: Include this when the Operators book is added to ROSA HCP
|
||||
# - Name: Uninstalling OADP
|
||||
# Dir: installing
|
||||
# Topics:
|
||||
# - Name: Uninstalling OADP
|
||||
# File: uninstalling-oadp
|
||||
- Name: OADP backing up
|
||||
Dir: backing_up_and_restoring
|
||||
Topics:
|
||||
- Name: Backing up applications
|
||||
File: backing-up-applications
|
||||
- Name: Creating a Backup CR
|
||||
File: oadp-creating-backup-cr
|
||||
# ROSA docs do not include CSI snapshots
|
||||
# - Name: Backing up persistent volumes with CSI snapshots
|
||||
# File: oadp-backing-up-pvs-csi-doc
|
||||
# - Name: Backing up applications with File System Backup
|
||||
# File: oadp-backing-up-applications-restic-doc
|
||||
- Name: Creating backup hooks
|
||||
File: oadp-creating-backup-hooks-doc
|
||||
- Name: Scheduling backups using Schedule CR
|
||||
File: oadp-scheduling-backups-doc
|
||||
- Name: Deleting backups
|
||||
File: oadp-deleting-backups
|
||||
# - Name: About Kopia
|
||||
# File: oadp-about-kopia
|
||||
- Name: OADP restoring
|
||||
Dir: backing_up_and_restoring
|
||||
Topics:
|
||||
- Name: Restoring applications
|
||||
File: restoring-applications
|
||||
# - Name: OADP and ROSA
|
||||
# Dir: oadp-rosa
|
||||
# Topics:
|
||||
# - Name: Backing up applications on ROSA STS using OADP
|
||||
# File: oadp-rosa-backing-up-applications
|
||||
# - Name: OADP and AWS STS
|
||||
# Dir: aws-sts
|
||||
# Topics:
|
||||
# - Name: Backing up applications on AWS STS using OADP
|
||||
# File: oadp-aws-sts
|
||||
# - Name: OADP Data Mover
|
||||
# Dir: installing
|
||||
# Topics:
|
||||
# - 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
|
||||
# File: overriding-kopia-algorithms
|
||||
# - Name: Troubleshooting
|
||||
# File: troubleshooting
|
||||
# - Name: OADP API
|
||||
# File: oadp-api
|
||||
# - Name: Advanced OADP features and functionalities
|
||||
# File: oadp-advanced-topics
|
||||
---
|
||||
Name: Nodes
|
||||
Dir: nodes
|
||||
Distros: openshift-rosa-hcp
|
||||
|
||||
@@ -13,6 +13,11 @@ Because all taken backup remains until expired, also check the time to live (TTL
|
||||
|
||||
You can back up applications by creating a `Backup` custom resource (CR). For more information, see xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-cr.adoc#oadp-creating-backup-cr-doc[Creating a Backup CR].
|
||||
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
The `Backup` CR creates backup files for Kubernetes resources and internal images on S3 object storage.
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
* The `Backup` CR creates backup files for Kubernetes resources and internal images on S3 object storage.
|
||||
* If your cloud provider has a native snapshot API or supports CSI snapshots, the `Backup` CR backs up persistent volumes (PVs) by creating snapshots. For more information about working with CSI snapshots, see 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[Backing up persistent volumes with CSI snapshots].
|
||||
|
||||
@@ -36,6 +41,7 @@ include::snippets/pod-volume-restore-snapshot-read-only.adoc[]
|
||||
====
|
||||
The {oadp-first} does not support backing up volume snapshots that were created by other software.
|
||||
====
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/oadp-review-backup-restore.adoc[leveloffset=+1]
|
||||
|
||||
@@ -50,16 +56,21 @@ You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. S
|
||||
[id="known-issues-backing-up-applications"]
|
||||
== Known issues
|
||||
|
||||
{ocp} {product-version} enforces a pod security admission (PSA) policy that can hinder the readiness of pods during a Restic restore process.
|
||||
{product-title} {product-version} enforces a pod security admission (PSA) policy that can hinder the readiness of pods during a Restic restore process.
|
||||
|
||||
This issue has been resolved in the OADP 1.1.6 and OADP 1.2.2 releases, therefore it is recommended that users upgrade to these releases.
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
For more information, see xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting.adoc#oadp-restic-restore-failing-psa-policy_oadp-troubleshooting[Restic restore partially failing on OCP 4.15 due to changed PSA policy].
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
// TODO: Add xrefs to ROSA HCP when Operators book is added.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators on clusters for administrators]
|
||||
// This xref is not included in the ROSA docs.
|
||||
ifndef::openshift-rosa[]
|
||||
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Installing Operators in namespaces for non-administrators]
|
||||
|
||||
|
||||
|
||||
endif::openshift-rosa[]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
@@ -18,9 +18,10 @@ include::modules/oadp-creating-restore-hooks.adoc[leveloffset=+1]
|
||||
include::snippets/oadp-image-stream-tag-trigger.adoc[leveloffset=+1]
|
||||
====
|
||||
|
||||
//TODO: Add this xref to ROSA HCP when Images book is added.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../openshift_images/triggering-updates-on-imagestream-changes.adoc#triggering-updates-on-imagestream-changes[Triggering updates on image stream changes]
|
||||
|
||||
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
@@ -14,8 +14,11 @@ include::modules/oadp-features.adoc[leveloffset=+1]
|
||||
include::modules/oadp-plugins.adoc[leveloffset=+1]
|
||||
include::modules/oadp-configuring-velero-plugins.adoc[leveloffset=+1]
|
||||
include::modules/oadp-plugins-receiving-eof-message.adoc[leveloffset=+2]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
include::modules/oadp-supported-architecture.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
[id="oadp-support-for-ibm-power-and-ibm-z"]
|
||||
== OADP support for {ibm-power-title} and {ibm-z-title}
|
||||
|
||||
@@ -30,6 +33,7 @@ OpenShift API for Data Protection (OADP) is platform neutral. The information th
|
||||
include::modules/oadp-ibm-power-test-support.adoc[leveloffset=+2]
|
||||
include::modules/oadp-ibm-z-test-support.adoc[leveloffset=+2]
|
||||
include::modules/oadp-ibm-power-and-z-known-issues.adoc[leveloffset=+3]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/oadp-features-plugins-known-issues.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -11,7 +11,9 @@ toc::[]
|
||||
|
||||
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-short} is also capable of backing up both containerized applications and virtual machines (VMs).
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
However, {oadp-short} 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 {OCP-short} Operators.
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
{oadp-short} support is provided to customer workload namespaces, and cluster scope resources.
|
||||
|
||||
@@ -27,13 +29,17 @@ OADP provides the following APIs:
|
||||
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backup]
|
||||
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[Restore]
|
||||
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#oadp-scheduling-backups-doc[Schedule]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
* 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]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/oadp-operator-supported.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
|
||||
// once finished re-work come back and add doc links to the APIs
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="oadp-rosa-backing-up-applications"]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
= Backing up applications on ROSA clusters using OADP
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
= Installing OADP
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: oadp-rosa-backing-up-applications
|
||||
|
||||
@@ -8,6 +13,7 @@ toc::[]
|
||||
|
||||
You can use {oadp-first} with {product-rosa} (ROSA) clusters to back up and restore application data.
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
ROSA is a fully-managed, turnkey application platform that allows you to deliver value to your customers by building and deploying applications.
|
||||
|
||||
ROSA provides seamless integration with a wide range of {aws-first} compute, database, analytics, machine learning, networking, mobile, and other services to speed up the building and delivery of differentiating experiences to your customers.
|
||||
@@ -17,6 +23,7 @@ You can subscribe to the service directly from your {aws-short} account.
|
||||
After you create your clusters, you can operate your clusters with the {product-title} web console or through link:https://docs.openshift.com/dedicated/ocm/ocm-overview.html[{cluster-manager-first}]. You can also use ROSA with OpenShift APIs and command-line interface (CLI) tools.
|
||||
|
||||
For additional information about ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red Hat OpenShift Service on AWS (ROSA) interactive walkthrough].
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
Before installing {oadp-first}, you must set up role and policy credentials for OADP so that it can use the {aws-full} API.
|
||||
|
||||
@@ -31,13 +38,18 @@ include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
// This xref points to a topic that is not published in the ROSA docs.
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console].
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]
|
||||
|
||||
// For ROSA and ROSA HCP, this section is in oadp-use-cases/oadp-rosa-backup-restore.adoc
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
[id="oadp-rosa-backing-up-and-cleaning"]
|
||||
== Example: Backing up workload on OADP ROSA STS, with an optional cleanup
|
||||
|
||||
include::modules/performing-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/cleanup-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="oadp-rosa-backing-up-and-cleaning-example"]
|
||||
= Backing up workloads on OADP with ROSA STS
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: oadp-rosa-backing-up-and-cleaning-example
|
||||
|
||||
toc::[]
|
||||
|
||||
include::modules/performing-a-backup-oadp-rosa-sts.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/cleanup-a-backup-oadp-rosa-sts.adoc[leveloffset=+1]
|
||||
@@ -19,9 +19,12 @@ include::modules/oadp-1-4-0-release-notes.adoc[leveloffset=+1]
|
||||
include::modules/oadp-backing-up-dpa-configuration-1-4-0.adoc[leveloffset=+3]
|
||||
include::modules/oadp-upgrading-oadp-operator-1-4-0.adoc[leveloffset=+3]
|
||||
|
||||
// TODO: Include this xref when the Operators book is added to the ROSA HCP docs.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Updating installed Operators]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
[id="oadp-converting-dpa-to-new-version-1-4-0_{context}"]
|
||||
=== Converting DPA to the new version
|
||||
|
||||
@@ -46,8 +46,10 @@ $ cat <<EOF > ${SCRATCH}/credentials
|
||||
[default]
|
||||
role_arn = ${ROLE_ARN}
|
||||
web_identity_token_file = /var/run/secrets/openshift/serviceaccount/token
|
||||
region = <aws_region> <1>
|
||||
EOF
|
||||
----
|
||||
<1> The AWS region in which the cloud resources have been created.
|
||||
|
||||
.. Create a namespace for OADP:
|
||||
+
|
||||
|
||||
@@ -116,7 +116,11 @@ link:https://issues.redhat.com/browse/OADP-4407[OADP-4407]
|
||||
|
||||
During a File System Backup (FSB) restore operation, a `Deployment` resource referencing an `ImageStream` is not restored properly. The restored pod that runs the FSB, and the `postHook` is terminated prematurely.
|
||||
|
||||
During the restore operation, the {ocp} controller updates the `spec.template.spec.containers[0].image` field in the `Deployment` resource with an updated `ImageStreamTag` hash. The update triggers the rollout of a new pod, terminating the pod on which `velero` runs the FSB along with the post-hook. For more information about image stream trigger, see xref:../../../openshift_images/triggering-updates-on-imagestream-changes.adoc#triggering-updates-on-imagestream-changes[Triggering updates on image stream changes].
|
||||
During the restore operation, the {ocp} controller updates the `spec.template.spec.containers[0].image` field in the `Deployment` resource with an updated `ImageStreamTag` hash. The update triggers the rollout of a new pod, terminating the pod on which `velero` runs the FSB along with the post-hook.
|
||||
// TODO: Include this xref when the Images book is added to ROSA HCP.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
For more information about image stream trigger, see xref:../../../openshift_images/triggering-updates-on-imagestream-changes.adoc#triggering-updates-on-imagestream-changes[Triggering updates on image stream changes].
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
The workaround for this behavior is a two-step restore process:
|
||||
|
||||
|
||||
@@ -18,8 +18,10 @@ Both types of plugin are optional, but most users configure at least one cloud p
|
||||
You can install any of the following default Velero cloud provider plugins when you configure the `oadp_v1alpha1_dpa.yaml` file during deployment:
|
||||
|
||||
* `aws` (Amazon Web Services)
|
||||
ifndef::openshift-rosa[]
|
||||
* `gcp` (Google Cloud Platform)
|
||||
* `azure` (Microsoft Azure)
|
||||
endif::openshift-rosa[]
|
||||
* `openshift` (OpenShift Velero plugin)
|
||||
* `csi` (Container Storage Interface)
|
||||
* `kubevirt` (KubeVirt)
|
||||
|
||||
@@ -18,11 +18,13 @@ OADP also provides plugins for {product-title} resource backups, OpenShift Virtu
|
||||
.2+|`aws` |Backs up and restores Kubernetes objects. |AWS S3
|
||||
|Backs up and restores volumes with snapshots. |AWS EBS
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
.2+|`azure` |Backs up and restores Kubernetes objects. |Microsoft Azure Blob storage
|
||||
|Backs up and restores volumes with snapshots. |Microsoft Azure Managed Disks
|
||||
|
||||
.2+|`gcp` |Backs up and restores Kubernetes objects. |Google Cloud Storage
|
||||
|Backs up and restores volumes with snapshots. |Google Compute Engine Disks
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
|`openshift` |Backs up and restores {product-title} resources. ^[1]^ |Object store
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * backup_and_restore/application_backup_and_restore/oadp-rosa/oadp-rosa-backing-up-applications.adoc
|
||||
// * backup_and_restore/application_backup_and_restore/installing-oadp-rosa.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="preparing-aws-credentials-for-oadp_{context}"]
|
||||
@@ -75,9 +76,9 @@ $ if [[ -z "${POLICY_ARN}" ]]; then
|
||||
"s3:PutObject",
|
||||
"s3:DeleteObject",
|
||||
"s3:ListBucketMultipartUploads",
|
||||
"s3:AbortMultipartUploads",
|
||||
"s3:AbortMultipartUpload",
|
||||
"s3:ListMultipartUploadParts",
|
||||
"s3:DescribeSnapshots",
|
||||
"ec2:DescribeSnapshots",
|
||||
"ec2:DescribeVolumes",
|
||||
"ec2:DescribeVolumeAttribute",
|
||||
"ec2:DescribeVolumesModifications",
|
||||
@@ -89,7 +90,7 @@ $ if [[ -z "${POLICY_ARN}" ]]; then
|
||||
],
|
||||
"Resource": "*"
|
||||
}
|
||||
]}
|
||||
]}
|
||||
EOF
|
||||
|
||||
POLICY_ARN=$(aws iam create-policy --policy-name "RosaOadpVer1" \
|
||||
@@ -117,7 +118,7 @@ $ echo ${POLICY_ARN}
|
||||
----
|
||||
$ cat <<EOF > ${SCRATCH}/trust-policy.json
|
||||
{
|
||||
"Version":2012-10-17",
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [{
|
||||
"Effect": "Allow",
|
||||
"Principal": {
|
||||
@@ -143,8 +144,12 @@ EOF
|
||||
$ ROLE_ARN=$(aws iam create-role --role-name \
|
||||
"${ROLE_NAME}" \
|
||||
--assume-role-policy-document file://${SCRATCH}/trust-policy.json \
|
||||
--tags Key=rosa_cluster_id,Value=${ROSA_CLUSTER_ID} Key=rosa_openshift_version,Value=${CLUSTER_VERSION} Key=rosa_role_prefix,Value=ManagedOpenShift Key=operator_namespace,Value=openshift-adp Key=operator_name,Value=openshift-oadp \
|
||||
--query Role.Arn --output text)
|
||||
--tags Key=rosa_cluster_id,Value=${ROSA_CLUSTER_ID} \
|
||||
Key=rosa_openshift_version,Value=${CLUSTER_VERSION} \
|
||||
Key=rosa_role_prefix,Value=ManagedOpenShift \
|
||||
Key=operator_namespace,Value=openshift-adp \
|
||||
Key=operator_name,Value=openshift-oadp \
|
||||
--query Role.Arn --output text)
|
||||
----
|
||||
|
||||
.. View the role ARN by running the following command:
|
||||
@@ -161,5 +166,3 @@ $ echo ${ROLE_ARN}
|
||||
$ aws iam attach-role-policy --role-name "${ROLE_NAME}" \
|
||||
--policy-arn ${POLICY_ARN}
|
||||
----
|
||||
|
||||
|
||||
|
||||
@@ -73,7 +73,7 @@ ifdef::openshift-rosa-hcp[]
|
||||
link:https://docs.openshift.com/rosa/rosa_backing_up_and_restoring_applications/backing-up-applications.html#rosa-backing-up-applications[Back up and restore]
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#rosa-backing-up-applications[Back up and restore]
|
||||
xref:../backup_and_restore/application_backup_and_restore/oadp-intro.adoc#oadp-api[Back up and restore]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
|
||||
xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle]
|
||||
@@ -160,7 +160,7 @@ ifdef::openshift-rosa-hcp[]
|
||||
link:https://docs.openshift.com/rosa/rosa_backing_up_and_restoring_applications/backing-up-applications.html#rosa-backing-up-applications[Back up and restore]
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#rosa-backing-up-applications[Back up and restore]
|
||||
xref:../backup_and_restore/application_backup_and_restore/oadp-intro.adoc#oadp-api[Back up and restore]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../_attributes/
|
||||
@@ -1,53 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="rosa-backing-up-applications"]
|
||||
= Backing up applications
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: rosa-backing-up-applications
|
||||
|
||||
toc::[]
|
||||
|
||||
You can employ OpenShift API for Data Protection (OADP) with Red{nbsp}Hat OpenShift Service on AWS (ROSA) clusters to backup and restore application data. Before installing OADP, you must set up role and policy credentials for OADP so that it can use the AWS API.
|
||||
|
||||
This is a two stage process:
|
||||
|
||||
. Prepare AWS credentials.
|
||||
. Install the OADP Operator and provide it with the IAM role.
|
||||
|
||||
include::modules/oadp-preparing-aws-credentials.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="oadp-addtl-resources_{context}"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#oadp-preparing-aws-credentials_rosa-backing-up-applications[Preparing AWS credentials]
|
||||
|
||||
//Added the following two modules to make a more complete guide.
|
||||
|
||||
[id="oadp-rosa-backing-up-and-cleaning-example"]
|
||||
== Backing up workloads on OADP with ROSA STS
|
||||
|
||||
include::modules/performing-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/cleanup-a-backup-oadp-rosa-sts.adoc[leveloffset=+2]
|
||||
|
||||
[id="rosa-backing-up-applications-known-issues"]
|
||||
== Known issues
|
||||
|
||||
* Restic, Kopia, and DataMover are not supported or recommended.
|
||||
* link:https://issues.redhat.com/browse/OADP-1054[CloudStorage: openshift-adp-controller-manager crashloop seg fault with Restic enabled].
|
||||
* (Affects OADP 1.1.x_ only): link:https://issues.redhat.com/browse/OADP-1055[CloudStorage: bucket is removed on CS CR delete, although it doesn't have "oadp.openshift.io/cloudstorage-delete": "true"].
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_rosa-backing-up-applications"]
|
||||
== Additional resources
|
||||
|
||||
* For information about ROSA architecture, see xref:../rosa_architecture/rosa-understanding.adoc#rosa-understanding-about_rosa-understanding[Understanding ROSA].
|
||||
* For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
|
||||
* For steps to deploy a ROSA cluster using manual mode, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-cluster-using-customizations_rosa-sts-creating-a-cluster-with-customizations[Creating a cluster using customizations].
|
||||
* For more information about the AWS Identity Access Management (IAM) resources required to deploy {product-title} with STS, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources for clusters that use STS].
|
||||
* For more information about OADP, see link:https://docs.openshift.com/container-platform/4.13/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.html[About installing OADP].
|
||||
* For more information about CSI volumes, see link:https://docs.openshift.com/container-platform/4.13/storage/container_storage_interface/persistent-storage-csi.html[Configuring CSI volumes].
|
||||
* For more information about storage options for ROSA, see xref:../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-storage_rosa-service-definition[ROSA storage options].
|
||||
* For steps to contact Red{nbsp}Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS].
|
||||
@@ -1 +0,0 @@
|
||||
../images/
|
||||
@@ -1 +0,0 @@
|
||||
../modules
|
||||
@@ -1 +0,0 @@
|
||||
../snippets/
|
||||
@@ -31,7 +31,7 @@ Use the following sections to find content to help you learn about and use {hcp-
|
||||
| Learn about {hcp-title} |Plan {hcp-title} deployment |Additional resources
|
||||
|
||||
| xref:../architecture/index.adoc#architecture-overview[Architecture overview]
|
||||
| xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#rosa-backing-up-applications[Back up and restore]
|
||||
| xref:../backup_and_restore/application_backup_and_restore/oadp-intro.adoc#oadp-api[Back up and restore]
|
||||
| xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle]
|
||||
|
||||
| xref:../architecture/rosa-architecture-models.adoc#rosa-architecture-models[{hcp-title} architecture]
|
||||
@@ -61,8 +61,8 @@ Use the following sections to find content to help you learn about and use {hcp-
|
||||
| xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview_virt-monitoring-overview[Monitoring overview]
|
||||
| xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle]
|
||||
|
||||
|
|
||||
| xref:../rosa_backing_up_and_restoring_applications/backing-up-applications.adoc#rosa-backing-up-applications[Back up and restore]
|
||||
|
|
||||
| xref:../backup_and_restore/application_backup_and_restore/oadp-intro.adoc#oadp-api[Back up and restore]
|
||||
|
|
||||
|
|
||||
|
||||
|
||||
Reference in New Issue
Block a user