Chapter 2. Installation

2.1. Minimum system requirements

Red Hat OpenShift Local has the following minimum hardware and operating system requirements.

2.1.1. Hardware requirements

Red Hat OpenShift Local is supported only on AMD64 and Intel 64 processor architectures. Red Hat OpenShift Local does not support the ARM-based M1 architecture. Red Hat OpenShift Local does not support nested virtualization.

Depending on the desired container runtime, Red Hat OpenShift Local requires the following system resources:

2.1.1.1. For OpenShift Container Platform

  • 4 physical CPU cores
  • 9 GB of free memory
  • 35 GB of storage space
Note

The OpenShift Container Platform cluster requires these minimum resources to run in the Red Hat OpenShift Local instance. Some workloads may require more resources. To assign more resources to the Red Hat OpenShift Local instance, see Configuring the instance.

2.1.1.2. For the Podman container runtime

  • 2 physical CPU cores
  • 2 GB of free memory
  • 35 GB of storage space

2.1.2. Operating system requirements

Red Hat OpenShift Local requires the following minimum version of a supported operating system:

2.1.2.1. Microsoft Windows

  • On Microsoft Windows, Red Hat OpenShift Local requires the Windows 10 Fall Creators Update (version 1709) or later. Red Hat OpenShift Local does not work on earlier versions of Microsoft Windows. Microsoft Windows 10 Home Edition is not supported.

2.1.2.2. macOS

  • On macOS, Red Hat OpenShift Local requires macOS 11 Big Sur or later. Red Hat OpenShift Local does not work on earlier versions of macOS.

2.1.2.3. Linux

  • On Linux, Red Hat OpenShift Local is supported only on Red Hat Enterprise Linux/CentOS 7.5 or later (including 8.x versions) and on the latest two stable Fedora releases.
  • When using Red Hat Enterprise Linux, the machine running Red Hat OpenShift Local must be registered with the Red Hat Customer Portal.
  • Ubuntu 18.04 LTS or later and Debian 10 or later are not supported and may require manual set up of the host machine.
  • See Required software packages to install the required packages for your Linux distribution.

2.2. Required software packages for Linux

Red Hat OpenShift Local requires the libvirt and NetworkManager packages to run on Linux. Consult the following table to find the command used to install these packages for your Linux distribution:

Table 2.1. Package installation commands by distribution

Linux DistributionInstallation command

Fedora

sudo dnf install NetworkManager

Red Hat Enterprise Linux/CentOS

su -c 'yum install NetworkManager'

Debian/Ubuntu

sudo apt install qemu-kvm libvirt-daemon libvirt-daemon-system network-manager

2.3. Installing Red Hat OpenShift Local

Red Hat OpenShift Local is available as a portable executable for Red Hat Enterprise Linux. On Microsoft Windows and macOS, Red Hat OpenShift Local is available using a guided installer.

Prerequisites

Procedure

  1. Download the latest release of Red Hat OpenShift Local for your platform.
  2. On Microsoft Windows, extract the contents of the archive.

  3. On macOS or Microsoft Windows, run the guided installer and follow the instructions.

    Note

    On Microsoft Windows, you must install Red Hat OpenShift Local to your local C:\ drive. You cannot run Red Hat OpenShift Local from a network drive.

    On Red Hat Enterprise Linux, assuming the archive is in the ~/Downloads directory, follow these steps:

    1. Extract the contents of the archive: 

      $ cd ~/Downloads
$ tar xvf crc-linux-amd64.tar.xz

    2. Create the ~/bin directory if it does not exist and copy the crc executable to it: 

      $ mkdir -p ~/bin
$ cp ~/Downloads/crc-linux-*-amd64/crc ~/bin

    3. Add the ~/bin directory to your $PATH: 

      $ export PATH=$PATH:$HOME/bin
$ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc

2.4. About usage data collection

Red Hat OpenShift Local prompts you before use for optional, anonymous usage data collection to assist with development. No personally identifiable information is collected. Consent for usage data collection can be granted or revoked by you at any time.

Additional resources

2.5. Configuring usage data collection

Consent for usage data collection can be granted or revoked by you at any time using the following configuration commands.

Note

Changes to telemetry consent do not modify a running instance. The change will take effect next time you run the crc start command.

Procedure

  • To manually enable telemetry, run the following command: 

    $ crc config set consent-telemetry yes

  • To manually disable telemetry, run the following command: 

    $ crc config set consent-telemetry no

Additional resources

2.6. Upgrading Red Hat OpenShift Local

Newer versions of the Red Hat OpenShift Local executable require manual set up to prevent potential incompatibilities with earlier versions.

Procedure

  1. Download the latest release of Red Hat OpenShift Local.

  2. Delete the existing Red Hat OpenShift Local instance: 

    $ crc delete
    Warning

    The crc delete command results in the loss of data stored in the Red Hat OpenShift Local instance. Save any desired information stored in the instance before running this command.

  3. Replace the earlier crc executable with the executable of the latest release. Verify that the new crc executable is in use by checking its version: 

    $ crc version

  4. Set up the new Red Hat OpenShift Local release: 

    $ crc setup

  5. Start the new Red Hat OpenShift Local instance: 

    $ crc start