CodeReadyContainers

This repo can be used to setup a local code ready containers (CRC) installation (openshift 4 equivalent) on Ubuntu/Debian (only tested on Ubuntu 22.04).

Requirements

To install CRC with this repo, you need:

• A free redhat account
• Download the mandatory pullsecrets file and save it as "pull-secret.json"
• 4 cpu cores (default 8)
• 9GB of memory (default 14GB)
• 35GB of free storage space
• One of the following operating systems:
  • Ubuntu 18.04 LTS or later
  • Debian 10 or later

The cluster monitoring is disabled by default, because it increases cpu and memory consumption by ~50% (when the system is under load). To enable it, provide the -e crc_cluster_monitoring=true arg when calling the playbook. CPU/memory settings can be overwritten too by providing -e crc_cluster_cpus=<cpu_count> or -e crc_cluster_memory=<memory_in_gib>.

Install

When you've created a redhat account and downloaded the pullsecret file, run:

• python3 -m pip install --user -r requirements.txt
• ansible-playbook install.yaml

NOTE: If passwordless sudo is disabled, force ansible to ask for your sudo password by appending -K or --ask-become-pass to the ansible-playbook install.yaml command.

Known Issues

If the installation fails, it can get stuck and prevent new installations to run succesfully. If you have trouble running the playbook consecutively after an installation failed, or if the crc VM doesn't come up, see crc-org/crc#1027 for more information on how to resolve this.

# TL;DR
crc delete --force
sudo virsh list --all
sudo virsh destroy crc
sudo virsh undefine crc

Deinstall

To deinstall CRC, run ansible-playbook deinstall.yaml. If passwordless sudo is disabled, run ansible-playbook deinstall.yaml -K instead.

Update

If you want to update an existing CRC installation to a new release, set the new version in the vars.yaml file and run ansible-playbook update.yaml. You can find the available versions at https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/crc/.

WARNING: By the time of writing, there is no way to update an existing CRC installation in place, so we have to deinstall/install the current CRC installation. This will delete the CRC instance including all data and deployments in it.

Work with CRC

The CRC installation will be up and running after the installation, but is not added to your systems autostart. You can use the following commands to start/stop/interact with it.

Command	Description
crc status	Display the status of the current CRC installation
crc start	Start a stopped CRC installation
crc stop	Stop a started CRC installation
crc console	Open thh webconsole in browser