https://github.com/crc-org/crc
CRC is a tool to help you run containers. It manages local VMs to run a OpenShift 4.x cluster, Microshift or Podman optimized for testing and development purposes
https://github.com/crc-org/crc
cluster development-tools openshift openshift-cluster openshift-deployment podman single-node-cluster testing-and-development virtualization
Last synced: 24 days ago
JSON representation
CRC is a tool to help you run containers. It manages local VMs to run a OpenShift 4.x cluster, Microshift or Podman optimized for testing and development purposes
- Host: GitHub
- URL: https://github.com/crc-org/crc
- Owner: crc-org
- License: apache-2.0
- Created: 2019-01-11T06:44:53.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T10:26:10.000Z (about 1 month ago)
- Last Synced: 2025-05-08T11:36:23.927Z (about 1 month ago)
- Topics: cluster, development-tools, openshift, openshift-cluster, openshift-deployment, podman, single-node-cluster, testing-and-development, virtualization
- Language: Go
- Homepage: https://crc.dev
- Size: 59.5 MB
- Stars: 1,316
- Watchers: 37
- Forks: 255
- Open Issues: 328
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
CRC - Runs Containers
=====================
- [Introduction](https://github.com/crc-org/crc#intro-to-crc)
- [Usage data](https://github.com/crc-org/crc#usage-data)
- [Documentation](https://github.com/crc-org/crc#documentation)
- [Community](https://github.com/crc-org/crc#community)
[](https://github.com/crc-org/crc/actions/workflows/make-check.yml) [](https://github.com/crc-org/crc/actions/workflows/macos-installer.yml) [](https://github.com/crc-org/crc/actions/workflows/make-rpm.yml) [](https://github.com/crc-org/crc/actions/workflows/make-check-win.yml)
## Introduction
`crc` is a tool to run containers. It manages a local [OpenShift 4.x](https://github.com/openshift/origin) cluster, or an [OKD](https://github.com/openshift/okd) cluster VM optimized for testing and development purposes.
If you are looking for a solution for running OpenShift 3.x, you will need tools such as `oc cluster up`, [Minishift](http://github.com/minishift/minishift) or [CDK](https://developers.redhat.com/products/cdk/overview/).
## 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](https://developers.redhat.com/article/tool-data-collection) to learn more about it. For the specific data points being collected, see [Usage data](https://github.com/crc-org/crc/blob/main/usage-data.adoc#data-table).
### Manually configuring usage data collection
You can manually change your preference about usage data collection by running `crc config set consent-telemetry ` before the next `crc start`.
## Documentation
### Getting CRC
CRC binaries with an embedded OpenShift disk image can be downloaded from [this page](https://console.redhat.com/openshift/create/local).
### Using CRC
The documentation for CRC is currently hosted by GitHub Pages.
See the [Getting Started Guide](https://crc.dev/docs).
### Developing CRC
Developers who want to work on CRC should visit the [Developing CRC](https://github.com/crc-org/engineering-docs/blob/main/content/Developing.md) document.
## Community
Contributions, questions, and comments are all welcomed and encouraged!
You can reach the community by:
- Joining the #codeready channel on [Freenode IRC](https://freenode.net/)
If you want to contribute, make sure to follow the [contribution guidelines](https://github.com/crc-org/crc/blob/main/CONTRIBUTING.md) when you open issues or submit pull requests.