From 35a2a87b5c4e596f665303992964d0d2f31409ec Mon Sep 17 00:00:00 2001 From: Andrew Burden Date: Thu, 27 Aug 2020 14:17:22 +0200 Subject: [PATCH] Adding new file to download virtctl from web console --- modules/virt-enabling-virt-repos.adoc | 2 +- .../virt-installing-virtctl-client-web.adoc | 49 +++++++++++++++++++ modules/virt-installing-virtctl-client.adoc | 2 +- virt/install/virt-installing-virtctl.adoc | 11 +++-- 4 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 modules/virt-installing-virtctl-client-web.adoc diff --git a/modules/virt-enabling-virt-repos.adoc b/modules/virt-enabling-virt-repos.adoc index 89603b3629..808d248ed9 100644 --- a/modules/virt-enabling-virt-repos.adoc +++ b/modules/virt-enabling-virt-repos.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// install/virt-installing-virtctl.adoc +// virt/install/virt-installing-virtctl.adoc [id="virt-enabling-virt-repos_{context}"] = Enabling {VirtProductName} repositories diff --git a/modules/virt-installing-virtctl-client-web.adoc b/modules/virt-installing-virtctl-client-web.adoc new file mode 100644 index 0000000000..2bd6daf131 --- /dev/null +++ b/modules/virt-installing-virtctl-client-web.adoc @@ -0,0 +1,49 @@ +// Module included in the following assemblies: +// +// virt/install/virt-installing-virtctl.adoc + +[id="virt-installing-virtctl-client-web_{context}"] += Installing the `virtctl` client from the web console + +You can download the `virtctl` client from the Red Hat Customer Portal, which is linked to in your {VirtProductName} web console in the *Command Line Tools* page. + +.Prerequisites + +* You must have an activated {product-title} subscription to access the download page on the Customer Portal. + +.Procedure + +. Access the Customer Portal by clicking the image:question-circle.png[title="Help"] icon, which is in the upper-right corner of the web console, and selecting *Command Line Tools*. + +. Ensure you have the appropriate version for your cluster selected from the *Version:* list. + +. Download the `virtctl` client for your distribution. All downloads are in `tar.gz` format. + +. Extract the tarball. The following CLI command extracts it into the same directory as the tarball and is applicable for all distributions: ++ +[source,terminal] +---- +$ tar -xvf .tar.gz +---- + +. For Linux and macOS: + +.. Navigate the extracted folder hierachy and make the `virtctl` binary executable: ++ +[source,terminal] +---- +$ chmod +x +---- + +.. Move the `virtctl` binary to a directory on your PATH. + +... To check your path, run: ++ +[source,terminal] +---- +$ echo $PATH +---- + +. For Windows users: + +.. Navigate the extracted folder hierarchy and double-click the `virtctl` executable file to install the client. diff --git a/modules/virt-installing-virtctl-client.adoc b/modules/virt-installing-virtctl-client.adoc index 90096056f0..87fc3769c2 100644 --- a/modules/virt-installing-virtctl-client.adoc +++ b/modules/virt-installing-virtctl-client.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// install/virt-installing-virtctl.adoc +// virt/install/virt-installing-virtctl.adoc [id="virt-installing-virtctl-client_{context}"] = Installing the `virtctl` client diff --git a/virt/install/virt-installing-virtctl.adoc b/virt/install/virt-installing-virtctl.adoc index b688695063..387a2e54de 100644 --- a/virt/install/virt-installing-virtctl.adoc +++ b/virt/install/virt-installing-virtctl.adoc @@ -5,13 +5,16 @@ include::modules/virt-document-attributes.adoc[] toc::[] The `virtctl` client is a command-line utility for managing {VirtProductName} -resources. +resources. It is available for Linux, macOS, and Windows distributions. -Install the client to your system by enabling the {VirtProductName} repository and -installing the `kubevirt-virtctl` package. +You can install the `virtctl` client from the {VirtProductName} web console or by enabling the {VirtProductName} repository and installing the `kubevirt-virtctl` package. + +include::modules/virt-installing-virtctl-client-web.adoc[leveloffset=+1] include::modules/virt-enabling-virt-repos.adoc[leveloffset=+1] + include::modules/virt-installing-virtctl-client.adoc[leveloffset=+1] -See also: +[id="virt-installing-virtctl-addtl-resources"] +== Additional resources xref:../../virt/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[Using the CLI tools] for {VirtProductName}.