Skip to content

Commit 838675a

Browse files
sabrinajesssabrinajess
committed
Doc redesign and update for virtctl
1 parent c8c7ff9 commit 838675a

12 files changed

+125
-84
lines changed

‎_topic_map.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2793,8 +2793,8 @@ Topics:
27932793
File: installing-virt-web
27942794
- Name: Installing OpenShift Virtualization using the CLI
27952795
File: installing-virt-cli
2796-
- Name: Installing the virtctl client
2797-
File: virt-installing-virtctl
2796+
- Name: Enabling the virtctl client
2797+
File: virt-enabling-virtctl
27982798
- Name: Uninstalling OpenShift Virtualization using the web console
27992799
File: uninstalling-virt-web
28002800
- Name: Uninstalling OpenShift Virtualization using the CLI

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// virt/install/virt-enabling-virtctl.adoc
4+
5+
[id="virt-downloading-virtctl-client_{context}"]
6+
= Downloading the virtctl client
7+
8+
Download the `virtctl` client by using the link provided in the `ConsoleCLIDownload` custom resource (CR).
9+
10+
.Procedure
11+
12+
. View the `ConsoleCLIDownload` object by running the following command:
13+
+
14+
[source,terminal]
15+
----
16+
$ oc get ConsoleCLIDownload virtctl-clidownloads-kubevirt-hyperconverged -o yaml
17+
----
18+
19+
. Download the `virtctl` client by using the link listed for your distribution.

‎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-installing-virtctl.adoc
3+
// virt/install/virt-enabling-virtctl.adoc
44

55
[id="virt-enabling-virt-repos_{context}"]
66
= Enabling {VirtProductName} repositories

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

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

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// virt/install/virt-enabling-virtctl.adoc
4+
5+
[id="virt-installing-virtctl-client-yum_{context}"]
6+
= Installing the virtctl client using the yum utility
7+
8+
Install the `virtctl` client from the `kubevirt-virtctl` package.
9+
10+
.Procedure
11+
12+
* Install the `kubevirt-virtctl` package:
13+
+
14+
[source,terminal]
15+
----
16+
# yum install kubevirt-virtctl
17+
----

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

Lines changed: 54 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,67 @@
11
// Module included in the following assemblies:
22
//
3-
// virt/install/virt-installing-virtctl.adoc
3+
// virt/install/virt-enabling-virtctl.adoc
44

55
[id="virt-installing-virtctl-client_{context}"]
66
= Installing the virtctl client
77

8-
Install the `virtctl` client from the `kubevirt-virtctl` package.
8+
Extract and install the `virtctl` client after downloading from the appropriate location for your operating system.
9+
10+
.Prerequisites
11+
12+
* You must have downloaded the `virtctl` client.
913

1014
.Procedure
1115

12-
* Install the `kubevirt-virtctl` package:
16+
* For Linux:
17+
18+
. Extract the tarball. The following CLI command extracts it into the same directory as the tarball:
19+
+
20+
[source,terminal]
21+
----
22+
$ tar -xvf <virtctl-version-distribution.arch>.tar.gz
23+
----
24+
25+
. Navigate the extracted folder hierachy and run the following command to make the `virtctl` binary executable:
26+
+
27+
[source,terminal]
28+
----
29+
$ chmod +x <virtctl-file-name>
30+
----
31+
32+
. Move the `virtctl` binary to a directory in your `PATH` environment variable.
33+
34+
. To check your path, run the following command:
35+
+
36+
[source,terminal]
37+
----
38+
$ echo $PATH
39+
----
40+
41+
* For Windows users:
42+
43+
. Unpack and unzip the archive.
44+
45+
. Navigate the extracted folder hierarchy and double-click the `virtctl` executable file to install the client.
46+
47+
. Move the `virtctl` binary to a directory in your `PATH` environment variable.
48+
49+
. To check your path, run the following command:
50+
+
51+
[source,terminal]
52+
----
53+
C:\> path
54+
----
55+
56+
* For macOS users:
57+
58+
. Unpack and unzip the archive.
59+
60+
. Move the `virtctl` binary to a directory in your `PATH` environment variable.
61+
62+
. To check your path, run the following command:
1363
+
1464
[source,terminal]
1565
----
16-
# yum install kubevirt-virtctl
66+
echo $PATH
1767
----

‎virt/install/virt-enabling-virtctl.adoc‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[id="virt-enabling-virtctl"]
2+
= Enabling the virtctl client
3+
include::modules/virt-document-attributes.adoc[]
4+
:context: virt-enabling-virtctl
5+
6+
toc::[]
7+
8+
The `virtctl` client is a command-line utility for managing {VirtProductName}
9+
resources. It is available for Linux, macOS, and Windows distributions.
10+
11+
[id="virtctl-download-install_{context}"]
12+
== Downloading and installing the virtctl client
13+
14+
include::modules/virt-downloading-virtctl-client.adoc[leveloffset=+2]
15+
16+
include::modules/virt-installing-virtctl-client.adoc[leveloffset=+2]
17+
18+
[id="virtctl-additional-setup_{context}"]
19+
== Additional setup options
20+
21+
include::modules/virt-installing-virtctl-client-yum.adoc[leveloffset=+2]
22+
23+
include::modules/virt-enabling-virt-repos.adoc[leveloffset=+2]
24+
25+
[id="virt-enabling-virtctl-addtl-resources"]
26+
== Additional resources
27+
xref:../../virt/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[Using the CLI tools] for {VirtProductName}.

‎virt/install/virt-installing-virtctl.adoc‎

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

‎virt/virt-learn-more-about-openshift-virtualization.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Use the following tables to find content to help you learn about and use {VirtPr
4646

4747
| xref:../virt/about-virt.adoc#about-virt[Learn about {VirtProductName}]
4848
| Connecting virtual machines to the xref:../virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc#virt-using-the-default-pod-network-with-virt[default pod network for virtual machines] and xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#attaching-to-multiple-networks[multiple networks]
49-
| xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Installing the `virtctl` client]
49+
| xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Enabling the `virtctl` client]
5050
| xref:../migration_toolkit_for_containers/about-mtc.adoc#about-mtc[Importing virtual machines with the Migration Toolkit for containers]
5151

5252
| xref:../virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc#virt-features-for-storage[Learn about storage features for virtual machine disks]
@@ -75,7 +75,7 @@ Use the following tables to find content to help you learn about and use {VirtPr
7575
|Learn |Use |Manage |Additional resources
7676

7777
| xref:../virt/about-virt.adoc#about-virt[Learn about {VirtProductName}]
78-
| xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Installing the `virtctl` client]
78+
| xref:../virt/install/virt-enabling-virtctl.adoc#virt-enabling-virtctl[Enabling the `virtctl` client]
7979
| Viewing xref:../virt/logging_events_monitoring/virt-logs.adoc#virt-logs[logs] and xref:../virt/logging_events_monitoring/virt-events.adoc#virt-events[events]
8080
| xref:../virt/logging_events_monitoring/virt-collecting-virt-data.adoc#virt-collecting-virt-data[Getting Support]
8181

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The two primary CLI tools used for managing resources in the cluster are:
1212

1313
== Prerequisites
1414

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

1717
include::modules/virt-virtctl-commands.adoc[leveloffset=+1]
1818
include::modules/virt-openshift-client-commands.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)