Awesome Open Source
Awesome Open Source

CRC - OpenShift 4 on your Laptop

Introduction

This project is focused on bringing a minimal OpenShift 4.x cluster to your local laptop or desktop computer.

If you are looking for a solution for running OpenShift 3.x, you will need tools such as oc cluster up, Minishift or CDK.

Usage data

The first time CRC is run, you will be asked to opt-in to Red Hat’s telemetry collection program.

With your approval, CRC collects pseudonymized usage data and sends it to Red Hat servers to help improve our products and services. Read our privacy statement to learn more about it. For the specific data points being collected, see Usage data.

Manually configuring usage data collection

You can manually change your preference about usage data collection by running crc config set consent-telemetry <yes/no> before the next crc start.

Documentation

Getting CRC

CRC binaries with an embedded OpenShift disk image can be downloaded from this page.

Using CRC

The documentation for CRC is currently hosted by GitHub Pages.

Building the documentation

You can find the source files for the documentation in the docs/source directory.

To build the formatted documentation, install podman then use the following:

$ git clone https://github.com/code-ready/crc
$ cd crc
$ make build_docs

This will create a docs/build/master.html file which you can view in your browser.

Developing CRC

Developers who want to work on CRC should visit the Developing CRC document.

Community

Contributions, questions, and comments are all welcomed and encouraged!

You can reach the community by:

If you want to contribute, make sure to follow the contribution guidelines when you open issues or submit pull requests.

Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Go (160,616
Documentation (22,013
Red (6,039
Development Tools (5,841
Podman (194
Openshift Cluster (22
Openshift Deployment (21
Single Node Cluster (4