Chapter 3. Using CodeReady Containers
3.1. Setting up CodeReady Containers
The crc setup command performs operations to set up the environment of your host machine for the CodeReady Containers virtual machine.
This procedure will create the ~/.crc directory if it does not already exist.
Prerequisites
-
Your user account must have permission to use the
sudocommand.
-
The
crcbinary should not be run asroot(or Administrator). Thecrcbinary should always be run with your user account. - If you are setting up a new version, capture any changes made to the instance before setting up a new CodeReady Containers release.
Procedure
Set up your host machine for CodeReady Containers:
$ crc setup
3.2. Starting the virtual machine
The crc start command starts the CodeReady Containers virtual machine and OpenShift cluster.
Prerequisites
-
The host machine has been set up using the
crc setupcommand. For more information, see Section 3.1, “Setting up CodeReady Containers”. A valid OpenShift user pull secret. The pull secret can be copied or downloaded from the Pull Secret section of the Install on Laptop: Red Hat CodeReady Containers page on cloud.redhat.com.
NoteA Red Hat account is required in order to access the user pull secret.
Procedure
Start the CodeReady Containers virtual machine:
For native hypervisors:
$ crc start
- When prompted, supply your user pull secret.
- The cluster takes a minimum of four minutes to start the necessary containers and operators before serving a request.
-
If errors are encountered during
crc start, check the Chapter 6, Troubleshooting Red Hat CodeReady Containers section for potential solutions.
3.3. Accessing the OpenShift cluster
The OpenShift cluster running in the CodeReady Containers virtual machine can be accessed via the OpenShift web console or the OpenShift client binary (oc).
3.3.1. Accessing the OpenShift web console
Prerequisites
- A running CodeReady Containers virtual machine. For more information, see Section 3.2, “Starting the virtual machine”.
Procedure
To access the OpenShift web console, follow these steps:
-
Run
crc console. This will open your web browser and direct it to the web console. Log in to the OpenShift web console as the
developeruser with the password printed in the output of thecrc startcommand.Note-
You can also view the password for the
developeruser by runningcrc console --credentials. -
The cluster can initially be accessed through either the
kubeadminordeveloperuser. For creating projects or OpenShift applications, and for application deployment, thedeveloperuser should be used. Thekubeadminuser should only be used for administrative tasks such as creating new users, setting roles, and so on.
-
You can also view the password for the
See Chapter 6, Troubleshooting Red Hat CodeReady Containers if you cannot access the CodeReady Containers OpenShift cluster.
Additional resources
- The OpenShift documentation covers the creation of projects and applications.
3.3.2. Accessing the OpenShift cluster with oc
Prerequisites
- A running CodeReady Containers virtual machine. For more information, see Section 3.2, “Starting the virtual machine”.
Procedure
To access the OpenShift cluster via the oc command, follow these steps:
Run the
crc oc-envcommand to print the command needed to add the cachedocbinary to yourPATH:$ crc oc-env
- Run the printed command.
Log in as the
developeruser:$ oc login -u developer https://api.crc.testing:6443
NoteThe password for the
developeruser was printed in the output of thecrc startcommand. You can also view it by running thecrc console --credentialscommand.You can now use
octo interact with your OpenShift cluster. For example, to verify that the OpenShift cluster operators are available:$ oc get co
Note-
The
machine-configcluster operator is expected to reportFalseavailability. -
The
monitoringcluster operator is expected to reportUnknownavailability.
-
The
See Chapter 6, Troubleshooting Red Hat CodeReady Containers if you cannot access the CodeReady Containers OpenShift cluster.
Additional resources
- The OpenShift documentation covers the creation of projects and applications.
-
OpenShift Do (
odo) can also be used to create OpenShift projects and applications from the command line.
3.4. Stopping the virtual machine
The crc stop command stops the running CodeReady Containers virtual machine and OpenShift cluster. The stopping process will take a few minutes while the cluster shuts down.
Procedure
Stop the CodeReady Containers virtual machine and OpenShift cluster:
$ crc stop
3.5. Deleting the virtual machine
The crc delete command deletes an existing CodeReady Containers virtual machine.
Procedure
Delete the CodeReady Containers virtual machine:
$ crc delete
WarningThe
crc deletecommand will result in the loss of data stored in the CodeReady Containers virtual machine. Save any desired instance information before running this command.
