{"id":13509504,"url":"https://github.com/clearcontainers/runtime","last_synced_at":"2025-03-30T13:32:22.932Z","repository":{"id":84947751,"uuid":"79110123","full_name":"clearcontainers/runtime","owner":"clearcontainers","description":"OCI (Open Containers Initiative) compatible runtime using Virtual Machines","archived":true,"fork":false,"pushed_at":"2019-04-16T14:28:49.000Z","size":14223,"stargazers_count":589,"open_issues_count":156,"forks_count":70,"subscribers_count":43,"default_branch":"master","last_synced_at":"2024-12-01T17:47:41.634Z","etag":null,"topics":["container","containers","cri-o","docker","kvm","oci","qemu-kvm","security","virtual-machine","virtualization"],"latest_commit_sha":null,"homepage":"","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/clearcontainers.png","metadata":{"files":{"readme":"README-original.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-01-16T11:00:58.000Z","updated_at":"2024-10-15T09:35:45.000Z","dependencies_parsed_at":"2023-03-13T03:36:01.737Z","dependency_job_id":null,"html_url":"https://github.com/clearcontainers/runtime","commit_stats":{"total_commits":682,"total_committers":23,"mean_commits":"29.652173913043477","dds":0.5557184750733137,"last_synced_commit":"675654a0ae6ba56e2660aaf7dfddf687440c16d7"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearcontainers%2Fruntime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearcontainers%2Fruntime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearcontainers%2Fruntime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearcontainers%2Fruntime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clearcontainers","download_url":"https://codeload.github.com/clearcontainers/runtime/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246324069,"owners_count":20759072,"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","containers","cri-o","docker","kvm","oci","qemu-kvm","security","virtual-machine","virtualization"],"created_at":"2024-08-01T02:01:08.717Z","updated_at":"2025-03-30T13:32:21.299Z","avatar_url":"https://github.com/clearcontainers.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"[![Build Status](http://cc-jenkins-ci.westus2.cloudapp.azure.com/job/clear-containers-runtime-azure-ubuntu-16-04-master/badge/icon)](http://cc-jenkins-ci.westus2.cloudapp.azure.com/job/clear-containers-runtime-azure-ubuntu-16-04-master/)\n[![Build Status](http://cc-jenkins-ci.westus2.cloudapp.azure.com/job/clear-containers-runtime-azure-ubuntu-17-04-master/badge/icon)](http://cc-jenkins-ci.westus2.cloudapp.azure.com/job/clear-containers-runtime-azure-ubuntu-17-04-master/)\n[![Build Status](http://cc-jenkins-ci.westus2.cloudapp.azure.com/job/clear-containers-runtime-fedora-26-master/badge/icon)](http://cc-jenkins-ci.westus2.cloudapp.azure.com/job/clear-containers-runtime-fedora-26-master/)\n[![Go Report Card](https://goreportcard.com/badge/github.com/clearcontainers/runtime)](https://goreportcard.com/report/github.com/clearcontainers/runtime)\n[![Coverage Status](https://coveralls.io/repos/github/clearcontainers/runtime/badge.svg?branch=master)](https://coveralls.io/github/clearcontainers/runtime?branch=master)\n\n# runtime\n\n* [Introduction](#introduction)\n* [License](#license)\n* [Hardware requirements](#hardware-requirements)\n* [Quick start for users](#quick-start-for-users)\n* [Quick start for developers](#quick-start-for-developers)\n* [Community](#community)\n* [Configuration](#configuration)\n* [Logging](#logging)\n* [Debugging](#debugging)\n* [Limitations](#limitations)\n* [Home Page](#home-page)\n\n## Introduction\n\n`cc-runtime` is the next generation of Intel® Clear Containers runtime.\n\nThis tool, henceforth referred to simply as \"the runtime\", builds upon\nthe [virtcontainers](https://github.com/containers/virtcontainers)\nproject to provide a high-performance standards-compliant runtime that\ncreates hardware-virtualized containers which leverage\n[Intel](https://www.intel.com/)'s VT-x technology.\n\nIt is a re-implementation of [`cc-oci-runtime`](https://github.com/01org/cc-oci-runtime) written in the go language and supersedes `cc-oci-runtime` starting from 3.0.0.\n\nThe runtime is both [OCI](https://github.com/opencontainers/runtime-spec)-compatible and [CRI-O](https://github.com/kubernetes-incubator/cri-o)-compatible, allowing it to work seamlessly with both Docker and Kubernetes respectively.\n\n## License\n\nThe code is licensed under an Apache 2.0 license.\n\nSee [the license file](LICENSE) for further details.\n\n## Hardware requirements\n\nThe runtime has a built-in command to determine if your host system is capable of running an Intel® Clear Container. Simply run:\n\n```bash\n$ cc-runtime cc-check\n```\n\nNote:\n\nIf you run the command above as the `root` user, further checks will be\nperformed (e.g. check if another incompatible hypervisor is running):\n\n```bash\n$ sudo cc-runtime cc-check\n```\n\n## Quick start for users\n\nSee the [installation guides](docs/) available for various operating systems.\n\n## Quick start for developers\n\nSee the [developer's installation guide](docs/developers-clear-containers-install.md).\n\n## Community\n\nSee [the contributing document](CONTRIBUTING.md).\n\n## Configuration\n\nThe runtime uses a single configuration file called `configuration.toml`.\nSince the runtime supports a [stateless system](https://clearlinux.org/features/stateless),\nit checks for this configuration file in multiple locations. The default\nlocation is `/usr/share/defaults/clear-containers/configuration.toml` for a\nstandard system. However, if `/etc/clear-containers/configuration.toml`\nexists, this will take priority.\n\nTo see which paths the runtime will check for a configuration source, run:\n\n```bash\n$ cc-runtime --cc-show-default-config-paths\n```\n\nTo see details of your systems runtime environment (including the location of the configuration file being used), run:\n\n```bash\n$ cc-runtime cc-env\n```\n\n## Logging\n\nThe runtime provides `--log=` and `--log-format=` options. However, you can\nalso configure it to log to the system log (syslog or `journald`) such that\nall log data is sent to both the specified logfile and the system log. The\nlatter is useful as it is independent of the lifecycle of each container.\n\nTo view runtime log output:\n\n```bash\n$ sudo journalctl -t cc-runtime\n```\n\nTo view shim log output:\n\n```bash\n$ sudo journalctl -t cc-shim\n```\n\nTo view proxy log output:\n\n```bash\n$ sudo journalctl -t cc-proxy\n```\n\nNote:\n\nThe proxy log entries also include output from the agent (`cc-agent`) and the\nhypervisor, which includes the guest kernel boot-time messages.\n\n## Debugging\n\nThe runtime, the shim (`cc-shim`), the proxy (`cc-proxy`),\nand the hypervisor all have separate `enable_debug=` debug\noptions in the [configuration file](#Configuration). All of these debug\noptions are disabled by default. See the comments in the installed\nconfiguration file for further details.\n\nIf you want to enable debug for all host-side components, assuming a standard configuration file path, run:\n\n```bash\n$ sudo sed -i -e 's/^#\\(enable_debug\\).*=.*$/\\1 = true/g' /usr/share/defaults/clear-containers/configuration.toml\n```\n\nThe agent (`cc-agent`) that runs inside each virtual machine is slightly different. To enable its debug, set a\nspecial guest kernel command-line parameter (`agent.log`) to `debug`. This agent looks for this special option when it starts:\n\n```bash\n$ sudo sed -i -e 's/^kernel_params = \"\"/kernel_params = \"agent.log=debug\"/g' /usr/share/defaults/clear-containers/configuration.toml\n```\n\nNote:\n\nThe previous command will only set the option if you have a default configuration\nfile. If you have modified the original value of `kernel_params` you will need\nto add the `agent.log` value yourself.\n\nSee the [agent debug document](docs/debug-agent.md) and the [kernel debug document](docs/debug-kernel.md) for further details.\n\n## Limitations\n\nSee [the limitations file](docs/limitations.md) for further details.\n\n## Home Page\n\nThe canonical home page for the project is: https://github.com/clearcontainers\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearcontainers%2Fruntime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclearcontainers%2Fruntime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearcontainers%2Fruntime/lists"}