OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

Installing the virtctl client

The virtctl client is a command-line utility for managing OpenShift Virtualization resources. It is available for Linux, Windows, and macOS.

Installing the virtctl client on Linux, Windows, and macOS

Download and install the virtctl client for your operating system.

Procedure

  1. Navigate to Virtualization > Overview in the OpenShift Container Platform web console.

  2. Click the Download virtctl link on the upper right corner of the page and download the virtctl client for your operating system.

  3. Install virtctl:

    • For Linux:

      1. Decompress the archive file:

        $ tar -xvf <virtctl-version-distribution.arch>.tar.gz

      2. Run the following command to make the virtctl binary executable:

        $ chmod +x <path/virtctl-file-name>

      3. Move the virtctl binary to a directory in your PATH environment variable.

        You can check your path by running the following command:

        $ echo $PATH

      4. Set the KUBECONFIG environment variable:

        $ export KUBECONFIG=/home/<user>/clusters/current/auth/kubeconfig

    • For Windows:

      1. Decompress the archive file.

      2. Navigate the extracted folder hierarchy and double-click the virtctl executable file to install the client.

      3. Move the virtctl binary to a directory in your PATH environment variable.

        You can check your path by running the following command:

        C:\> path

    • For macOS:

      1. Decompress the archive file.

      2. Move the virtctl binary to a directory in your PATH environment variable.

        You can check your path by running the following command:

        echo $PATH

Installing the virtctl as an RPM

You can install the virtctl client on Red Hat Enterprise Linux (RHEL) as an RPM after enabling the OpenShift Virtualization repository.

Enabling OpenShift Virtualization repositories

Enable the OpenShift Virtualization repository for your version of Red Hat Enterprise Linux (RHEL).

Prerequisites

  • Your system is registered to a Red Hat account with an active subscription to the "Red Hat Container Native Virtualization" entitlement.

Procedure

  • Enable the appropriate OpenShift Virtualization repository for your operating system by using the subscription-manager CLI tool.

    • To enable the repository for RHEL 8, run:

      # subscription-manager repos --enable cnv-4.12-for-rhel-8-x86_64-rpms

    • To enable the repository for RHEL 7, run:

      # subscription-manager repos --enable rhel-7-server-cnv-4.12-rpms

Installing the virtctl client using the yum utility

Install the virtctl client from the kubevirt-virtctl package.

Prerequisites

  • You enabled an OpenShift Virtualization repository on your Red Hat Enterprise Linux (RHEL) system.

Procedure

  • Install the kubevirt-virtctl package:

    # yum install kubevirt-virtctl

Additional resources