Skip to content

OADP#8503: refactor velero CLI doc - #117197

Open
ousleyp wants to merge 1 commit into
openshift:mainfrom
ousleyp:oadp-8503
Open

OADP#8503: refactor velero CLI doc#117197
ousleyp wants to merge 1 commit into
openshift:mainfrom
ousleyp:oadp-8503

Conversation

@ousleyp

@ousleyp ousleyp commented Aug 3, 2026

Copy link
Copy Markdown
Member

Version(s): 4.22, 5.0

Issue: OADP-8503

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Original PR was #116567 - I took ownership due to Andy's departure

Additional changes:

  • per comments on the original PR, I added the installing oadp CLI module where the velero download module was. I moved the velero module to the bottom and commented it out for now.
  • updated xref in "Overview of backup and restore operations" because it broke when I commented out the velero download module. The link should have been pointing to the table anyway, so... free bug fix!

@ousleyp ousleyp added this to the Continuous Release milestone Aug 3, 2026
@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 3, 2026
@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 3, 2026
@openshift-ci openshift-ci Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 3, 2026
Signed-off-by: A.Arnold <anarnold@redhat.com>

Co-authored-by: Wesley Hayutin <138787+weshayutin@users.noreply.github.com>
@ousleyp

ousleyp commented Aug 3, 2026

Copy link
Copy Markdown
Member Author

/retest

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

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].
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-oadp-version-relationship_velero-cli-tool[OADP-Velero-{product-title} version relationship]. 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].

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

@openshift-ci

openshift-ci Bot commented Aug 3, 2026

Copy link
Copy Markdown

@ousleyp: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.22 branch/enterprise-5.0 OADP Label for all OADP PRs size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants