{"id":13446631,"url":"https://github.com/cri-o/cri-o","last_synced_at":"2026-05-05T02:05:35.941Z","repository":{"id":37246606,"uuid":"67828134","full_name":"cri-o/cri-o","owner":"cri-o","description":"Open Container Initiative-based implementation of Kubernetes Container Runtime Interface","archived":false,"fork":false,"pushed_at":"2025-05-14T00:12:38.000Z","size":179549,"stargazers_count":5406,"open_issues_count":102,"forks_count":1077,"subscribers_count":120,"default_branch":"main","last_synced_at":"2025-05-14T08:04:33.753Z","etag":null,"topics":["container-runtime-interface","crun","hacktoberfest","k8s-sig-node","kata-containers","kubernetes","oci","oci-runtime","runc"],"latest_commit_sha":null,"homepage":"https://cri-o.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cri-o.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":"GOVERNANCE.md","roadmap":"roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-09-09T19:56:31.000Z","updated_at":"2025-05-13T21:56:09.000Z","dependencies_parsed_at":"2023-07-13T09:51:37.738Z","dependency_job_id":"a32e1d01-012a-4026-8b71-5b68aaa4670c","html_url":"https://github.com/cri-o/cri-o","commit_stats":{"total_commits":5873,"total_committers":330,"mean_commits":"17.796969696969697","dds":0.824110335433339,"last_synced_commit":"fb80d4c09d47e73632e8c3a4f135e6fccd8f7199"},"previous_names":["kubernetes-incubator/ocid","kubernetes-sigs/cri-o","kubernetes-incubator/cri-o"],"tags_count":253,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cri-o%2Fcri-o","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cri-o%2Fcri-o/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cri-o%2Fcri-o/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cri-o%2Fcri-o/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cri-o","download_url":"https://codeload.github.com/cri-o/cri-o/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254101588,"owners_count":22014907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container-runtime-interface","crun","hacktoberfest","k8s-sig-node","kata-containers","kubernetes","oci","oci-runtime","runc"],"created_at":"2024-07-31T05:00:55.350Z","updated_at":"2025-11-12T21:41:34.703Z","avatar_url":"https://github.com/cri-o.png","language":"Go","funding_links":[],"categories":["Container Operations","Go","CRI implementations:","Engine \u0026 Runtime","kubernetes","Runtimes \u0026 Platforms"],"sub_categories":["Runtime"],"readme":"\u003c!-- markdownlint-disable-next-line MD041 --\u003e\n\n![CRI-O logo](https://github.com/cri-o/cri-o/blob/main/logo/crio-logo.svg?raw=true)\n\n# CRI-O - OCI-based implementation of Kubernetes Container Runtime Interface\n\n\u003c!-- markdownlint-disable-next-line MD042 --\u003e\n\n[![Stable Status](https://img.shields.io/badge/status-stable-brightgreen.svg)](#)\n[![codecov](https://codecov.io/gh/cri-o/cri-o/branch/main/graph/badge.svg)](https://codecov.io/gh/cri-o/cri-o)\n[![Packages](https://img.shields.io/badge/deb%2frpm-packages-blue.svg)](https://github.com/cri-o/packaging)\n[![Release Notes](https://img.shields.io/badge/release-notes-blue.svg)](https://cri-o.github.io/cri-o)\n[![Dependencies](https://img.shields.io/badge/report-dependencies-blue.svg)](https://cri-o.github.io/cri-o/dependencies)\n[![GoDoc](https://godoc.org/github.com/cri-o/cri-o?status.svg)](https://godoc.org/github.com/cri-o/cri-o)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/cri-o/cri-o/badge)](https://scorecard.dev/viewer/?uri=github.com/cri-o/cri-o)\n[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/2298/badge)](https://bestpractices.coreinfrastructure.org/projects/2298)\n[![Go Report Card](https://goreportcard.com/badge/github.com/cri-o/cri-o)](https://goreportcard.com/report/github.com/cri-o/cri-o)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcri-o%2Fcri-o.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcri-o%2Fcri-o?ref=badge_shield)\n[![Mentioned in Awesome CRI-O](https://awesome.re/mentioned-badge.svg)](awesome.md)\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/cri-o/cri-o)\n\n\u003c!-- toc --\u003e\n\n- [Compatibility matrix: CRI-O ⬄ Kubernetes](#compatibility-matrix-cri-o--kubernetes)\n- [What is the scope of this project?](#what-is-the-scope-of-this-project)\n- [What is not in the scope of this project?](#what-is-not-in-the-scope-of-this-project)\n- [Roadmap](#roadmap)\n- [CI images and jobs](#ci-images-and-jobs)\n- [Commands](#commands)\n- [Configuration](#configuration)\n- [Security](#security)\n- [OCI Hooks Support](#oci-hooks-support)\n- [CRI-O Usage Transfer](#cri-o-usage-transfer)\n- [Communication](#communication)\n- [Awesome CRI-O](#awesome-cri-o)\n- [Getting started](#getting-started)\n  - [Installing CRI-O](#installing-cri-o)\n  - [Running Kubernetes with CRI-O](#running-kubernetes-with-cri-o)\n    - [The HTTP status API](#the-http-status-api)\n    - [Metrics](#metrics)\n    - [Tracing](#tracing)\n    - [Container Runtime Interface special cases](#container-runtime-interface-special-cases)\n    - [Debugging tips](#debugging-tips)\n- [Adopters](#adopters)\n- [Weekly Meeting](#weekly-meeting)\n- [Governance](#governance)\n- [License Scan](#license-scan)\n\u003c!-- /toc --\u003e\n\n## Compatibility matrix: CRI-O ⬄ Kubernetes\n\nCRI-O follows the Kubernetes release cycles with respect to its minor versions\n(`1.x.y`). Patch releases (`1.x.z`) for Kubernetes are not in sync with those from\nCRI-O, because they are scheduled for each month, whereas CRI-O provides\nthem only if necessary. If a Kubernetes release goes [End of\nLife](https://kubernetes.io/releases/patch-releases/),\nthen the corresponding CRI-O version can be considered in the same way.\n\nThis means that CRI-O also follows the Kubernetes `n-2` release version skew\npolicy when it comes to feature graduation, deprecation or removal. This also\napplies to features which are independent from Kubernetes. Nevertheless, feature\nbackports to supported release branches, which are independent from Kubernetes\nor other tools like cri-tools, are still possible. This allows CRI-O to decouple\nfrom the Kubernetes release cycle and have enough flexibility when it comes to\nimplement new features. Every feature to be backported will be a case by case\ndecision of the community while the overall compatibility matrix should not be\ncompromised.\n\nFor more information visit the [Kubernetes Version Skew\nPolicy](https://kubernetes.io/releases/version-skew-policy/).\n\n\u003c!-- markdownlint-disable MD013 --\u003e\n\n| CRI-O                           | Kubernetes                      | Maintenance status                                                    |\n| ------------------------------- | ------------------------------- | --------------------------------------------------------------------- |\n| `main` branch                   | `master` branch                 | Features from the main Kubernetes repository are actively implemented |\n| `release-1.x` branch (`v1.x.y`) | `release-1.x` branch (`v1.x.z`) | Maintenance is manual, only bugfixes will be backported.              |\n\n\u003c!-- markdownlint-enable MD013 --\u003e\n\nThe release notes for CRI-O are hand-crafted and can be continuously retrieved\nfrom [our GitHub pages website](https://cri-o.github.io/cri-o).\n\n## What is the scope of this project?\n\nCRI-O is meant to provide an integration path between OCI conformant runtimes and\nthe Kubelet.\nSpecifically, it implements the Kubelet [Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/container-runtime-interface.md)\nusing OCI conformant runtimes.\nThe scope of CRI-O is tied to the scope of the CRI.\n\nAt a high level, we expect the scope of CRI-O to be restricted to the following functionalities:\n\n- Support multiple image formats including the existing Docker image format\n- Support for multiple means to download images including trust \u0026 image verification\n- Container image management (managing image layers, overlay filesystems, etc)\n- Container process lifecycle management\n- Monitoring and logging required to satisfy the CRI\n- Resource isolation as required by the CRI\n\n## What is not in the scope of this project?\n\n- Building, signing and pushing images to various image storages\n- A CLI utility for interacting with CRI-O. Any CLIs built as part of this project\n  are only meant for testing this project and there will be no guarantees on the\n  backward compatibility with it.\n\nCRI-O is an implementation of the Kubernetes Container Runtime Interface (CRI)\nthat will allow Kubernetes to directly launch and manage\nOpen Container Initiative (OCI) containers.\n\nThe plan is to use OCI projects and best of breed libraries for different aspects:\n\n- Runtime: [runc](https://github.com/opencontainers/runc)\n  (or any OCI runtime-spec implementation) and [oci runtime tools](https://github.com/opencontainers/runtime-tools)\n- Images: Image management using [containers/image](https://github.com/containers/image)\n- Storage: Storage and management of image layers using [containers/storage](https://github.com/containers/storage)\n- Networking: Networking support through the use of [CNI](https://github.com/containernetworking/cni)\n\nIt is currently in active development in the Kubernetes community through the\n[design proposal](https://github.com/kubernetes/kubernetes/pull/26788).\nQuestions and issues should be raised in the Kubernetes [sig-node Slack channel](https://kubernetes.slack.com/archives/sig-node).\n\n## Roadmap\n\nA roadmap that describes the direction of CRI-O can be found [here](/roadmap.md).\nThe project is tracking all ongoing efforts as part of the [Feature Roadmap\nGitHub project](https://github.com/orgs/cri-o/projects/1).\n\n## CI images and jobs\n\nCRI-O's CI is split-up between GitHub actions and [OpenShift CI (Prow)](https://prow.ci.openshift.org).\nRelevant virtual machine images used for the prow jobs are built periodically in\nthe jobs:\n\n- [periodic-ci-cri-o-cri-o-main-periodics-setup-periodic](https://prow.ci.openshift.org/?job=periodic-ci-cri-o-cri-o-main-periodics-setup-periodic)\n- [periodic-ci-cri-o-cri-o-main-periodics-setup-fedora-periodic](https://prow.ci.openshift.org/?job=periodic-ci-cri-o-cri-o-main-periodics-setup-fedora-periodic)\n- [periodic-ci-cri-o-cri-o-main-periodics-evented-pleg-periodic](https://prow.ci.openshift.org/?job=periodic-ci-cri-o-cri-o-main-periodics-evented-pleg-periodic)\n\nThe jobs are maintained [from the openshift/release repository](https://github.com/openshift/release/blob/ecdeb0a/ci-operator/jobs/cri-o/cri-o/cri-o-cri-o-main-periodics.yaml)\nand define workflows used for the particular jobs. The actual job definitions\ncan be found in the same repository under [ci-operator/jobs/cri-o/cri-o/cri-o-cri-o-main-presubmits.yaml](https://github.com/openshift/release/blob/ecdeb0a/ci-operator/jobs/cri-o/cri-o/cri-o-cri-o-main-presubmits.yaml)\nfor the `main` branch as well as the corresponding files for the release\nbranches. The base image configuration for those jobs is available in the same\nrepository under [ci-operator/config/cri-o/cri-o](https://github.com/openshift/release/tree/ecdeb0a/ci-operator/config/cri-o/cri-o).\n\n## Commands\n\n| Command                    | Description                             |\n| -------------------------- | --------------------------------------- |\n| [crio(8)](/docs/crio.8.md) | OCI Kubernetes Container Runtime daemon |\n\nExamples of commandline tools to interact with CRI-O\n(or other CRI compatible runtimes) are [Crictl](https://github.com/kubernetes-sigs/cri-tools/releases)\nand [Podman](https://github.com/containers/podman).\n\n## Configuration\n\n\u003c!-- markdownlint-disable MD013 --\u003e\n\n| File                                                                                                     | Description                           |\n| -------------------------------------------------------------------------------------------------------- | ------------------------------------- |\n| [crio.conf(5)](/docs/crio.conf.5.md)                                                                     | CRI-O Configuration file              |\n| [policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md)         | Signature Verification Policy File(s) |\n| [registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md) | Registries Configuration file         |\n| [storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)     | Storage Configuration file            |\n\n\u003c!-- markdownlint-enable MD013 --\u003e\n\n## Security\n\nThe security process for reporting vulnerabilities is described in [SECURITY.md](./SECURITY.md).\n\n## OCI Hooks Support\n\n[You can configure CRI-O][podman-hooks] to inject\n[OCI Hooks][spec-hooks] when creating containers.\n\n## CRI-O Usage Transfer\n\nWe provide [useful information for operations and development transfer](transfer.md)\nas it relates to infrastructure that utilizes CRI-O.\n\n## Communication\n\nFor async communication and long running discussions please use [issues](https://github.com/cri-o/cri-o/issues)\nand [pull requests](https://github.com/cri-o/cri-o/pulls) on the [GitHub repo](https://github.com/cri-o/cri-o).\nThis will be the best place to discuss design and implementation.\n\nFor chat communication, we have a [channel on the Kubernetes slack](https://kubernetes.slack.com/archives/crio)\nthat everyone is welcome to join and chat about development.\n\n## Awesome CRI-O\n\nWe maintain a curated [list of links related to CRI-O](awesome.md). Did you find\nsomething interesting on the web about the project? Awesome, feel free to open\nup a PR and add it to the list.\n\n## Getting started\n\n### Installing CRI-O\n\nTo install `CRI-O`, you can follow our [installation guide](install.md).\nAlternatively, if you'd rather build `CRI-O` from source, checkout our [setup\nguide](install.md#build-and-install-cri-o-from-source).\n\n### Running Kubernetes with CRI-O\n\nBefore you begin, you'll need to [start CRI-O](install.md#starting-cri-o)\n\nYou can run a local version of Kubernetes with `CRI-O` using `local-up-cluster.sh`:\n\n1. Clone the [Kubernetes repository](https://github.com/kubernetes/kubernetes)\n1. From the Kubernetes project directory, run:\n\n```console\nCGROUP_DRIVER=systemd \\\nCONTAINER_RUNTIME=remote \\\nCONTAINER_RUNTIME_ENDPOINT='unix:///var/run/crio/crio.sock' \\\n./hack/local-up-cluster.sh\n```\n\nFor more guidance in running `CRI-O`, visit our [tutorial page](tutorial.md)\n\n[podman-hooks]: https://github.com/containers/podman/blob/v3.0.1/pkg/hooks/README.md\n[spec-hooks]: https://github.com/opencontainers/runtime-spec/blob/v1.0.1/config.md#posix-platform-hooks\n\n#### The HTTP status API\n\nCRI-O exposes per default the [gRPC](https://grpc.io/) API to fulfill the\nContainer Runtime Interface (CRI) of Kubernetes. Besides this, there exists an\nadditional HTTP API to retrieve further runtime status information about CRI-O.\nPlease be aware that this API is not considered to be stable and production\nuse-cases should not rely on it.\n\nOn a running CRI-O instance, we can access the API via an HTTP transfer tool like\n[curl](https://curl.haxx.se):\n\n```console\n$ sudo curl -v --unix-socket /var/run/crio/crio.sock http://localhost/info | jq\n{\n  \"storage_driver\": \"btrfs\",\n  \"storage_root\": \"/var/lib/containers/storage\",\n  \"cgroup_driver\": \"systemd\",\n  \"default_id_mappings\": { ... }\n}\n```\n\nThe following API entry points are currently supported:\n\n\u003c!-- markdownlint-disable MD013 --\u003e\n\n| Path                | Content-Type       | Description                                                                        |\n| ------------------- | ------------------ | ---------------------------------------------------------------------------------- |\n| `/info`             | `application/json` | General information about the runtime, like `storage_driver` and `storage_root`.   |\n| `/containers/:id`   | `application/json` | Dedicated container information, like `name`, `pid` and `image`.                   |\n| `/config`           | `application/toml` | The complete TOML configuration (defaults to `/etc/crio/crio.conf`) used by CRI-O. |\n| `/pause/:id`        | `application/json` | Pause a running container.                                                         |\n| `/unpause/:id`      | `application/json` | Unpause a paused container.                                                        |\n| `/debug/goroutines` | `text/plain`       | Print the goroutine stacks.                                                        |\n| `/debug/heap`       | `text/plain`       | Write the heap dump.                                                               |\n\n\u003c!-- markdownlint-enable MD013 --\u003e\n\nThe subcommand `crio status` can be used to access the API with a dedicated command\nline tool. It supports all API endpoints via the dedicated subcommands `config`,\n`info` and `containers`, for example:\n\n```console\n$ sudo crio status info\ncgroup driver: systemd\nstorage driver: btrfs\nstorage root: /var/lib/containers/storage\ndefault GID mappings (format \u003ccontainer\u003e:\u003chost\u003e:\u003csize\u003e):\n  0:0:4294967295\ndefault UID mappings (format \u003ccontainer\u003e:\u003chost\u003e:\u003csize\u003e):\n  0:0:4294967295\n```\n\n#### Metrics\n\nPlease refer to the [CRI-O Metrics guide](tutorials/metrics.md).\n\n#### Tracing\n\nPlease refer to the [CRI-O Tracing guide](tutorials/tracing.md).\n\n#### Container Runtime Interface special cases\n\nSome aspects of the Container Runtime are worth some additional explanation.\nThese details are summarized in a [dedicated guide](cri.md).\n\n#### Debugging tips\n\nHaving an issue? There are some tips and tricks for debugging located in\n[our debugging guide](tutorials/debugging.md)\n\n## Adopters\n\nAn incomplete list of adopters of CRI-O in production environments can be found [here](ADOPTERS.md).\nIf you're a user, please help us complete it by submitting a pull-request!\n\n## Weekly Meeting\n\nA weekly meeting is held to discuss CRI-O development. It is open to everyone.\nThe details to join the meeting are on the [wiki](https://github.com/cri-o/cri-o/wiki/CRI-O-Weekly-Meeting).\n\n## Governance\n\nFor more information on how CRI-O is goverened, take a look at the [governance file](GOVERNANCE.md)\n\n## License Scan\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcri-o%2Fcri-o.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcri-o%2Fcri-o?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcri-o%2Fcri-o","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcri-o%2Fcri-o","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcri-o%2Fcri-o/lists"}