Chapter 2. Installing Red Hat OpenShift Local
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 on these architectures:
| Preset | AMD64 | Intel 64 | Apple silicon |
|---|---|---|---|
| OpenShift Container Platform | yes | yes | yes |
| MicroShift | yes | yes | yes |
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
- 10.5 GB of free memory
- 35 GB of storage space
2.1.1.2. For MicroShift
- 2 physical CPU cores
- 4 GB of free memory
- 35 GB of storage space
The OpenShift Container Platform and MicroShift presets require these minimum resources to run in the Red Hat OpenShift Local instance. Some workloads might require more resources. To assign more resources to the Red Hat OpenShift Local instance, see Configuring the instance.
2.1.2. Operating system requirements
Red Hat OpenShift Local requires the following minimum version of a supported operating system:
2.1.2.1. Requirements on Microsoft Windows
- On Microsoft Windows, Red Hat OpenShift Local requires fully updated Microsoft Windows 10 or Microsoft Windows 11. Red Hat OpenShift Local does not work on earlier versions of Microsoft Windows.
- Red Hat OpenShift Local does not work on Microsoft Windows Home Edition.
2.1.2.2. Requirements on macOS
- On macOS, Red Hat OpenShift Local requires macOS 13 Ventura or later. Red Hat OpenShift Local does not work on earlier versions of macOS.
2.1.2.3. Requirements on Linux
- On Linux, Red Hat OpenShift Local is supported only on the latest two Red Hat Enterprise Linux/CentOS 8 and 9 minor releases 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 might 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:
| Linux Distribution | Installation command |
|---|---|
| Fedora/Red Hat Enterprise Linux/CentOS |
|
| Debian/Ubuntu |
|
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
- Your host machine must meet the minimum system requirements. For more information, see Minimum system requirements.
Procedure
- Download the latest release of Red Hat OpenShift Local for your platform.
- On Microsoft Windows, extract the contents of the archive.
On macOS or Microsoft Windows, run the guided installer and follow the instructions.
NoteOn 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:
Extract the contents of the archive:
$ cd ~/Downloads $ tar xvf crc-linux-amd64.tar.xz
Create the ~/bin directory if it does not exist and copy the
crcexecutable to it:$ mkdir -p ~/bin $ cp ~/Downloads/crc-linux-*-amd64/crc ~/bin
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
- For more information about collected data, see the Red Hat Telemetry data collection notice.
- To grant or revoke consent for usage data collection, see Configuring usage data collection.
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.
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
- For more information about the collected data, see the Red Hat Telemetry data collection notice.
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
- Download the latest release of Red Hat OpenShift Local.
Delete the existing Red Hat OpenShift Local instance:
$ crc delete
WarningThe
crc deletecommand 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.Replace the earlier
crcexecutable with the executable of the latest release. Verify that the newcrcexecutable is in use by checking its version:$ crc version
Set up the new Red Hat OpenShift Local release:
$ crc setup
Start the new Red Hat OpenShift Local instance:
$ crc start
