Skip to content

Commit 4a19a11

Browse files
apinnickapinnick
authored
Merge pull request #54135 from apinnick/CNV-18460-download-virtctl-link
CNV-18460: virtctl download and installation
2 parents d600a92 + 5eb5d74 commit 4a19a11

10 files changed

+48
-67
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3339,8 +3339,8 @@ Topics:
33393339
- Name: Installing OKD Virtualization using the CLI
33403340
File: installing-virt-cli
33413341
Distros: openshift-origin
3342-
- Name: Enabling the virtctl client
3343-
File: virt-enabling-virtctl
3342+
- Name: Installing the virtctl client
3343+
File: virt-installing-virtctl
33443344
- Name: Uninstalling OpenShift Virtualization
33453345
File: uninstalling-virt
33463346
Distros: openshift-enterprise

‎modules/virt-downloading-virtctl-client.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎modules/virt-enabling-virt-repos.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// virt/install/virt-enabling-virtctl.adoc
3+
// * virt/install/virt-installing-virtctl.adoc
44

55
:_content-type: PROCEDURE
66
[id="virt-enabling-virt-repos_{context}"]

‎modules/virt-installing-virtctl-client-yum.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// virt/install/virt-enabling-virtctl.adoc
3+
// * virt/install/virt-installing-virtctl.adoc
44

55
:_content-type: PROCEDURE
66
[id="virt-installing-virtctl-client-yum_{context}"]

‎modules/virt-installing-virtctl-client.adoc

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,75 @@
11
// Module included in the following assemblies:
22
//
3-
// virt/install/virt-enabling-virtctl.adoc
3+
// * virt/install/virt-installing-virtctl.adoc
44

55
:_content-type: PROCEDURE
66
[id="virt-installing-virtctl-client_{context}"]
7-
= Installing the virtctl client
7+
= Installing the virtctl client on Linux, Windows, and macOS
88

9-
Extract and install the `virtctl` client after downloading from the appropriate location for your operating system.
9+
Download and install the `virtctl` client for your operating system.
1010

11-
.Prerequisites
11+
.Procedure
1212

13-
* You must have downloaded the `virtctl` client.
13+
. Navigate to *Virtualization > Overview* in the {product-title} web console.
1414

15-
.Procedure
15+
. Click the *Download virtctl* link on the upper right corner of the page and download the `virtctl` client for your operating system.
16+
17+
. Install `virtctl`:
1618

1719
* For Linux:
1820
19-
. Extract the tarball. The following CLI command extracts it into the same directory as the tarball:
21+
.. Decompress the archive file:
2022
+
2123
[source,terminal]
2224
----
2325
$ tar -xvf <virtctl-version-distribution.arch>.tar.gz
2426
----
2527

26-
. Navigate the extracted folder hierachy and run the following command to make the `virtctl` binary executable:
28+
.. Run the following command to make the `virtctl` binary executable:
2729
+
2830
[source,terminal]
2931
----
30-
$ chmod +x <virtctl-file-name>
32+
$ chmod +x <path/virtctl-file-name>
3133
----
3234

33-
. Move the `virtctl` binary to a directory in your `PATH` environment variable.
34-
35-
. To check your path, run the following command:
35+
.. Move the `virtctl` binary to a directory in your `PATH` environment variable.
36+
+
37+
You can check your path by running the following command:
3638
+
3739
[source,terminal]
3840
----
3941
$ echo $PATH
4042
----
4143

42-
* For Windows users:
43-
44-
. Unpack and unzip the archive.
44+
.. Set the `KUBECONFIG` environment variable:
45+
+
46+
[source,terminal]
47+
----
48+
$ export KUBECONFIG=/home/<user>/clusters/current/auth/kubeconfig
49+
----
4550

46-
. Navigate the extracted folder hierarchy and double-click the `virtctl` executable file to install the client.
51+
* For Windows:
52+
+
53+
.. Decompress the archive file.
4754
48-
. Move the `virtctl` binary to a directory in your `PATH` environment variable.
55+
.. Navigate the extracted folder hierarchy and double-click the `virtctl` executable file to install the client.
4956

