{"id":13509876,"url":"https://github.com/kata-containers/runtime","last_synced_at":"2025-10-02T06:32:31.592Z","repository":{"id":41883798,"uuid":"110539997","full_name":"kata-containers/runtime","owner":"kata-containers","description":"Kata Containers version 1.x runtime (for version 2.x see https://github.com/kata-containers/kata-containers).","archived":true,"fork":false,"pushed_at":"2021-05-07T14:48:39.000Z","size":19147,"stargazers_count":2096,"open_issues_count":0,"forks_count":369,"subscribers_count":112,"default_branch":"master","last_synced_at":"2025-08-14T00:10:32.820Z","etag":null,"topics":["container","containers","cri-o","docker","k8s","kubernetes","kvm","oci","qemu","security","virtual-machine","virtualization"],"latest_commit_sha":null,"homepage":"https://katacontainers.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/kata-containers.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":"CODEOWNERS","security":null,"support":null}},"created_at":"2017-11-13T11:29:03.000Z","updated_at":"2025-08-05T10:00:16.000Z","dependencies_parsed_at":"2022-07-10T19:01:24.412Z","dependency_job_id":null,"html_url":"https://github.com/kata-containers/runtime","commit_stats":null,"previous_names":[],"tags_count":93,"template":false,"template_full_name":null,"purl":"pkg:github/kata-containers/runtime","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-containers%2Fruntime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-containers%2Fruntime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-containers%2Fruntime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-containers%2Fruntime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kata-containers","download_url":"https://codeload.github.com/kata-containers/runtime/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-containers%2Fruntime/sbom","scorecard":{"id":551396,"data":{"date":"2025-08-11","repo":{"name":"github.com/kata-containers/runtime","commit":"04f29832a923857db2f47a534ddbae886c0b541c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.5,"checks":[{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/PR-wip-checks.yaml:1","Warn: no topLevel permission defined: .github/workflows/add-issues-to-project.yaml:1","Warn: no topLevel permission defined: .github/workflows/dco-check.yaml:1","Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/move-issues-to-in-progress.yaml:1","Warn: no topLevel permission defined: .github/workflows/require-pr-porting-labels.yaml:1","Warn: no topLevel permission defined: .github/workflows/snap-release.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 1.13.0-alpha0 not signed: https://api.github.com/repos/kata-containers/runtime/releases/36417852","Warn: release artifact 1.12.1 not signed: https://api.github.com/repos/kata-containers/runtime/releases/36417692","Warn: release artifact 1.12.0 not signed: https://api.github.com/repos/kata-containers/runtime/releases/33840098","Warn: release artifact 1.11.5 not signed: https://api.github.com/repos/kata-containers/runtime/releases/33840207","Warn: release artifact 1.12.0-rc0 not signed: https://api.github.com/repos/kata-containers/runtime/releases/32925960","Warn: release artifact 1.13.0-alpha0 does not have provenance: https://api.github.com/repos/kata-containers/runtime/releases/36417852","Warn: release artifact 1.12.1 does not have provenance: https://api.github.com/repos/kata-containers/runtime/releases/36417692","Warn: release artifact 1.12.0 does not have provenance: https://api.github.com/repos/kata-containers/runtime/releases/33840098","Warn: release artifact 1.11.5 does not have provenance: https://api.github.com/repos/kata-containers/runtime/releases/33840207","Warn: release artifact 1.12.0-rc0 does not have provenance: https://api.github.com/repos/kata-containers/runtime/releases/32925960"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: virtcontainers/pkg/firecracker/swagger_linux_amd64:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add-issues-to-project.yaml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/add-issues-to-project.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/move-issues-to-in-progress.yaml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/move-issues-to-in-progress.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/require-pr-porting-labels.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/require-pr-porting-labels.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snap-release.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/snap-release.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/snap-release.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kata-containers/runtime/snap-release.yaml/master?enable=pin","Warn: containerImage not pinned by hash: .ci/openshift-ci/images/Dockerfile:8: pin your Docker image by updating centos:7 to centos:7@sha256:be65f488b7764ad3638f236b7b515b3678369a5124c47b8d32916d6487418ea4","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   3 out of   4 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   2 out of   2 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2025-3488 / GHSA-6v2p-p543-phr9"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T10:58:48.755Z","repository_id":41883798,"created_at":"2025-08-20T10:58:48.755Z","updated_at":"2025-08-20T10:58:48.755Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277968828,"owners_count":25907418,"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","status":"online","status_checked_at":"2025-10-02T02:00:08.890Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","k8s","kubernetes","kvm","oci","qemu","security","virtual-machine","virtualization"],"created_at":"2024-08-01T02:01:15.699Z","updated_at":"2025-10-02T06:32:28.899Z","avatar_url":"https://github.com/kata-containers.png","language":"Go","funding_links":[],"categories":["Misc","Go","OCI runtimes:","Uncategorized","security"],"sub_categories":["Uncategorized"],"readme":"[![Build Status](https://travis-ci.org/kata-containers/runtime.svg?branch=master)](https://travis-ci.org/kata-containers/runtime)\n[![Build Status](http://jenkins.katacontainers.io/job/kata-containers-runtime-ubuntu-18-04-master/badge/icon)](http://jenkins.katacontainers.io/job/kata-containers-runtime-ubuntu-18-04-master/)\n[![Go Report Card](https://goreportcard.com/badge/github.com/kata-containers/runtime)](https://goreportcard.com/report/github.com/kata-containers/runtime)\n[![GoDoc](https://godoc.org/github.com/kata-containers/runtime?status.svg)](https://godoc.org/github.com/kata-containers/runtime)\n\n# Runtime\n\nThis repository contains the runtime for the\n[Kata Containers](https://github.com/kata-containers) project.\n\nFor details of the other Kata Containers repositories, see the\n[repository summary](https://github.com/kata-containers/kata-containers).\n\n* [Introduction](#introduction)\n* [License](#license)\n* [Platform support](#platform-support)\n    * [Hardware requirements](#hardware-requirements)\n* [Download and install](#download-and-install)\n* [Quick start for developers](#quick-start-for-developers)\n* [Architecture overview](#architecture-overview)\n* [Configuration](#configuration)\n* [Logging](#logging)\n    * [Kata OCI](#kata-oci)\n    * [Kata containerd shimv2](#kata-containerd-shimv2)\n* [Debugging](#debugging)\n* [Limitations](#limitations)\n* [Community](#community)\n    * [Contact](#contact)\n* [Further information](#further-information)\n* [Additional packages](#additional-packages)\n\n## Introduction\n\n`kata-runtime`, referred to as \"the runtime\", is the Command-Line Interface\n(CLI) part of the Kata Containers runtime component. It leverages the\n[virtcontainers](virtcontainers)\npackage to provide a high-performance standards-compliant runtime that creates\nhardware-virtualized [Linux](https://www.kernel.org/) containers running on Linux hosts.\n\nThe runtime is\n[OCI](https://github.com/opencontainers/runtime-spec)-compatible,\n[CRI-O](https://github.com/cri-o/cri-o)-compatible, and\n[Containerd](https://github.com/containerd/containerd)-compatible,\n allowing it\nto 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## Platform support\n\nKata Containers currently works on systems supporting the following\ntechnologies:\n\n- [Intel](https://www.intel.com) VT-x technology.\n- [ARM](https://www.arm.com) Hyp mode (virtualization extension).\n- [IBM](https://www.ibm.com) Power Systems.\n- [IBM](https://www.ibm.com) Z mainframes.\n### Hardware requirements\n\nThe runtime has a built-in command to determine if your host system is capable\nof running and creating a Kata Container:\n\n```bash\n$ kata-runtime kata-check\n```\n\n\u003e **Note:**\n\u003e\n\u003e - By default, only a brief success / failure message is printed.\n\u003e If more details are needed, the `--verbose` flag can be used to display the\n\u003e list of all the checks performed.\n\u003e\n\u003e - `root` permission is needed to check if the system is capable of running\n\u003e Kata containers. In this case, additional checks are performed (e.g., if another\n\u003e incompatible hypervisor is running).\n\n## Download and install\n\n[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/kata-containers)\n\nSee the [installation guides](https://github.com/kata-containers/documentation/tree/master/install/README.md)\navailable for various operating systems.\n\n## Quick start for developers\n\nSee the\n[developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md).\n\n## Architecture overview\n\nSee the [architecture overview](https://github.com/kata-containers/documentation/blob/master/design/architecture.md)\nfor details on the Kata Containers design.\n\n## Configuration\n\nThe runtime uses a TOML format configuration file called `configuration.toml`.\nThe file contains comments explaining all options.\n\n\u003e **Note:**\n\u003e\n\u003e The initial values in the configuration file provide a good default configuration.\n\u003e You may need to modify this file to optimise or tailor your system, or if you have\n\u003e specific requirements.\n\nSince the runtime supports a\n[stateless system](https://clearlinux.org/about),\nit checks for this configuration file in multiple locations, two of which are\nbuilt in to the runtime. The default location is\n`/usr/share/defaults/kata-containers/configuration.toml` for a standard\nsystem. However, if `/etc/kata-containers/configuration.toml` exists, this\ntakes priority.\n\nThe below command lists the full paths to the configuration files that the\nruntime attempts to load. The first path that exists will be used:\n\n```bash\n$ kata-runtime --kata-show-default-config-paths\n```\n\nAside from the built-in locations, it is possible to specify the path to a\ncustom configuration file using the `--kata-config` option:\n\n```bash\n$ kata-runtime --kata-config=/some/where/configuration.toml ...\n```\n\nThe runtime will log the full path to the configuration file it is using. See\nthe [logging](#logging) section for further details.\n\nTo see details of your systems runtime environment (including the location of\nthe configuration file being used), run:\n\n```bash\n$ kata-runtime kata-env\n```\n\n## Logging\n\nFor detailed information and analysis on obtaining logs for other system\ncomponents, see the documentation for the\n[`kata-log-parser`](https://github.com/kata-containers/tests/tree/master/cmd/log-parser)\ntool.\n\nFor runtime logs, see the following sections for the CRI-O and containerd shimv2 based runtimes.\n\n### Kata OCI\n\nThe Kata OCI runtime (including when used with CRI-O), provides `--log=` and `--log-format=` options.\nHowever, the runtime also always logs to the system log (`syslog` or `journald`).\n\nTo view runtime log output:\n\n```bash\n$ sudo journalctl -t kata-runtime\n```\n\n### Kata containerd shimv2\n\nThe Kata containerd shimv2 runtime logs through `containerd`, and its logs will be sent\nto wherever the `containerd` logs are directed. However, the\nshimv2 runtime also always logs to the system log (`syslog` or `journald`) under the\nidentifier name of `kata`.\n\nTo view the `shimv2` runtime log output:\n\n```bash\n$ sudo journalctl -t kata\n```\n\n## Debugging\n\nSee the\n[debugging section of the developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#troubleshoot-kata-containers).\n\n## Limitations\n\nSee the\n[limitations file](https://github.com/kata-containers/documentation/blob/master/Limitations.md)\nfor further details.\n\n## Community\n\nSee [the community repository](https://github.com/kata-containers/community).\n\n### Contact\n\nSee [how to reach the community](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md#contact).\n\n## Further information\n\nSee the\n[project table of contents](https://github.com/kata-containers/kata-containers)\nand the\n[documentation repository](https://github.com/kata-containers/documentation).\n\n## Additional packages\n\nFor details of the other packages contained in this repository, see the\n[package documentation](pkg).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkata-containers%2Fruntime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkata-containers%2Fruntime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkata-containers%2Fruntime/lists"}