From b548fd4a85dbc8222159c68e97ef761dbec7cfdd Mon Sep 17 00:00:00 2001 From: Prabha Kylasamiyer Sundara Rajan Date: Wed, 9 Jul 2025 11:35:58 +0530 Subject: [PATCH] OADP-6353 Added role to mark DITA descriptions --- .../application_backup_and_restore/oadp-advanced-topics.adoc | 1 + .../application_backup_and_restore/oadp-features-plugins.adoc | 1 + .../application_backup_and_restore/oadp-intro.adoc | 1 + .../oadp-performance/oadp-recommended-network-settings.adoc | 1 + .../release-notes/oadp-1-4-release-notes.adoc | 1 + .../release-notes/oadp-1-5-release-notes.adoc | 1 + modules/changes-from-oadp-1-4-to-1-5.adoc | 1 + modules/converting-dpa-to-the-new-version-for-oadp-1-5-0.adoc | 1 + modules/oadp-backing-up-dpa-configuration-1-5-0.adoc | 1 + modules/oadp-configuring-velero-plugins.adoc | 1 + modules/oadp-features-plugins-known-issues.adoc | 1 + modules/oadp-features.adoc | 1 + modules/oadp-fips.adoc | 1 + modules/oadp-ibm-power-and-z-known-issues.adoc | 1 + modules/oadp-ibm-power-test-support.adoc | 1 + modules/oadp-ibm-z-test-support.adoc | 1 + modules/oadp-plugins.adoc | 1 + modules/oadp-supported-architecture.adoc | 2 +- modules/oadp-upgrading-oadp-operator-1-5-0.adoc | 1 + modules/oadp-verifying-upgrade-1-5-0.adoc | 1 + 20 files changed, 20 insertions(+), 1 deletion(-) diff --git a/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc b/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc index d77345385705..149864bd68d1 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-advanced-topics.adoc @@ -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"] diff --git a/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc b/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc index 1f03261bbe84..181a4f122416 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc @@ -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. diff --git a/backup_and_restore/application_backup_and_restore/oadp-intro.adoc b/backup_and_restore/application_backup_and_restore/oadp-intro.adoc index c45d82ed180e..12d1386b38b1 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-intro.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-intro.adoc @@ -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[] diff --git a/backup_and_restore/application_backup_and_restore/oadp-performance/oadp-recommended-network-settings.adoc b/backup_and_restore/application_backup_and_restore/oadp-performance/oadp-recommended-network-settings.adoc index 63c891c78044..764796ad840a 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-performance/oadp-recommended-network-settings.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-performance/oadp-recommended-network-settings.adoc @@ -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: diff --git a/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc b/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc index 9cc9f2c75379..6b854e8c7ec3 100644 --- a/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc +++ b/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc @@ -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] diff --git a/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-5-release-notes.adoc b/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-5-release-notes.adoc index bd02eb89dc45..5674f7f74804 100644 --- a/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-5-release-notes.adoc +++ b/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-5-release-notes.adoc @@ -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] diff --git a/modules/changes-from-oadp-1-4-to-1-5.adoc b/modules/changes-from-oadp-1-4-to-1-5.adoc index ca6dce2de9eb..5d3e57247049 100644 --- a/modules/changes-from-oadp-1-4-to-1-5.adoc +++ b/modules/changes-from-oadp-1-4-to-1-5.adoc @@ -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: diff --git a/modules/converting-dpa-to-the-new-version-for-oadp-1-5-0.adoc b/modules/converting-dpa-to-the-new-version-for-oadp-1-5-0.adoc index b53a5ec886c3..bf51e55f390e 100644 --- a/modules/converting-dpa-to-the-new-version-for-oadp-1-5-0.adoc +++ b/modules/converting-dpa-to-the-new-version-for-oadp-1-5-0.adoc @@ -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 diff --git a/modules/oadp-backing-up-dpa-configuration-1-5-0.adoc b/modules/oadp-backing-up-dpa-configuration-1-5-0.adoc index a9011e38fbd6..03db39994e1e 100644 --- a/modules/oadp-backing-up-dpa-configuration-1-5-0.adoc +++ b/modules/oadp-backing-up-dpa-configuration-1-5-0.adoc @@ -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 diff --git a/modules/oadp-configuring-velero-plugins.adoc b/modules/oadp-configuring-velero-plugins.adoc index 7560a39677e0..dc0a1f6cadd5 100644 --- a/modules/oadp-configuring-velero-plugins.adoc +++ b/modules/oadp-configuring-velero-plugins.adoc @@ -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 diff --git a/modules/oadp-features-plugins-known-issues.adoc b/modules/oadp-features-plugins-known-issues.adoc index 09c0d19aefa5..1e3d54dc08ac 100644 --- a/modules/oadp-features-plugins-known-issues.adoc +++ b/modules/oadp-features-plugins-known-issues.adoc @@ -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}"] diff --git a/modules/oadp-features.adoc b/modules/oadp-features.adoc index 87bd9b395e1a..030ee729b0d6 100644 --- a/modules/oadp-features.adoc +++ b/modules/oadp-features.adoc @@ -6,6 +6,7 @@ [id="oadp-features_{context}"] = OADP features +[role="_abstract"] OpenShift API for Data Protection (OADP) supports the following features: Backup:: diff --git a/modules/oadp-fips.adoc b/modules/oadp-fips.adoc index 2fa1eee1a3f4..e61d9238a280 100644 --- a/modules/oadp-fips.adoc +++ b/modules/oadp-fips.adoc @@ -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. diff --git a/modules/oadp-ibm-power-and-z-known-issues.adoc b/modules/oadp-ibm-power-and-z-known-issues.adoc index a649c5f0eb8d..de2d8e85bc02 100644 --- a/modules/oadp-ibm-power-and-z-known-issues.adoc +++ b/modules/oadp-ibm-power-and-z-known-issues.adoc @@ -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. diff --git a/modules/oadp-ibm-power-test-support.adoc b/modules/oadp-ibm-power-test-support.adoc index 32e8e58c5527..a9b301ff0e91 100644 --- a/modules/oadp-ibm-power-test-support.adoc +++ b/modules/oadp-ibm-power-test-support.adoc @@ -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. diff --git a/modules/oadp-ibm-z-test-support.adoc b/modules/oadp-ibm-z-test-support.adoc index 1e05af80e994..7b1d1da92e68 100644 --- a/modules/oadp-ibm-z-test-support.adoc +++ b/modules/oadp-ibm-z-test-support.adoc @@ -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. \ No newline at end of file diff --git a/modules/oadp-plugins.adoc b/modules/oadp-plugins.adoc index efb790b595a3..8732de5e4b32 100644 --- a/modules/oadp-plugins.adoc +++ b/modules/oadp-plugins.adoc @@ -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. diff --git a/modules/oadp-supported-architecture.adoc b/modules/oadp-supported-architecture.adoc index fe21cfb2f6d5..cdc1b0fe2a00 100644 --- a/modules/oadp-supported-architecture.adoc +++ b/modules/oadp-supported-architecture.adoc @@ -7,7 +7,7 @@ = Supported architectures for OADP - +[role="_abstract"] {oadp-first} supports the following architectures: * AMD64 diff --git a/modules/oadp-upgrading-oadp-operator-1-5-0.adoc b/modules/oadp-upgrading-oadp-operator-1-5-0.adoc index 4a4cf200aa4a..075ae9c07bb9 100644 --- a/modules/oadp-upgrading-oadp-operator-1-5-0.adoc +++ b/modules/oadp-upgrading-oadp-operator-1-5-0.adoc @@ -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] diff --git a/modules/oadp-verifying-upgrade-1-5-0.adoc b/modules/oadp-verifying-upgrade-1-5-0.adoc index 27cbce0836c0..6830d1bc0ad8 100644 --- a/modules/oadp-verifying-upgrade-1-5-0.adoc +++ b/modules/oadp-verifying-upgrade-1-5-0.adoc @@ -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