Skip to content

OADP-6353 Added role to mark DITA descriptions #95784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: enterprise-4.19
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
This document provides information about advanced features and functionalities of OpenShift API for Data Protection (OADP).

[id="oadp-different-kubernetes-api-versions"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
OpenShift API for Data Protection (OADP) features provide options for backing up and restoring applications.

The default plugins enable Velero to integrate with certain cloud providers and to back up and restore {product-title} resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

[role="_abstract"]
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[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

[role="_abstract"]
For a supported experience with {oadp-first}, you should have a stable and resilient network across {OCP-short} nodes, S3 storage, and in supported cloud environments that meet {OCP-short} network requirement recommendations.

To ensure successful backup and restore operations for deployments with remote S3 buckets located off-cluster with suboptimal data paths, it is recommended that your network settings meet the following minimum requirements in such less optimal conditions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

[role="_abstract"]
The release notes for {oadp-first} describe new features and enhancements, deprecated features, product recommendations, known issues, and resolved issues.

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

[role="_abstract"]
The release notes for {oadp-first} describe new features and enhancements, deprecated features, product recommendations, known issues, and resolved issues.

[NOTE]
Expand Down
1 change: 1 addition & 0 deletions modules/changes-from-oadp-1-4-to-1-5.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="changes-from-oadp-1-4-to-1-5_{context}"]
= Changes from OADP 1.4 to 1.5

[role="_abstract"]
The Velero server has been updated from version 1.14 to 1.16.

This changes the following:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="converting-dpa-to-the-new-version-for-oadp-1-5-0_{context}"]
= Converting DPA to the new version for OADP 1.5.0

[role="_abstract"]
The {oadp-first} 1.4 is not supported on {OCP-short} 4.19. You can convert Data Protection Application (DPA) to the new {oadp-short} 1.5 version by using the new `spec.configuration.nodeAgent` field and its sub-fields.

.Procedure
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-backing-up-dpa-configuration-1-5-0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-backing-up-dpa-configuration-1-5-0_{context}"]
= Backing up the DPA configuration

[role="_abstract"]
You must back up your current `DataProtectionApplication` (DPA) configuration.

.Procedure
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-configuring-velero-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-configuring-velero-plugins_{context}"]
= About OADP Velero plugins

[role="_abstract"]
You can configure two types of plugins when you install Velero:

* Default cloud provider plugins
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-features-plugins-known-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="oadp-features-plugins-known-issues_{context}"]
= OADP plugins known issues

[role="_abstract"]
The following section describes known issues in {oadp-first} plugins:

[id="velero-plugin-panic_{context}"]
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-features_{context}"]
= OADP features

[role="_abstract"]
OpenShift API for Data Protection (OADP) supports the following features:

Backup::
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-fips.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="oadp-fips_{context}"]
= OADP and FIPS

[role="_abstract"]
Federal Information Processing Standards (FIPS) are a set of computer security standards developed by the United States federal government in line with the Federal Information Security Management Act (FISMA).

{oadp-first} has been tested and works on FIPS-enabled {product-title} clusters.
1 change: 1 addition & 0 deletions modules/oadp-ibm-power-and-z-known-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@
[id="oadp-ibm-power-and-z-known-issues_{context}"]
= Known issue of OADP using {ibm-power-name} and {ibm-z-name} platforms

[role="_abstract"]
* Currently, there are backup method restrictions for {sno-caps} clusters deployed on {ibm-power-name} and {ibm-z-name} platforms. Only NFS storage is currently compatible with {sno-caps} clusters on these platforms. In addition, only the File System Backup (FSB) methods such as Kopia and Restic are supported for backup and restore operations. There is currently no workaround for this issue.
1 change: 1 addition & 0 deletions modules/oadp-ibm-power-test-support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-ibm-power-test-matrix_{context}"]
= OADP support for target backup locations using {ibm-power-title}

[role="_abstract"]
* {ibm-power-name} running with {product-title} 4.12, 4.13, 4.14, and 4.15, and {oadp-short} {oadp-version-1-3} was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running {ibm-power-name} with {product-title} 4.13, 4.14, and 4.15, and {oadp-short} {oadp-version-1-3} against all S3 backup location targets, which are not AWS, as well.
* {ibm-power-name} running with {product-title} 4.14, 4.15, 4.16, and 4.17, and {oadp-short} {oadp-version-1-4} was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running {ibm-power-name} with {product-title} 4.14, 4.15, 4.16, and 4.17, and {oadp-short} {oadp-version-1-4} against all S3 backup location targets, which are not AWS, as well.
* {ibm-power-name} running with {product-title} 4.19 and {oadp-short} {oadp-version-1-5} was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running {ibm-power-name} with {product-title} 4.19 and {oadp-short} {oadp-version-1-5} against all S3 backup location targets, which are not AWS, as well.
1 change: 1 addition & 0 deletions modules/oadp-ibm-z-test-support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-ibm-z-test-support_{context}"]
= OADP testing and support for target backup locations using {ibm-z-title}

[role="_abstract"]
* {ibm-z-name} running with {product-title} 4.12, 4.13, 4.14, and 4.15, and {oadp-version-1-3} was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running {ibm-z-name} with {product-title} 4.13 4.14, and 4.15, and {oadp-version-1-3} against all S3 backup location targets, which are not AWS, as well.
* {ibm-z-name} running with {product-title} 4.14, 4.15, 4.16, and 4.17, and {oadp-version-1-4} was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running {ibm-z-name} with {product-title} 4.14, 4.15, 4.16, and 4.17, and {oadp-version-1-4} against all S3 backup location targets, which are not AWS, as well.
* {ibm-z-name} running with {product-title} 4.19 and {oadp-short} {oadp-version-1-5} was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running {ibm-z-name} with {product-title} 4.19 and {oadp-short} {oadp-version-1-5} against all S3 backup location targets, which are not AWS, as well.
1 change: 1 addition & 0 deletions modules/oadp-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-plugins_{context}"]
= OADP plugins

[role="_abstract"]
The {oadp-first} provides default Velero plugins that are integrated with storage providers to support backup and snapshot operations. You can create link:https://{velero-domain}/docs/v{velero-version}/custom-plugins/[custom plugins] based on the Velero plugins.

OADP also provides plugins for {product-title} resource backups, OpenShift Virtualization resource backups, and Container Storage Interface (CSI) snapshots.
Expand Down
2 changes: 1 addition & 1 deletion modules/oadp-supported-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Supported architectures for OADP



[role="_abstract"]
{oadp-first} supports the following architectures:

* AMD64
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-upgrading-oadp-operator-1-5-0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-upgrading-dpa-operator-1-5-0_{context}"]
= Upgrading the OADP Operator

[role="_abstract"]
You can upgrade the {oadp-first} Operator using the following procedure.

[NOTE]
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-verifying-upgrade-1-5-0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="verifying-upgrade-1-5-0_{context}"]
= Verifying the upgrade

[role="_abstract"]
You can verify the {oadp-first} upgrade by using the following procedure.

.Procedure
Expand Down