From 71e2d939e1b131e7ad483d112f8f6fdf74a7d116 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 + modules/oadp-configuring-velero-plugins.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 +- 13 files changed, 13 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 f30c1a66c203..8035f241aaaf 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 ea021f8571cc..bd079999df66 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/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.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 319b26f08423..9cad568875f0 100644 --- a/modules/oadp-ibm-power-test-support.adoc +++ b/modules/oadp-ibm-power-test-support.adoc @@ -6,5 +6,6 @@ [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. diff --git a/modules/oadp-ibm-z-test-support.adoc b/modules/oadp-ibm-z-test-support.adoc index 9fa240bacae4..c323bc499c64 100644 --- a/modules/oadp-ibm-z-test-support.adoc +++ b/modules/oadp-ibm-z-test-support.adoc @@ -6,5 +6,6 @@ [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. 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