Skip to content

Commit 4bb59d4

Browse files
shdeshpa07anarnold97
authored andcommitted
Move OADP configuring sections one level up
Signed-off-by: Shruti Deshpande <[email protected]>
1 parent d5d9b12 commit 4bb59d4

19 files changed

+132
-96
lines changed

_topic_maps/_topic_map.yml

Lines changed: 77 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3669,29 +3669,58 @@ Topics:
36693669
File: oadp-usecase-enable-ca-cert
36703670
- Name: Using the legacy-aws Velero plugin
36713671
File: oadp-usecase-legacy-aws-plugin
3672-
- Name: Installing and configuring OADP
3672+
- Name: Backing up workloads on OADP with ROSA STS
3673+
File: oadp-rosa-backup-restore
3674+
- Name: Installing OADP
36733675
Dir: installing
36743676
Topics:
36753677
- Name: About installing OADP
36763678
File: about-installing-oadp
36773679
- Name: Installing the OADP Operator
36783680
File: oadp-installing-operator
3681+
- Name: Configuring OADP with AWS S3 compatible storage
3682+
Dir: installing
3683+
Topics:
36793684
- Name: Configuring OADP with AWS S3 compatible storage
36803685
File: installing-oadp-aws
3686+
- Name: Configuring OADP with IBM Cloud
3687+
Dir: installing
3688+
Topics:
36813689
- Name: Configuring OADP with IBM Cloud
36823690
File: installing-oadp-ibm-cloud
3691+
- Name: Configuring OADP with Azure
3692+
Dir: installing
3693+
Topics:
36833694
- Name: Configuring OADP with Azure
36843695
File: installing-oadp-azure
3696+
- Name: Configuring OADP with GCP
3697+
Dir: installing
3698+
Topics:
36853699
- Name: Configuring OADP with GCP
36863700
File: installing-oadp-gcp
3701+
- Name: Configuring OADP with MCG
3702+
Dir: installing
3703+
Topics:
36873704
- Name: Configuring OADP with MCG
36883705
File: installing-oadp-mcg
3706+
- Name: Configuring OADP with ODF
3707+
Dir: installing
3708+
Topics:
36893709
- Name: Configuring OADP with ODF
36903710
File: installing-oadp-ocs
3711+
- Name: Configuring OADP with OpenShift Virtualization
3712+
Dir: installing
3713+
Topics:
36913714
- Name: Configuring OADP with OpenShift Virtualization
36923715
File: installing-oadp-kubevirt
3716+
- Name: Configuring OADP with multiple backup storage locations
3717+
Dir: installing
3718+
Topics:
36933719
- Name: Configuring OADP with multiple backup storage locations
36943720
File: configuring-oadp-multiple-bsl
3721+
- Name: Configuring OADP with multiple Volume Snapshot Locations
3722+
Dir: installing
3723+
Topics:
36953724
- Name: Configuring OADP with multiple Volume Snapshot Locations
36963725
File: configuring-oadp-multiple-vsl
36973726
- Name: Uninstalling OADP
@@ -3766,28 +3795,31 @@ Topics:
37663795
File: oadp-api
37673796
- Name: Advanced OADP features and functionalities
37683797
File: oadp-advanced-topics
3769-
- Name: Troubleshooting OADP
3770-
File: troubleshooting
3771-
- Name: Velero CLI tool
3772-
File: velero-cli-tool
3773-
- Name: Pods crash or restart due to lack of memory or CPU
3774-
File: pods-crash-or-restart-due-to-lack-of-memory-or-cpu
3775-
- Name: Issues with Velero and admission webhooks
3776-
File: issues-with-velero-and-admission-webhooks
3777-
- Name: OADP installation issues
3778-
File: oadp-installation-issues
3779-
- Name: OADP Operator issues
3780-
File: oadp-operator-issues
3781-
- Name: OADP timeouts
3782-
File: oadp-timeouts
3783-
- Name: Backup and Restore CR issues
3784-
File: backup-and-restore-cr-issues
3785-
- Name: Restic issues
3786-
File: restic-issues
3787-
- Name: Using the must-gather tool
3788-
File: using-the-must-gather-tool
3789-
- Name: OADP monitoring
3790-
File: oadp-monitoring
3798+
- Name: OADP troubleshooting
3799+
Dir: troubleshooting
3800+
Topics:
3801+
- Name: Troubleshooting OADP
3802+
File: troubleshooting
3803+
- Name: Velero CLI tool
3804+
File: velero-cli-tool
3805+
- Name: Pods crash or restart due to lack of memory or CPU
3806+
File: pods-crash-or-restart-due-to-lack-of-memory-or-cpu
3807+
- Name: Issues with Velero and admission webhooks
3808+
File: issues-with-velero-and-admission-webhooks
3809+
- Name: OADP installation issues
3810+
File: oadp-installation-issues
3811+
- Name: OADP Operator issues
3812+
File: oadp-operator-issues
3813+
- Name: OADP timeouts
3814+
File: oadp-timeouts
3815+
- Name: Backup and Restore CR issues
3816+
File: backup-and-restore-cr-issues
3817+
- Name: Restic issues
3818+
File: restic-issues
3819+
- Name: Using the must-gather tool
3820+
File: using-the-must-gather-tool
3821+
- Name: OADP monitoring
3822+
File: oadp-monitoring
37913823
- Name: Control plane backup and restore
37923824
Dir: control_plane_backup_and_restore
37933825
Topics:
@@ -4713,28 +4745,28 @@ Topics:
47134745
- Name: Advanced VM creation
47144746
Dir: creating_vms_advanced
47154747
Topics:
4716-
- Name: Advanced virtual machine creation overview
4717-
File: advanced-vm-creation-overview
4718-
- Name: Creating VMs in the web console
4719-
Dir: creating_vms_advanced_web
4720-
Topics:
4721-
- Name: Creating VMs from Red Hat images
4722-
File: virt-creating-vms-from-rh-images-overview
4723-
- Name: Creating VMs by importing images from web pages
4724-
File: virt-creating-vms-from-web-images
4725-
- Name: Creating VMs by uploading images
4726-
File: virt-creating-vms-uploading-images
4727-
- Name: Cloning VMs
4728-
File: virt-cloning-vms
4729-
- Name: Creating VMs using the CLI
4730-
Dir: creating_vms_cli
4731-
Topics:
4732-
- Name: Creating virtual machines from the command line
4733-
File: virt-creating-vms-from-cli
4734-
- Name: Creating VMs by using container disks
4735-
File: virt-creating-vms-from-container-disks
4736-
- Name: Creating VMs by cloning PVCs
4737-
File: virt-creating-vms-by-cloning-pvcs
4748+
- Name: Advanced virtual machine creation overview
4749+
File: advanced-vm-creation-overview
4750+
- Name: Creating VMs in the web console
4751+
Dir: creating_vms_advanced_web
4752+
Topics:
4753+
- Name: Creating VMs from Red Hat images
4754+
File: virt-creating-vms-from-rh-images-overview
4755+
- Name: Creating VMs by importing images from web pages
4756+
File: virt-creating-vms-from-web-images
4757+
- Name: Creating VMs by uploading images
4758+
File: virt-creating-vms-uploading-images
4759+
- Name: Cloning VMs
4760+
File: virt-cloning-vms
4761+
- Name: Creating VMs using the CLI
4762+
Dir: creating_vms_cli
4763+
Topics:
4764+
- Name: Creating virtual machines from the command line
4765+
File: virt-creating-vms-from-cli
4766+
- Name: Creating VMs by using container disks
4767+
File: virt-creating-vms-from-container-disks
4768+
- Name: Creating VMs by cloning PVCs
4769+
File: virt-creating-vms-by-cloning-pvcs
47384770
- Name: Managing VMs
47394771
Dir: managing_vms
47404772
Topics:

backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. S
6161
This issue has been resolved in the OADP 1.1.6 and OADP 1.2.2 releases, therefore it is recommended that users upgrade to these releases.
6262

6363
ifndef::openshift-rosa,openshift-rosa-hcp[]
64-
For more information, see xref:../../../backup_and_restore/application_backup_and_restore/restic-issues.adoc#oadp-restic-restore-failing-psa-policy_restic-issues[Restic restore partially failing on OCP 4.15 due to changed PSA policy].
64+
For more information, see xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc#oadp-restic-restore-failing-psa-policy_restic-issues[Restic restore partially failing on OCP 4.15 due to changed PSA policy].
6565
endif::openshift-rosa,openshift-rosa-hcp[]
6666

6767
// TODO: Add xrefs to ROSA HCP when Operators book is added.

backup_and_restore/application_backup_and_restore/troubleshooting.adoc

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../_attributes/
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../images/

backup_and_restore/application_backup_and_restore/issues-with-velero-and-admission-webhooks.adoc renamed to backup_and_restore/application_backup_and_restore/troubleshooting/issues-with-velero-and-admission-webhooks.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ include::modules/oadp-plugins-receiving-eof-message.adoc[leveloffset=+1]
2828
[role="_additional-resources"]
2929
.Additional resources
3030

31-
* xref:../../architecture/admission-plug-ins.adoc#admission-plug-ins[Admission plugins]
32-
* xref:../../architecture/admission-plug-ins.adoc#admission-webhooks-about_admission-plug-ins[Webhook admission plugins]
33-
* xref:../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plugins]
31+
* xref:../../../architecture/admission-plug-ins.adoc#admission-plug-ins[Admission plugins]
32+
* xref:../../../architecture/admission-plug-ins.adoc#admission-webhooks-about_admission-plug-ins[Webhook admission plugins]
33+
* xref:../../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plugins]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../modules

backup_and_restore/application_backup_and_restore/oadp-monitoring.adoc renamed to backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ By using the {product-title} monitoring stack, users and administrators can effe
1818
1919
[role="_additional-resources"]
2020
.Additional resources
21-
* xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
21+
* xref:../../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
2222
2323
include::modules/oadp-monitoring-setup.adoc[leveloffset=+1]
2424
include::modules/oadp-creating-service-monitor.adoc[leveloffset=+1]
2525
include::modules/oadp-creating-alerting-rule.adoc[leveloffset=+1]
2626

2727
[role="_additional-resources"]
2828
.Additional resources
29-
* xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator]
29+
* xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator]
3030
3131
include::modules/oadp-list-of-metrics.adoc[leveloffset=+1]
32-
include::modules/oadp-viewing-metrics-ui.adoc[leveloffset=+1]
32+
include::modules/oadp-viewing-metrics-ui.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc renamed to backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ Ensure that you balance timeout extensions in a logical manner so that you do no
1515

1616
The following OADP timeouts show instructions of how and when to implement these parameters:
1717

18-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc#restic-timeout_oadp-timeouts[Restic timeout]
18+
* xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#restic-timeout_oadp-timeouts[Restic timeout]
1919
20-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc#velero-timeout_oadp-timeouts[Velero resource timeout]
20+
* xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#velero-timeout_oadp-timeouts[Velero resource timeout]
2121
22-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc#datamover-timeout_oadp-timeouts[Data Mover timeout]
22+
* xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#datamover-timeout_oadp-timeouts[Data Mover timeout]
2323
24-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc#csisnapshot-timeout_oadp-timeouts[CSI snapshot timeout]
24+
* xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#csisnapshot-timeout_oadp-timeouts[CSI snapshot timeout]
2525
26-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc#item-operation-timeout-backup_oadp-timeouts[Item operation timeout - backup]
26+
* xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#item-operation-timeout-backup_oadp-timeouts[Item operation timeout - backup]
2727
28-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-timeouts.adoc#item-operation-timeout-restore_oadp-timeouts[Item operation timeout - restore]
28+
* xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#item-operation-timeout-restore_oadp-timeouts[Item operation timeout - restore]
2929
3030
include::modules/oadp-restic-timeouts.adoc[leveloffset=+1]
3131
include::modules/oadp-velero-timeouts.adoc[leveloffset=+1]
3232
include::modules/oadp-velero-default-timeouts.adoc[leveloffset=+2]
3333
include::modules/oadp-datamover-timeouts.adoc[leveloffset=+1]
3434
include::modules/oadp-csi-snapshot-timeouts.adoc[leveloffset=+1]
3535
include::modules/oadp-item-restore-timeouts.adoc[leveloffset=+1]
36-
include::modules/oadp-item-backup-timeouts.adoc[leveloffset=+1]
36+
include::modules/oadp-item-backup-timeouts.adoc[leveloffset=+1]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ requests:
2525

2626
[role="_additional-resources"]
2727
.Additional resources
28-
* xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#oadp-velero-cpu-memory-requirements_about-installing-oadp[Velero CPU and memory requirements based on collected data]
28+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#oadp-velero-cpu-memory-requirements_about-installing-oadp[Velero CPU and memory requirements based on collected data]
2929
3030
include::modules/oadp-pod-crash-set-resource-request-velero.adoc[leveloffset=+1]
31-
include::modules/oadp-pod-crash-set-resource-request-restic.adoc[leveloffset=+1]
31+
include::modules/oadp-pod-crash-set-resource-request-restic.adoc[leveloffset=+1]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../snippets/
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="troubleshooting"]
3+
= Troubleshooting
4+
include::_attributes/common-attributes.adoc[]
5+
include::_attributes/attributes-openshift-dedicated.adoc[]
6+
:context: oadp-troubleshooting
7+
:oadp-troubleshooting:
8+
:namespace: openshift-adp
9+
:local-product: OADP
10+
:must-gather-v1-3: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3
11+
:must-gather-v1-4: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4
12+
13+
toc::[]
14+
15+
You can troubleshoot OADP issues by using the following methods:
16+
17+
* 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.
18+
19+
* Debug Velero or Restic pod crashes, which are caused due to a lack of memory or CPU by using xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/pods-crash-or-restart-due-to-lack-of-memory-or-cpu.adoc#pods-crash-or-restart-due-to-lack-of-memory-or-cpu[Pods crash or restart due to lack of memory or CPU].
20+
21+
* Debug issues with Velero and admission webhooks by using xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/issues-with-velero-and-admission-webhooks.adoc#issues-with-velero-and-admission-webhooks[Issues with Velero and admission webhooks].
22+
23+
* Check xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-installation-issues.adoc#oadp-installation-issues[OADP installation issues], xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-operator-issues.adoc#oadp-operator-issues[OADP Operator issues], xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/backup-and-restore-cr-issues.adoc#backup-and-restore-cr-issues[backup and restore CR issues], and xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/restic-issues.adoc#restic-issues[Restic issues].
24+
25+
* Use the available xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-timeouts.adoc#oadp-timeouts[OADP timeouts] to reduce errors, retries, or failures.
26+
27+
* Collect logs and CR information by using the xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc#using-the-must-gather-tool[`must-gather` tool].
28+
29+
* Monitor and analyze the workload performance with the help of xref:../../../backup_and_restore/application_backup_and_restore/troubleshooting/oadp-monitoring.adoc#oadp-monitoring[OADP monitoring].
30+
31+
32+
:oadp-troubleshooting!:

backup_and_restore/application_backup_and_restore/using-the-must-gather-tool.adoc renamed to backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ This operation can take a long time. The data is saved as `must-gather/metrics/p
7070
7171
[role="_additional-resources"]
7272
.Additional resources
73-
* xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering cluster data]
73+
* xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering cluster data]
7474
7575
include::modules/support-insecure-tls-connections.adoc[leveloffset=+1]
76-
include::modules/migration-combining-must-gather.adoc[leveloffset=+1]
76+
include::modules/migration-combining-must-gather.adoc[leveloffset=+1]

backup_and_restore/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You can always recover from a disaster situation by xref:../backup_and_restore/c
3838

3939
As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
4040

41-
OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using the version of Velero that is appropriate for the version of OADP you install, according to the table in xref:../backup_and_restore/application_backup_and_restore/velero-cli-tool.adoc#velero-obtaining-by-downloading_velero-cli-tool[Downloading the Velero CLI tool]. OADP backs up and restores persistent volumes (PVs) by using snapshots or Restic. For details, see xref:../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
41+
OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using the version of Velero that is appropriate for the version of OADP you install, according to the table in xref:../backup_and_restore/application_backup_and_restore/troubleshooting/velero-cli-tool.adoc#velero-obtaining-by-downloading_velero-cli-tool[Downloading the Velero CLI tool]. OADP backs up and restores persistent volumes (PVs) by using snapshots or Restic. For details, see xref:../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
4242

4343
[id="oadp-requirements"]
4444
=== OADP requirements

0 commit comments

Comments
 (0)