diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 614bc1d1fb17..fe773d7f1cc4 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -41,6 +41,8 @@ endif::[] :hybrid-console-second: Hybrid Cloud Console :hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console] // OADP attributes +:velero-domain: velero.io +:velero-version: 1.14 :oadp-first: OpenShift API for Data Protection (OADP) :oadp-full: OpenShift API for Data Protection :oadp-short: OADP @@ -48,7 +50,13 @@ endif::[] :oadp-version-1-3: 1.3.6 :oadp-version-1-4: 1.4.5 :oadp-bsl-api: backupstoragelocations.velero.io +:velero-overview: link:https://{velero-domain}/docs/v{velero-version}/locations/[Overview of backup and snapshot locations in the Velero documentation] :velero-link: link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}] +:velero-cli-install: link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli["Install the CLI" on the Velero website] +:velero-1.12: link:https://{velero-domain}/docs/v1.12/[1.12] +:velero-1.14: link:https://{velero-domain}/docs/v1.14/[1.14] +:velero-1.16: link:https://{velero-domain}/docs/v1.16/[1.16] +:ocp-user-workload-monitoring: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{product-version}/html/monitoring/configuring-user-workload-monitoring[Configuring user workload monitoring] :oc-first: pass:quotes[OpenShift CLI (`oc`)] :product-registry: OpenShift image registry :product-mirror-registry: Mirror registry for Red Hat OpenShift @@ -71,8 +79,6 @@ endif::[] :kueue-op: Red Hat Build of Kueue Operator :ms: Red{nbsp}Hat build of MicroShift (MicroShift) // Backup and restore -:velero-domain: velero.io -:velero-version: 1.14 :launch: image:app-launcher.png[title="Application Launcher"] :mtc-first: Migration Toolkit for Containers (MTC) :mtc-short: MTC diff --git a/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc b/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc index e719b3cf7040..a61efcc9d44f 100644 --- a/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc @@ -1,13 +1,16 @@ :_mod-docs-content-type: ASSEMBLY [id="about-installing-oadp"] = About installing OADP +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: about-installing-oadp -toc::[] -As a cluster administrator, you install the OpenShift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}]. + +[role="_abstract"] +As a cluster administrator, you install the OpenShift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs {velero-link}. include::snippets/oadp-mtc-operator.adoc[] @@ -56,7 +59,7 @@ include::modules/oadp-configuring-noobaa-for-dr.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* link:https://{velero-domain}/docs/v{velero-version}/locations/[Overview of backup and snapshot locations in the Velero documentation] +* {velero-overview} include::modules/about-oadp-update-channels.adoc[leveloffset=+1] include::modules/about-installing-oadp-on-multiple-namespaces.adoc[leveloffset=+1] diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/backup-and-restore-cr-issues.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/backup-and-restore-cr-issues.adoc index a146acb1d8b4..4a347371ecec 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/backup-and-restore-cr-issues.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/backup-and-restore-cr-issues.adoc @@ -1,15 +1,18 @@ :_mod-docs-content-type: ASSEMBLY [id="backup-and-restore-cr-issues"] = Backup and Restore CR issues +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: backup-and-restore-cr-issues :namespace: openshift-adp :local-product: OADP -toc::[] -You might encounter these common issues with `Backup` and `Restore` custom resources (CRs). + +[role="_abstract"] +You might encounter the following common issues with `Backup` and `Restore` custom resources (CRs): [id="backup-cannot-retrieve-volume_{context}"] == Backup CR cannot retrieve volume diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/issues-with-velero-and-admission-webhooks.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/issues-with-velero-and-admission-webhooks.adoc index 59ab72e648d5..8f1172d9b051 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/issues-with-velero-and-admission-webhooks.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/issues-with-velero-and-admission-webhooks.adoc @@ -1,6 +1,8 @@ :_mod-docs-content-type: ASSEMBLY [id="issues-with-velero-and-admission-webhooks"] -= Issues with Velero and admission webhooks += Restoring workarounds for Velero backups that use admission webhooks +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: issues-with-velero-and-admission-webhooks @@ -9,6 +11,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] +[role="_abstract"] Velero has limited abilities to resolve admission webhook issues during a restore. If you have workloads with admission webhooks, you might need to use an additional Velero plugin or make changes to how you restore the workload. Typically, workloads with admission webhooks require you to create a resource of a specific kind first. This is especially true if your workload has child resources because admission webhooks typically block child resources. diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-installation-issues.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-installation-issues.adoc index 539f024c3453..dbe7b68e1a5c 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-installation-issues.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-installation-issues.adoc @@ -1,15 +1,18 @@ :_mod-docs-content-type: ASSEMBLY [id="oadp-installation-issues"] = OADP installation issues +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: installation-issues :namespace: openshift-adp :local-product: OADP -toc::[] -You might encounter issues caused by using invalid directories or incorrect credentials when you install the Data Protection Application. + +[role="_abstract"] +You might encounter issues caused by using invalid directories or incorrect credentials when you install the Data Protection Application (DPA). [id="oadp-backup-location-contains-invalid-directories_{context}"] == Backup storage contains invalid directories diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc index 2b2f67001493..96629c479288 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc @@ -1,14 +1,17 @@ :_mod-docs-content-type: ASSEMBLY [id="oadp-monitoring"] = OADP monitoring +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: oadp-monitoring :namespace: openshift-adp :local-product: OADP -toc::[] + +[role="_abstract"] By using the {product-title} monitoring stack, users and administrators can effectively perform the following tasks: * Monitor and manage clusters diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-operator-issues.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-operator-issues.adoc index 4e9c377b59ef..e21bee5fbae4 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-operator-issues.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-operator-issues.adoc @@ -1,14 +1,17 @@ :_mod-docs-content-type: ASSEMBLY [id="oadp-operator-issues"] = OADP Operator issues +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: oadp-operator-issues :namespace: openshift-adp :local-product: OADP -toc::[] + +[role="_abstract"] The {oadp-first} Operator might encounter issues caused by problems it is not able to resolve. [id="oadp-operator-fails-silently_{context}"] diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc index 95898dcf6d91..f47156dccbec 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc @@ -1,14 +1,17 @@ :_mod-docs-content-type: ASSEMBLY [id="oadp-timeouts"] = OADP timeouts +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: oadp-timeouts :namespace: openshift-adp :local-product: OADP -toc::[] + +[role="_abstract"] Extending a timeout allows complex or resource-intensive processes to complete successfully without premature termination. This configuration can reduce errors, retries, or failures. Ensure that you balance timeout extensions in a logical manner so that you do not configure excessively long timeouts that might hide underlying issues in the process. Consider and monitor an appropriate timeout value that meets the needs of the process and the overall system performance. diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/pods-crash-or-restart-due-to-lack-of-memory-or-cpu.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/pods-crash-or-restart-due-to-lack-of-memory-or-cpu.adoc index 1ee93e2d475a..6a99959b812e 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/pods-crash-or-restart-due-to-lack-of-memory-or-cpu.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/pods-crash-or-restart-due-to-lack-of-memory-or-cpu.adoc @@ -1,6 +1,8 @@ :_mod-docs-content-type: ASSEMBLY [id="pods-crash-or-restart-due-to-lack-of-memory-or-cpu"] = Pods crash or restart due to lack of memory or CPU +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: pods-crash-or-restart-due-to-lack-of-memory-or-cpu @@ -9,11 +11,11 @@ include::_attributes/attributes-openshift-dedicated.adoc[] :must-gather-v1-3: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 :must-gather-v1-4: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -toc::[] -If a Velero or Restic pod crashes due to a lack of memory or CPU, you can set specific resource requests for either of those resources. -The values for the resource request fields must follow the same format as Kubernetes resource requirements. +[role="_abstract"] +If a Velero or Restic pod crashes due to a lack of memory or CPU, you can set specific resource requests for either of those resources. The values for the resource request fields must follow the same format as Kubernetes resource requirements. + If you do not specify `configuration.velero.podConfig.resourceAllocations` or `configuration.restic.podConfig.resourceAllocations`, see the following default `resources` specification configuration for a Velero or Restic pod: [source,yaml] diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc index d0f17e9be6d3..53f06a644926 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc @@ -1,15 +1,18 @@ :_mod-docs-content-type: ASSEMBLY [id="restic-issues"] = Restic issues +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: restic-issues :namespace: openshift-adp :local-product: OADP -toc::[] -You might encounter these issues when you back up applications with Restic. + +[role="_abstract"] +You might encounter the following issues when you back up applications with Restic: [id="restic-permission-error-nfs-root-squash-enabled_{context}"] == Restic permission error for NFS data volumes with root_squash enabled diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/troubleshooting.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/troubleshooting.adoc index cec7d3222c29..59d2270ed73d 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/troubleshooting.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/troubleshooting.adoc @@ -1,6 +1,8 @@ :_mod-docs-content-type: ASSEMBLY [id="troubleshooting"] = Troubleshooting +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: oadp-troubleshooting @@ -10,8 +12,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[] :must-gather-v1-3: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 :must-gather-v1-4: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -toc::[] +[role="_abstract"] You can troubleshoot OADP issues by using the following methods: * Debug Velero custom resources (CRs) by using the xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc#oadp-debugging-oc-cli_velero-cli-tool[OpenShift CLI tool] or the xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc#migration-debugging-velero-resources_velero-cli-tool[Velero CLI tool]. The Velero CLI tool provides more detailed logs and information. diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc index e04bf36f820f..b0507dc633f5 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc @@ -1,12 +1,14 @@ :_mod-docs-content-type: ASSEMBLY [id="using-the-must-gather-tool"] = Using the must-gather tool +:toc: + include::_attributes/common-attributes.adoc[] :context: using-the-must-gather-tool :must-gather-v1-4: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -toc::[] +[role="_abstract"] You can collect logs and information about {oadp-short} custom resources by using the `must-gather` tool. The `must-gather` data must be attached to all customer cases. The `must-gather` tool is a container and does not run all the time. The tool runs for a few minutes only after you invoke the tool by running the `must-gather` command. diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc index bb5c23966d8a..a850bf01252b 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc @@ -1,14 +1,17 @@ :_mod-docs-content-type: ASSEMBLY [id="velero-cli-tool"] = Velero CLI tool +:toc: + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: velero-cli-tool :namespace: openshift-adp :local-product: OADP -toc::[] + +[role="_abstract"] You can obtain the `velero` CLI tool by using the following options: * Downloading the `velero` CLI tool diff --git a/modules/migration-debugging-velero-admission-webhooks-ibm-appconnect.adoc b/modules/migration-debugging-velero-admission-webhooks-ibm-appconnect.adoc index 2b81d5ef8a1e..8e6e43761ca0 100644 --- a/modules/migration-debugging-velero-admission-webhooks-ibm-appconnect.adoc +++ b/modules/migration-debugging-velero-admission-webhooks-ibm-appconnect.adoc @@ -5,6 +5,7 @@ [id="migration-debugging-velero-admission-webhooks-ibm-appconnect_{context}"] = Restoring {ibm-title} AppConnect resources +[role="_abstract"] If you experience issues when you use Velero to a restore an {ibm-name} AppConnect resource that has an admission webhook, you can run the checks in this procedure. .Procedure diff --git a/modules/migration-debugging-velero-admission-webhooks-knative.adoc b/modules/migration-debugging-velero-admission-webhooks-knative.adoc index 489975700820..f100e9d26b41 100644 --- a/modules/migration-debugging-velero-admission-webhooks-knative.adoc +++ b/modules/migration-debugging-velero-admission-webhooks-knative.adoc @@ -5,7 +5,8 @@ [id="migration-debugging-velero-admission-webhooks-knative_{context}"] = Restoring Knative resources -You might encounter problems using Velero to back up Knative resources that use admission webhooks. +[role="_abstract"] +You might encounter problems by using Velero to back up Knative resources that use admission webhooks. You can avoid such problems by restoring the top level `Service` resource first whenever you back up and restore Knative resources that use admission webhooks. diff --git a/modules/migration-debugging-velero-resources.adoc b/modules/migration-debugging-velero-resources.adoc index 03862d5020c7..52ad3bc0d859 100644 --- a/modules/migration-debugging-velero-resources.adoc +++ b/modules/migration-debugging-velero-resources.adoc @@ -7,11 +7,12 @@ [id="migration-debugging-velero-resources_{context}"] = Debugging Velero resources with the Velero CLI tool -You can debug `Backup` and `Restore` custom resources (CRs) and retrieve logs with the Velero CLI tool. +[role="_abstract"] +You can debug `Backup` and `Restore` custom resources (CRs) and retrieve logs with the Velero CLI tool. The Velero CLI tool provides more detailed information than the OpenShift CLI tool. The Velero CLI tool provides more detailed information than the OpenShift CLI tool. -[discrete] + [id="velero-command-syntax_{context}"] == Syntax @@ -30,7 +31,7 @@ $ oc -n {namespace} exec deployment/velero -c velero -- ./velero \ backup describe 0e44ae00-5dc3-11eb-9ca8-df7e5254778b-2d8ql ---- -[discrete] + [id="velero-help-option_{context}"] == Help option @@ -43,7 +44,7 @@ $ oc -n {namespace} exec deployment/velero -c velero -- ./velero \ ---- -[discrete] + [id="velero-describe-command_{context}"] == Describe command @@ -65,11 +66,16 @@ $ oc -n {namespace} exec deployment/velero -c velero -- ./velero \ The following types of restore errors and warnings are shown in the output of a `velero describe` request: * `Velero`: A list of messages related to the operation of Velero itself, for example, messages related to connecting to the cloud, reading a backup file, and so on -* `Cluster`: A list of messages related to backing up or restoring cluster-scoped resources + +* `Cluster`: A list of messages related to backing up or restoring cluster-scoped resources + * `Namespaces`: A list of list of messages related to backing up or restoring resources stored in namespaces One or more errors in one of these categories results in a `Restore` operation receiving the status of `PartiallyFailed` and not `Completed`. Warnings do not lead to a change in the completion status. + +Consider the following points for these restore errors: + [IMPORTANT] ==== * For resource-specific errors, that is, `Cluster` and `Namespaces` errors, the `restore describe --details` output includes a resource list that lists all resources that Velero succeeded in restoring. For any resource that has such an error, check to see if the resource is actually in the cluster. @@ -79,7 +85,6 @@ One or more errors in one of these categories results in a `Restore` operation r For example, if the output contains `PodVolumeRestore` or node agent-related errors, check the status of `PodVolumeRestores` and `DataDownloads`. If none of these are failed or still running, then volume data might have been fully restored. ==== -[discrete] [id="velero-logs-command_{context}"] == Logs command diff --git a/modules/oadp-creating-alerting-rule.adoc b/modules/oadp-creating-alerting-rule.adoc index 6a3b31cf4407..18c7543d25c5 100644 --- a/modules/oadp-creating-alerting-rule.adoc +++ b/modules/oadp-creating-alerting-rule.adoc @@ -6,7 +6,8 @@ [id="creating-alerting-rules_{context}"] = Creating an alerting rule -The {product-title} monitoring stack allows to receive Alerts configured using Alerting Rules. To create an Alerting rule for the OADP project, use one of the Metrics which are scraped with the user workload monitoring. +[role="_abstract"] +The {product-title} monitoring stack receives Alerts configured by using Alerting Rules. To create an Alerting rule for the {oadp-short} project, use one of the Metrics scraped with the user workload monitoring. .Procedure diff --git a/modules/oadp-creating-service-monitor.adoc b/modules/oadp-creating-service-monitor.adoc index 5ddd8cccb2fd..6bdd87a70458 100644 --- a/modules/oadp-creating-service-monitor.adoc +++ b/modules/oadp-creating-service-monitor.adoc @@ -6,9 +6,9 @@ [id="oadp-creating-service-monitor_{context}"] = Creating OADP service monitor -OADP provides an `openshift-adp-velero-metrics-svc` service which is created when the DPA is configured. The service monitor used by the user workload monitoring must point to the defined service. - -Get details about the service by running the following commands: +[role="_abstract"] +{oadp-short} provides an `openshift-adp-velero-metrics-svc` service, which is created when the Data Protection Application (DPA) is configured. The user workload monitoring service monitor must point to the defined service. +To get details about the service, complete the following steps. .Procedure diff --git a/modules/oadp-csi-snapshot-timeouts.adoc b/modules/oadp-csi-snapshot-timeouts.adoc index 175a043f8eb6..0d9724e2390a 100644 --- a/modules/oadp-csi-snapshot-timeouts.adoc +++ b/modules/oadp-csi-snapshot-timeouts.adoc @@ -6,6 +6,7 @@ [id="csisnapshot-timeout_{context}"] = CSI snapshot timeout +[role="_abstract"] `CSISnapshotTimeout` specifies the time during creation to wait until the `CSI VolumeSnapshot` status becomes `ReadyToUse`, before returning error as timeout. The default value is `10m`. Use the `CSISnapshotTimeout` for the following scenarios: diff --git a/modules/oadp-datamover-timeouts.adoc b/modules/oadp-datamover-timeouts.adoc index f0d0d77823d2..07f2158d3d63 100644 --- a/modules/oadp-datamover-timeouts.adoc +++ b/modules/oadp-datamover-timeouts.adoc @@ -6,6 +6,7 @@ [id="datamover-timeout_{context}"] = Data Mover timeout +[role="_abstract"] `timeout` is a user-supplied timeout to complete `VolumeSnapshotBackup` and `VolumeSnapshotRestore`. The default value is `10m`. Use the Data Mover `timeout` for the following scenarios: diff --git a/modules/oadp-debugging-oc-cli.adoc b/modules/oadp-debugging-oc-cli.adoc index 3c470d2ad1d0..d9100a675356 100644 --- a/modules/oadp-debugging-oc-cli.adoc +++ b/modules/oadp-debugging-oc-cli.adoc @@ -6,6 +6,7 @@ [id="oadp-debugging-oc-cli_{context}"] = Debugging Velero resources with the OpenShift CLI tool +[role="_abstract"] You can debug a failed backup or restore by checking Velero custom resources (CRs) and the `Velero` pod log with the OpenShift CLI tool. [discrete] diff --git a/modules/oadp-item-backup-timeouts.adoc b/modules/oadp-item-backup-timeouts.adoc index f7c698831131..321db006c796 100644 --- a/modules/oadp-item-backup-timeouts.adoc +++ b/modules/oadp-item-backup-timeouts.adoc @@ -6,8 +6,8 @@ [id="item-operation-timeout-backup_{context}"] = Item operation timeout - backup -`ItemOperationTimeout` specifies the time used to wait for asynchronous -`BackupItemAction` operations. The default value is `1h`. +[role="_abstract"] +The `ItemOperationTimeout` setting specifies the time used to wait for asynchronous `BackupItemAction` operations. The default value is `1h`. Use the backup `ItemOperationTimeout` for the following scenarios: diff --git a/modules/oadp-item-restore-timeouts.adoc b/modules/oadp-item-restore-timeouts.adoc index 504b60578c37..b410e17f4faf 100644 --- a/modules/oadp-item-restore-timeouts.adoc +++ b/modules/oadp-item-restore-timeouts.adoc @@ -6,7 +6,8 @@ [id="item-operation-timeout-restore_{context}"] = Item operation timeout - restore -`ItemOperationTimeout` specifies the time that is used to wait for `RestoreItemAction` operations. The default value is `1h`. +[role="_abstract"] +The `ItemOperationTimeout` setting specifies the time that is used to wait for `RestoreItemAction` operations. The default value is `1h`. Use the restore `ItemOperationTimeout` for the following scenarios: diff --git a/modules/oadp-list-of-metrics.adoc b/modules/oadp-list-of-metrics.adoc index d141411c649a..29635941faa2 100644 --- a/modules/oadp-list-of-metrics.adoc +++ b/modules/oadp-list-of-metrics.adoc @@ -6,6 +6,7 @@ [id="list-of-metrics_{context}"] = List of available metrics +[role="_abstract"] Refer to the following table for a list of `Velero` metrics provided by {oadp-short} together with their https://prometheus.io/docs/concepts/metric_types/[Types]: .Velero metrics diff --git a/modules/oadp-monitoring-setup.adoc b/modules/oadp-monitoring-setup.adoc index f437a49ed9bf..6258166ce5cd 100644 --- a/modules/oadp-monitoring-setup.adoc +++ b/modules/oadp-monitoring-setup.adoc @@ -6,6 +6,7 @@ [id="oadp-monitoring-setup-monitor_{context}"] = OADP monitoring setup +[role="_abstract"] The OADP Operator leverages an OpenShift User Workload Monitoring provided by the OpenShift Monitoring Stack for retrieving metrics from the Velero service endpoint. The monitoring stack allows creating user-defined Alerting Rules or querying metrics by using the OpenShift Metrics query front end. With enabled User Workload Monitoring, it is possible to configure and use any Prometheus-compatible third-party UI, such as Grafana, to visualize Velero metrics. @@ -17,7 +18,7 @@ Monitoring metrics requires enabling monitoring for the user-defined projects an The {oadp-short} support for Prometheus metrics is offered on a best-effort basis and is not fully supported. ==== -For more information about setting up the monitoring stack, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{product-version}/html/monitoring/configuring-user-workload-monitoring[Configuring user workload monitoring]. +For more information about setting up the monitoring stack, see {ocp-user-workload-monitoring}. .Prerequisites * You have access to an {product-title} cluster using an account with `cluster-admin` permissions. diff --git a/modules/oadp-pod-crash-set-resource-request-restic.adoc b/modules/oadp-pod-crash-set-resource-request-restic.adoc index e195834f1ab2..c5dbbee68d83 100644 --- a/modules/oadp-pod-crash-set-resource-request-restic.adoc +++ b/modules/oadp-pod-crash-set-resource-request-restic.adoc @@ -6,6 +6,7 @@ [id="oadp-pod-crash-resource-request-retics_{context}"] = Setting resource requests for a Restic pod +[role="_abstract"] You can use the `configuration.restic.podConfig.resourceAllocations` specification field to set specific resource requests for a `Restic` pod. .Procedure diff --git a/modules/oadp-pod-crash-set-resource-request-velero.adoc b/modules/oadp-pod-crash-set-resource-request-velero.adoc index eb06b152eeaa..4a45708ad40f 100644 --- a/modules/oadp-pod-crash-set-resource-request-velero.adoc +++ b/modules/oadp-pod-crash-set-resource-request-velero.adoc @@ -6,6 +6,7 @@ [id="oadp-pod-crash-resource-request-velero_{context}"] = Setting resource requests for a Velero pod +[role="_abstract"] You can use the `configuration.velero.podConfig.resourceAllocations` specification field in the `oadp_v1alpha1_dpa.yaml` file to set specific resource requests for a `Velero` pod. .Procedure diff --git a/modules/oadp-restic-restore-failing-psa-policy.adoc b/modules/oadp-restic-restore-failing-psa-policy.adoc index b67f0fc98fe1..ce246fdd7682 100644 --- a/modules/oadp-restic-restore-failing-psa-policy.adoc +++ b/modules/oadp-restic-restore-failing-psa-policy.adoc @@ -2,7 +2,8 @@ [id="oadp-restic-restore-failing-psa-policy_{context}"] = Restic restore partially failing on OCP 4.14 due to changed PSA policy -{ocp} 4.14 enforces a Pod Security Admission (PSA) policy that can hinder the readiness of pods during a Restic restore process.  +[role="_abstract"] +{ocp} 4.14 enforces a Pod Security Admission (PSA) policy that can hinder the readiness of pods during a Restic restore process. If a `SecurityContextConstraints` (SCC) resource is not found when a pod is created, and the PSA policy on the pod is not set up to meet the required standards, pod admission is denied.  diff --git a/modules/oadp-restic-timeouts.adoc b/modules/oadp-restic-timeouts.adoc index eeb2b4c13c00..fd8c05bd5c3f 100644 --- a/modules/oadp-restic-timeouts.adoc +++ b/modules/oadp-restic-timeouts.adoc @@ -6,6 +6,7 @@ [id="restic-timeout_{context}"] = Restic timeout +[role="_abstract"] The `spec.configuration.nodeAgent.timeout` parameter defines the Restic timeout. The default value is `1h`. Use the Restic `timeout` parameter in the `nodeAgent` section for the following scenarios: diff --git a/modules/oadp-velero-default-timeouts.adoc b/modules/oadp-velero-default-timeouts.adoc index 6362ea8e4670..e590c35faabd 100644 --- a/modules/oadp-velero-default-timeouts.adoc +++ b/modules/oadp-velero-default-timeouts.adoc @@ -6,7 +6,8 @@ [id="velero-default-item-operation-timeout_{context}"] = Velero default item operation timeout -`defaultItemOperationTimeout` defines how long to wait on asynchronous `BackupItemActions` and `RestoreItemActions` to complete before timing out. The default value is `1h`. +[role="_abstract"] +The `defaultItemOperationTimeout` setting defines how long to wait on asynchronous `BackupItemActions` and `RestoreItemActions` to complete before timing out. The default value is `1h`. Use the `defaultItemOperationTimeout` for the following scenarios: diff --git a/modules/oadp-velero-timeouts.adoc b/modules/oadp-velero-timeouts.adoc index 7daa58918e6c..2f1216d65d79 100644 --- a/modules/oadp-velero-timeouts.adoc +++ b/modules/oadp-velero-timeouts.adoc @@ -6,6 +6,7 @@ [id="velero-timeout_{context}"] = Velero resource timeout +[role="_abstract"] `resourceTimeout` defines how long to wait for several Velero resources before timeout occurs, such as Velero custom resource definition (CRD) availability, `volumeSnapshot` deletion, and repository availability. The default is `10m`. Use the `resourceTimeout` for the following scenarios: diff --git a/modules/oadp-viewing-metrics-ui.adoc b/modules/oadp-viewing-metrics-ui.adoc index f5e80bcc8cdf..1307e547cea7 100644 --- a/modules/oadp-viewing-metrics-ui.adoc +++ b/modules/oadp-viewing-metrics-ui.adoc @@ -6,6 +6,7 @@ [id="viewing-metrics-observe-ui_{context}"] = Viewing metrics using the Observe UI +[role="_abstract"] You can view metrics in the {product-title} web console from the *Administrator* or *Developer* perspective, which must have access to the `openshift-adp` project. .Procedure diff --git a/modules/using-must-gather.adoc b/modules/using-must-gather.adoc index b5114c238976..129f940676d3 100644 --- a/modules/using-must-gather.adoc +++ b/modules/using-must-gather.adoc @@ -6,6 +6,7 @@ [id="oadp-running-must-gather_{context}"] = Using the must-gather tool +[role="_abstract"] You can run the `must-gather` tool with the following options. To use an option, add a flag corresponding to that option in the `must-gather` command. Default configuration:: This configuration collects pod logs, {oadp-short}, and `Velero` custom resource (CR) information for all namespaces where the {oadp-short} Operator is installed. diff --git a/modules/velero-oadp-version-relationship.adoc b/modules/velero-oadp-version-relationship.adoc index 46c1cd0e3de0..17be60531b41 100644 --- a/modules/velero-oadp-version-relationship.adoc +++ b/modules/velero-oadp-version-relationship.adoc @@ -11,14 +11,14 @@ [cols="3", options="header"] |=== |OADP version |Velero version |{product-title} version -| 1.3.0 | link:https://{velero-domain}/docs/v1.12/[1.12] | 4.12-4.15 -| 1.3.1 | link:https://{velero-domain}/docs/v1.12/[1.12] | 4.12-4.15 -| 1.3.2 | link:https://{velero-domain}/docs/v1.12/[1.12] | 4.12-4.15 -| 1.3.3 | link:https://{velero-domain}/docs/v1.12/[1.12] | 4.12-4.15 -| 1.3.4 | link:https://{velero-domain}/docs/v1.12/[1.12] | 4.12-4.15 -| 1.3.5 | link:https://{velero-domain}/docs/v1.12/[1.12] | 4.12-4.15 -| 1.4.0 | link:https://{velero-domain}/docs/v1.14/[1.14] | 4.14-4.18 -| 1.4.1 | link:https://{velero-domain}/docs/v1.14/[1.14] | 4.14-4.18 -| 1.4.2 | link:https://{velero-domain}/docs/v1.14/[1.14] | 4.14-4.18 -| 1.4.3 | link:https://{velero-domain}/docs/v1.14/[1.14] | 4.14-4.18 +| 1.3.0 | {velero-1.12} | 4.12-4.15 +| 1.3.1 | {velero-1.12} | 4.12-4.15 +| 1.3.2 | {velero-1.12} | 4.12-4.15 +| 1.3.3 | {velero-1.12} | 4.12-4.15 +| 1.3.4 | {velero-1.12} | 4.12-4.15 +| 1.3.5 | {velero-1.12} | 4.12-4.15 +| 1.4.0 | {velero-1.14} | 4.14-4.18 +| 1.4.1 | {velero-1.14} | 4.14-4.18 +| 1.4.2 | {velero-1.14} | 4.14-4.18 +| 1.4.3 | {velero-1.14} | 4.14-4.18 |=== diff --git a/modules/velero-obtaining-by-accessing-binary.adoc b/modules/velero-obtaining-by-accessing-binary.adoc index fc5bd4468e92..ab358eb0a6b7 100644 --- a/modules/velero-obtaining-by-accessing-binary.adoc +++ b/modules/velero-obtaining-by-accessing-binary.adoc @@ -6,6 +6,7 @@ [id="velero-obtaining-by-accessing-binary_{context}"] = Accessing the Velero binary in the Velero deployment in the cluster +[role="_abstract"] You can use a shell command to access the Velero binary in the Velero deployment in the cluster. .Prerequisites diff --git a/modules/velero-obtaining-by-downloading.adoc b/modules/velero-obtaining-by-downloading.adoc index afa45a2f32d6..419ccd4277d5 100644 --- a/modules/velero-obtaining-by-downloading.adoc +++ b/modules/velero-obtaining-by-downloading.adoc @@ -6,9 +6,8 @@ [id="velero-obtaining-by-downloading_{context}"] = Downloading the Velero CLI tool -You can download and install the Velero CLI tool by following the instructions on the link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli[Velero documentation page]. - -The page includes instructions for: +[role="_abstract"] +You can download and install the Velero CLI tool by following the instructions on the Velero documentation page. The page includes instructions for the following options: * macOS by using Homebrew * GitHub @@ -21,6 +20,6 @@ The page includes instructions for: .Procedure -. Open a browser and navigate to link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli["Install the CLI" on the Velero website]. +. Open a browser and navigate to {velero-cli-install}. . Follow the appropriate procedure for macOS, GitHub, or Windows. . Download the Velero version appropriate for your version of OADP and {product-title}.