50-
. To check your path, run the following command:
57+
.. Move the `virtctl` binary to a directory in your `PATH` environment variable.
58+
+
59+
You can check your path by running the following command:
5160
+
5261
[source,terminal]
5362
----
5463
C:\> path
5564
----
5665

57-
* For macOS users:
58-
59-
. Unpack and unzip the archive.
60-
61-
. Move the `virtctl` binary to a directory in your `PATH` environment variable.
66+
* For macOS:
67+
+
68+
.. Decompress the archive file.
6269
63-
. To check your path, run the following command:
70+
.. Move the `virtctl` binary to a directory in your `PATH` environment variable.
71+
+
72+
You can check your path by running the following command:
6473
+
6574
[source,terminal]
6675
----

‎virt/install/virt-enabling-virtctl.adoc renamed to ‎virt/install/virt-installing-virtctl.adoc

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
:_content-type: ASSEMBLY
2-
[id="virt-enabling-virtctl"]
3-
= Enabling the virtctl client
2+
[id="virt-installing-virtctl"]
3+
= Installing the virtctl client
44
include::_attributes/common-attributes.adoc[]
5-
:context: virt-enabling-virtctl
5+
:context: virt-installing-virtctl
66

77
toc::[]
88

9-
The `virtctl` client is a command-line utility for managing {VirtProductName}
10-
resources. It is available for Linux, macOS, and Windows distributions.
9+
The `virtctl` client is a command-line utility for managing {VirtProductName} resources. It is available for Linux, Windows, and macOS.
1110

12-
[id="virtctl-download-install_{context}"]
13-
== Downloading and installing the virtctl client
14-
15-
include::modules/virt-downloading-virtctl-client.adoc[leveloffset=+2]
16-
17-
include::modules/virt-installing-virtctl-client.adoc[leveloffset=+2]
11+
include::modules/virt-installing-virtctl-client.adoc[leveloffset=+1]
1812

1913
[id="installing-virtctl-rpm_{context}"]
20-
== Installing the virtctl RPM package
14+
== Installing the virtctl as an RPM
2115

22-
You can install the `virtctl` client as an RPM after enabling the {VirtProductName} repository.
16+
You can install the `virtctl` client on {op-system-base-full} as an RPM after enabling the {VirtProductName} repository.
2317

2418
include::modules/virt-enabling-virt-repos.adoc[leveloffset=+2]
2519

‎virt/virt-getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Plan and install {VirtProductName} on an {product-title} cluster:
2121
* xref:../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Plan your bare metal cluster for {VirtProductName}].
2222
* xref:../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Prepare your cluster for {VirtProductName}].
2323
* xref:../virt/install/installing-virt-web.adoc#virt-installing-virt-operator_installing-virt-web[Install the {VirtProductName} Operator].
24-
* xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Install the `virtctl` command line interface (CLI) tool].
24+
* xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Install the `virtctl` command line interface (CLI) tool].
2525

2626
[discrete]
2727
[id="additional-resources-planning-and-installing"]

‎virt/virt-using-the-cli-tools.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The two primary CLI tools used for managing resources in the cluster are:
1414
1515
== Prerequisites
1616

17-
* You must xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[enable the `virtctl` client].
17+
* You must xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[install the `virtctl` client].
1818

1919
include::modules/virt-openshift-client-commands.adoc[leveloffset=+1]
2020

‎virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ to upload the local disk image into the data volume.
1515

1616
== Prerequisites
1717

18-
* xref:../../../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Enable]
19-
the `kubevirt-virtctl` package.
18+
* xref:../../../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Install `virtctl`].
2019
* If you require scratch space according to the
2120
xref:#virt-cdi-supported-operations-matrix_virt-uploading-local-disk-images-block[CDI supported operations matrix], you must first
2221
xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass_virt-preparing-cdi-scratch-space[define a storage class or prepare CDI scratch space]

‎virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ You can upload a locally stored disk image to a new or existing data volume by u
1111

1212
== Prerequisites
1313

14-
* xref:../../../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Enable]
15-
the `kubevirt-virtctl` package.
14+
* xref:../../../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Install `virtctl`].
1615

1716
* If you require scratch space according to the
1817
xref:#virt-cdi-supported-operations-matrix_virt-cloning-vm-disk-into-new-datavolume-block[CDI supported operations matrix], you must first

0 commit comments

Comments
 (0)