Merge pull request #45926 from RichardHoch/cli_tool_2

OADP_476:Where to get Velero CLI tool [new PR]

Author: maxwelldb

backup_and_restore/application_backup_and_restore/troubleshooting.adoc

@@ -17,12 +17,20 @@ You can check xref:../../backup_and_restore/application_backup_and_restore/troub
 
 You can collect logs, CR information, and Prometheus metric data by using the xref:../../backup_and_restore/application_backup_and_restore/troubleshooting.adoc#migration-using-must-gather_oadp-troubleshooting[`must-gather` tool].
 
+You can obtain the Velero CLI tool by:
+
+* Downloading the Velero CLI tool
+* Accessing the Velero binary in the Velero deployment in the cluster
+
+include::modules/velero-obtaining-by-downloading.adoc[leveloffset=+1]
+include::modules/velero-obtaining-by-accessing-binary.adoc[leveloffset=+1]
+
 include::modules/oadp-debugging-oc-cli.adoc[leveloffset=+1]
 include::modules/migration-debugging-velero-resources.adoc[leveloffset=+1]
 
 include::modules/oadp-installation-issues.adoc[leveloffset=+1]
 include::modules/oadp-backup-restore-cr-issues.adoc[leveloffset=+1]
-include::modules/oadp-restic-issues.adoc[leveloffset=+1]
+include::modules/oadp-restic-issues.adoc[leveloffset=+12]
 
 include::modules/migration-using-must-gather.adoc[leveloffset=+1]
 

modules/using-must-gather.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
+
+:_content-type: PROCEDURE
+[id="velero-obtaining-by-accessing-binary_{context}"]
+= Accessing the Velero binary in the Velero deployment in the cluster
+
+You can use a shell command to access the Velero binary in the Velero deployment in the cluster.
+
+.Prerequisites
+
+* Your `DataProtectionApplication` custom resource has a status of `Reconcile complete`.
+
+.Procedure
+
+* Enter the following command to set the needed alias:
++
+[source,terminal]
+----
+$ alias velero='oc -n openshift-adp exec deployment/velero -c velero -it -- ./velero'
+----

modules/velero-obtaining-by-accessing-binary.adoc

@@ -0,0 +1,38 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
+
+:_content-type: PROCEDURE
+[id="velero-obtaining-by-downloading_{context}"]
+= Downloading the Velero CLI tool
+
+You can download and install the Velero CLI tool by following the instructions on the link:https://velero.io/docs/v1.8/basic-install/#install-the-cli[Velero documentation page].
+
+The page includes instructions for:
+
+* macOS by using Homebrew
+* GitHub
+* Windows by using Chocolatey
+
+.Prerequisites
+
+* You have access to a Kubernetes cluster, v1.16 or later, with DNS and container networking enabled.
+* You have installed `kubectl` locally.
+
+.Procedure
+
+. Open a browser and navigate to link:https://velero.io/docs/v1.8/basic-install/#install-the-cli["Install the CLI" on the Verleo website].
+. Follow the appropriate procedure for macOS, GitHub, or Windows.
+. Download the Velero version appropriate for your version of OADP, according to the table that follows:
++
+.OADP-Velero version relationship
+[cols="2", options="header"]
+|===
+|OADP version |Velero version
+|0.2.6 |1.6.0
+|0.5.5 |1.7.1
+|1.0.0 |1.7.1
+|1.0.1 |1.7.1
+|1.0.2 |1.7.1
+|1.0.3 |1.7.1
+|===