OADP-6294: Mod-work for the OADP Troubleshooting user story #95005

apurvabhide17 · 2025-06-19T18:35:16Z

Version(s):
OCP 4.20

Issue:
OADP-6294

Link to docs preview:

QE review:

QE has approved this change.

Note -

This is a modularization work for the OADP Troubleshooting user story.
As discussed with Kathryn, skipping the QE review because this PR focuses on changing structure and there are no technical changes.

openshift-ci-robot · 2025-06-19T18:35:20Z

@apurvabhide17: This pull request references OADP-6294 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
OCP 4.20

Issue:
OADP-6294

Link to docs preview:

QE review:

QE has approved this change.

Note -

This is a modularization work for the OADP Troubleshooting user story.

As discussed with Kathryn, skipping the QE review because this PR focuses on changing structure and there are no technical changes.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

apurvabhide17 · 2025-06-19T18:35:29Z

/label OADP

ocpdocs-previewbot · 2025-06-19T18:42:29Z

🤖 Fri Jun 20 18:38:10 - Prow CI generated the docs preview:

modules/velero-oadp-version-relationship.adoc

…c issues

openshift-ci · 2025-06-20T18:39:59Z

@apurvabhide17: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

nunzy1 · 2025-06-20T18:50:40Z

modules/migration-debugging-velero-resources.adoc

+
+* 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 if the resource is actually in the cluster.
+
+* If there are `Velero` errors, but no resource-specific errors, in the output of a `describe` command, it is possible that the restore completed without any actual problems in restoring workloads, but carefully validate post-restore applications.


I would break this into at least two sentences. It will make the content easier to understand. Also, I was a tad confused by "but no resource-specific errors, in the output of a describe command," The comma in-between threw me off.

nunzy1 · 2025-06-20T18:52:21Z

modules/oadp-creating-alerting-rule.adoc


 :_mod-docs-content-type: PROCEDURE
 [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.
+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.


Maybe change:
To create an Alerting rule for the OADP project, use one of the Metrics, which are scraped with the user workload monitoring.

To:
To create an Alerting rule for the OADP project, use one of the Metrics scraped with the user workload monitoring.

Up to you!

nunzy1 · 2025-06-20T18:54:58Z

modules/oadp-creating-service-monitor.adoc

-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:
+OADP provides an `openshift-adp-velero-metrics-svc` service, which is created when the Data Protection Application (DPA) is configured. The service monitor used by the user workload monitoring must point to the defined service.


Maybe change:
The service monitor used by the user workload monitoring must point to the defined service.

To:
The user workload monitoring service monitor must point to the defined service.

nunzy1 · 2025-06-20T18:55:52Z

modules/oadp-creating-service-monitor.adoc


 .Procedure

-. Ensure the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which will be used as selector for the `ServiceMonitor` object.
-
+. Ensure that the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which will be used as selector for the `ServiceMonitor` object.


I'd leave out, "will be".

replace with "is"

nunzy1 · 2025-06-20T18:59:05Z

modules/oadp-debugging-oc-cli.adoc

-
-It is recommended to use the `info` `logLevel` value for most logs.
+
+It is recommended to use the `info` `logLevel` value for most logs.


Style guide recommends that we not use recommends. :-)

In this case, we could say why they should use....

Or, simpler, just say, "Use the info logLevel value for most logs."

nunzy1 · 2025-06-20T19:02:05Z

modules/oadp-monitoring-setup.adoc

@@ -39,7 +40,7 @@ metadata:
 ----
 <1> Add this option or set to `true`

-. Wait a short period of time to verify the User Workload Monitoring Setup by checking if the following components are up and running in the `openshift-user-workload-monitoring` namespace:
+. Wait a short period of time to verify if the User Workload Monitoring Setup by checking if the following components are up and running in the `openshift-user-workload-monitoring` namespace:


The added "if" makes the sentence a tad confusing. If that if is needed, the sentence could use a rewording to make it clear.

nunzy1 · 2025-06-20T19:04:53Z

modules/restic-backup-cr-cannot-be-recreated-after-bucket-is-emptied.adoc

+
+Velero does not recreate or update the Restic repository from the `ResticRepository` manifest if the Restic directories are deleted from object storage. For more information, see link:https://github.com/vmware-tanzu/velero/issues/4421[Velero issue 4421].
+
+If you create a Restic `Backup` CR for a namespace, empty the object storage bucket, and then recreate the `Backup` CR for the same namespace, the recreated `Backup` CR fails, the `velero` pod log displays the following error message:


IMO, too much in this sentence. I'd break it up. The way it reads, I'm thinking that the last comma could be replaced by "and".

anarnold97 · 2025-06-22T11:30:31Z

modules/oadp-creating-alerting-rule.adoc


 :_mod-docs-content-type: PROCEDURE
 [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.
+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.


Suggested change

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.

The {product-title} monitoring stack allows to receive Alerts configured using Alerting Rules. To create an Alerting rule for the {oadp-short} project, use one of the Metrics scraped with the user workload monitoring.

anarnold97 · 2025-06-22T11:32:09Z

modules/oadp-creating-service-monitor.adoc

-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:
+OADP provides an `openshift-adp-velero-metrics-svc` service, which is created when the Data Protection Application (DPA) is configured. The service monitor used by the user workload monitoring must point to the defined service.


Suggested change

OADP provides an `openshift-adp-velero-metrics-svc` service, which is created when the Data Protection Application (DPA) is configured. The service monitor used by the user workload monitoring must point to the defined service.

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

anarnold97 · 2025-06-22T11:32:31Z

modules/oadp-creating-service-monitor.adoc


 .Procedure

-. Ensure the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which will be used as selector for the `ServiceMonitor` object.
-
+. Ensure that the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which will be used as selector for the `ServiceMonitor` object.


Suggested change

. Ensure that the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which will be used as selector for the `ServiceMonitor` object.

. Ensure that the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which is used as selector for the `ServiceMonitor` object.

OADP-6294: Mod-work for the OADP Troubleshooting user story

9c2a9d3

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 19, 2025

openshift-ci bot added OADP Label for all OADP PRs size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 19, 2025

ocpdocs-vale-bot reviewed Jun 19, 2025

View reviewed changes

modules/velero-oadp-version-relationship.adoc Outdated Show resolved Hide resolved

apurvabhide17 added 2 commits June 20, 2025 00:23

Reviewed modules from OADP Monitoring assembly

ac749e7

Updated modules for timeouts, backup and restore CR issues, and resti…

588682b

…c issues

openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 20, 2025

nunzy1 reviewed Jun 20, 2025

View reviewed changes

anarnold97 reviewed Jun 22, 2025

View reviewed changes


		* 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 if the resource is actually in the cluster.

		* If there are `Velero` errors, but no resource-specific errors, in the output of a `describe` command, it is possible that the restore completed without any actual problems in restoring workloads, but carefully validate post-restore applications.


		Velero does not recreate or update the Restic repository from the `ResticRepository` manifest if the Restic directories are deleted from object storage. For more information, see link:https://github.com/vmware-tanzu/velero/issues/4421[Velero issue 4421].

		If you create a Restic `Backup` CR for a namespace, empty the object storage bucket, and then recreate the `Backup` CR for the same namespace, the recreated `Backup` CR fails, the `velero` pod log displays the following error message:

	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.
	The {product-title} monitoring stack allows to receive Alerts configured using Alerting Rules. To create an Alerting rule for the {oadp-short} project, use one of the Metrics scraped with the user workload monitoring.

	OADP provides an `openshift-adp-velero-metrics-svc` service, which is created when the Data Protection Application (DPA) is configured. The service monitor used by the user workload monitoring must point to the defined service.
	{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.

	. Ensure that the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which will be used as selector for the `ServiceMonitor` object.
	. Ensure that the `openshift-adp-velero-metrics-svc` service exists. It should contain `app.kubernetes.io/name=velero` label, which is used as selector for the `ServiceMonitor` object.

OADP-6294: Mod-work for the OADP Troubleshooting user story #95005

Are you sure you want to change the base?

OADP-6294: Mod-work for the OADP Troubleshooting user story #95005

Uh oh!

Conversation

apurvabhide17 commented Jun 19, 2025

Uh oh!

openshift-ci-robot commented Jun 19, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apurvabhide17 commented Jun 19, 2025

Uh oh!

ocpdocs-previewbot commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

openshift-ci bot commented Jun 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

openshift-ci-robot commented Jun 19, 2025 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Jun 19, 2025 •

edited

Loading