Chapter 2. Installation
2.1. Minimum system requirements
CodeReady Containers has the following minimum hardware and operating system requirements.
2.1.1. Hardware requirements
CodeReady Containers is supported only on AMD64 and Intel 64 processor architectures. CodeReady Containers does not support the ARM-based M1 architecture. CodeReady Containers does not support nested virtualization.
Depending on the desired container runtime, CodeReady Containers 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
The OpenShift Container Platform cluster requires these minimum resources to run in the CodeReady Containers instance. Some workloads may require more resources. To assign more resources to the CodeReady Containers 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
CodeReady Containers requires the following minimum version of a supported operating system:
2.1.2.1. Microsoft Windows
- On Microsoft Windows, CodeReady Containers requires the Windows 10 Fall Creators Update (version 1709) or later. CodeReady Containers does not work on earlier versions of Microsoft Windows. Microsoft Windows 10 Home Edition is not supported.
2.1.2.2. macOS
- On macOS, CodeReady Containers requires macOS 10.14 Mojave or later. CodeReady Containers does not work on earlier versions of macOS.
2.1.2.3. Linux
- On Linux, CodeReady Containers 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 CodeReady Containers 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
CodeReady Containers 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 CodeReady Containers
CodeReady Containers is available as a portable executable for Red Hat Enterprise Linux. On Microsoft Windows and macOS, CodeReady Containers 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 CodeReady Containers 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 CodeReady Containers to your local C:\ drive. You cannot run CodeReady Containers 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
CodeReady Containers 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 CodeReady Containers
Newer versions of the CodeReady Containers executable require manual set up to prevent potential incompatibilities with earlier versions.
Procedure
- Download the latest release of CodeReady Containers.
Delete the existing CodeReady Containers instance:
$ crc delete
WarningThe
crc deletecommand results in the loss of data stored in the CodeReady Containers 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 CodeReady Containers release:
$ crc setup
Start the new CodeReady Containers instance:
$ crc start
