Skip to content

OADP-8503: Removing the Velro CLI docs in OADP - #116567

Closed
anarnold97 wants to merge 5 commits into
openshift:mainfrom
anarnold97:OADP-8503-Velero-CLI
Closed

OADP-8503: Removing the Velro CLI docs in OADP#116567
anarnold97 wants to merge 5 commits into
openshift:mainfrom
anarnold97:OADP-8503-Velero-CLI

Conversation

@anarnold97

@anarnold97 anarnold97 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

JIRA


Version(s):

  • OCP - main
  • OCP - 4.22
  • OCP - 5.0

Link to docs preview:


QE review:

  • QE has approved this change.

Signed-off-by: A.Arnold <anarnold@redhat.com>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 27, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 27, 2026

Copy link
Copy Markdown

@anarnold97: This pull request references OADP-8503 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 task to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 27, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 27, 2026

Copy link
Copy Markdown

Signed-off-by: A.Arnold <anarnold@redhat.com>
@openshift-ci openshift-ci Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 27, 2026
…ing/velero-cli-tool.adoc

Co-authored-by: Wesley Hayutin <138787+weshayutin@users.noreply.github.com>
@@ -1,25 +1,21 @@
:_mod-docs-content-type: ASSEMBLY
[id="velero-cli-tool"]
= Velero CLI tool

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
= Velero CLI tool
= Debugging backup and restore operations

Should we also change the name of the page to something more neutral

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
= Velero CLI tool
= OADP CLI plugin and Velero CLI tool

or even keep both tools visible in the title, which is more honest about the page's actual content.


[role="_abstract"]
Download the `velero` CLI tool or access the `velero` binary in your cluster to debug `Backup` and `Restore` custom resources (CRs) and retrieve logs. This helps you to troubleshoot failed backup and restore operations.
Use the {oadp-short} CLI plugin for all backup and restore operations, including viewing logs and descriptions. You do not need to download the `velero` CLI tool to debug `Backup` and `Restore` custom resources (CRs) or troubleshoot failed operations.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reworked to fit RH style for abstracts

@openshift-ci

openshift-ci Bot commented Jul 27, 2026

Copy link
Copy Markdown

@anarnold97: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

@weshayutin

Copy link
Copy Markdown
Screenshot From 2026-07-27 12-41-17

this section needs to change to be installed by openshift cli download.
@NicholasYancey @Joeavaikath please provide @anarnold97 w/ screenshots and language.

@Joeavaikath

Copy link
Copy Markdown

On the OpenShift console, navigate as shown:
Screenshot 2026-07-27 at 3 28 27 PM
Screenshot 2026-07-27 at 3 30 21 PM
Screenshot 2026-07-27 at 3 30 55 PM

@anarnold97 anarnold97 changed the title OADP-8503: Refactoring the Velro CLI docs in OADP OADP-8503: Removing the Velro CLI docs in OADP Jul 28, 2026
@ousleyp

ousleyp commented Aug 4, 2026

Copy link
Copy Markdown
Member

Closing to move this work to #117197 (needs SME approval)

@ousleyp ousleyp closed this Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants