Skip to content

Commit 0678db8

Browse files
committed
DITA fixes for OADP troubleshooting
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
1 parent be94bd5 commit 0678db8

File tree

47 files changed

+111
-37
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+111
-37
lines changed

_attributes/common-attributes.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ endif::[]
4242
:hybrid-console-second: Hybrid Cloud Console
4343
:hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
4444
// OADP attributes
45+
:velero-domain: velero.io
46+
:velero-version: 1.16
4547
:oadp-first: OpenShift API for Data Protection (OADP)
4648
:oadp-full: OpenShift API for Data Protection
4749
:oadp-short: OADP
@@ -50,7 +52,14 @@ endif::[]
5052
:oadp-version-1-4: 1.4.5
5153
:oadp-version-1-5: 1.5.0
5254
:oadp-bsl-api: backupstoragelocations.velero.io
55+
:velero-overview: link:https://{velero-domain}/docs/v{velero-version}/locations/[Overview of backup and snapshot locations in the Velero documentation]
5356
:velero-link: link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}]
57+
:velero-cli-install: link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli["Install the CLI" on the Velero website]
58+
:velero-1.12: link:https://{velero-domain}/docs/v1.12/[1.12]
59+
:velero-1.14: link:https://{velero-domain}/docs/v1.14/[1.14]
60+
:velero-1.16: link:https://{velero-domain}/docs/v1.16/[1.16]
61+
: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]
62+
5463
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
5564
:product-registry: OpenShift image registry
5665
:product-mirror-registry: Mirror registry for Red Hat OpenShift
@@ -70,8 +79,6 @@ endif::[]
7079
:descheduler-operator: Kube Descheduler Operator
7180
:cli-manager: CLI Manager Operator
7281
// Backup and restore
73-
:velero-domain: velero.io
74-
:velero-version: 1.16
7582
:launch: image:app-launcher.png[title="Application Launcher"]
7683
:mtc-first: Migration Toolkit for Containers (MTC)
7784
:mtc-short: MTC

backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="about-installing-oadp"]
33
= About installing OADP
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: about-installing-oadp
79

8-
toc::[]
910

10-
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}].
11+
12+
[role="_abstract"]
13+
As a cluster administrator, you install the OpenShift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs {velero-link}.
1114

1215
include::snippets/oadp-mtc-operator.adoc[]
1316

@@ -56,7 +59,7 @@ include::modules/oadp-configuring-noobaa-for-dr.adoc[leveloffset=+1]
5659
[role="_additional-resources"]
5760
.Additional resources
5861

59-
* link:https://{velero-domain}/docs/v{velero-version}/locations/[Overview of backup and snapshot locations in the Velero documentation]
62+
* {velero-overview}
6063
6164
include::modules/about-oadp-update-channels.adoc[leveloffset=+1]
6265
include::modules/about-installing-oadp-on-multiple-namespaces.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/troubleshooting/backup-and-restore-cr-issues.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="backup-and-restore-cr-issues"]
33
= Backup and Restore CR issues
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: backup-and-restore-cr-issues
79
:namespace: openshift-adp
810
:local-product: OADP
911

10-
toc::[]
1112

13+
14+
[role="_abstract"]
1215
You might encounter the following common issues with `Backup` and `Restore` custom resources (CRs):
1316

1417
* Backup CR cannot retrieve volume

backup_and_restore/application_backup_and_restore/troubleshooting/oadp-installation-issues.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="oadp-installation-issues"]
33
= OADP installation issues
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: installation-issues
79
:namespace: openshift-adp
810
:local-product: OADP
911

10-
toc::[]
1112

13+
14+
[role="_abstract"]
1215
You might encounter issues caused by using invalid directories or incorrect credentials when you install the Data Protection Application (DPA).
1316

1417
include::modules/resolving-backup-storage-contains-invalid-directories-issue.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="oadp-monitoring"]
33
= OADP monitoring
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: oadp-monitoring
79
:namespace: openshift-adp
810
:local-product: OADP
911

10-
toc::[]
1112

13+
14+
[role="_abstract"]
1215
By using the {product-title} monitoring stack, users and administrators can effectively perform the following tasks:
1316

1417
* Monitor and manage clusters
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="oadp-operator-issues"]
33
= OADP Operator issues
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: oadp-operator-issues
79
:namespace: openshift-adp
810
:local-product: OADP
911

10-
toc::[]
1112

13+
14+
[role="_abstract"]
1215
The {oadp-first} Operator might encounter issues caused by problems it is not able to resolve.
1316

1417
include::modules/resolving-oadp-operator-fails-silently-issue.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="oadp-timeouts"]
33
= OADP timeouts
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: oadp-timeouts
79
:namespace: openshift-adp
810
:local-product: OADP
911

10-
toc::[]
1112

13+
14+
[role="_abstract"]
1215
Extending a timeout allows complex or resource-intensive processes to complete successfully without premature termination. This configuration can reduce errors, retries, or failures.
1316

1417
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.

backup_and_restore/application_backup_and_restore/troubleshooting/pods-crash-or-restart-due-to-lack-of-memory-or-cpu.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="pods-crash-or-restart-due-to-lack-of-memory-or-cpu"]
33
= Pods crash or restart due to lack of memory or CPU
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: pods-crash-or-restart-due-to-lack-of-memory-or-cpu
@@ -9,8 +11,9 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
911
:must-gather-v1-3: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3
1012
:must-gather-v1-4: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4
1113

12-
toc::[]
1314

15+
16+
[role="_abstract"]
1417
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.
1518

1619
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:

backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="restic-issues"]
33
= Restic issues
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: restic-issues
79
:namespace: openshift-adp
810
:local-product: OADP
911

10-
toc::[]
1112

13+
14+
[role="_abstract"]
1215
You might encounter the following issues when you back up applications with Restic:
1316

1417
* Restic permission error for NFS data volumes with the `root_squash` resource/parameter enabled

backup_and_restore/application_backup_and_restore/troubleshooting/restoring-workarounds-for-velero-backups-that-use-admission-webhooks.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="restoring-workarounds-for-velero-backups-that-use-admission-webhooks"]
33
= Restoring workarounds for Velero backups that use admission webhooks
4+
:toc:
5+
46
include::_attributes/common-attributes.adoc[]
57
include::_attributes/attributes-openshift-dedicated.adoc[]
68
:context: restoring-workarounds-for-velero-backups-that-use-admission-webhooks
@@ -9,6 +11,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
911

1012
toc::[]
1113

14+
[role="_abstract"]
1215
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.
1316

1417
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.

0 commit comments

Comments
 (0)