{"id":18060075,"url":"https://github.com/youki-dev/youki","last_synced_at":"2025-12-12T02:35:43.285Z","repository":{"id":36954170,"uuid":"352051262","full_name":"youki-dev/youki","owner":"youki-dev","description":"A container runtime written in Rust","archived":false,"fork":false,"pushed_at":"2025-11-27T00:18:18.000Z","size":24842,"stargazers_count":7083,"open_issues_count":122,"forks_count":391,"subscribers_count":56,"default_branch":"main","last_synced_at":"2025-11-27T12:34:34.354Z","etag":null,"topics":["containers","docker","kubernetes","oci","rust"],"latest_commit_sha":null,"homepage":"https://youki-dev.github.io/youki/","language":"Rust","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/youki-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-03-27T11:06:58.000Z","updated_at":"2025-11-27T07:59:57.000Z","dependencies_parsed_at":"2023-09-25T03:57:10.605Z","dependency_job_id":"f2200d56-a669-491b-a905-024359908216","html_url":"https://github.com/youki-dev/youki","commit_stats":{"total_commits":3205,"total_committers":119,"mean_commits":"26.932773109243698","dds":"0.49485179407176283","last_synced_commit":"8e855e00973f70fd1e8c94e66905bf144894a45e"},"previous_names":["youki-dev/youki"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/youki-dev/youki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youki-dev%2Fyouki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youki-dev%2Fyouki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youki-dev%2Fyouki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youki-dev%2Fyouki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/youki-dev","download_url":"https://codeload.github.com/youki-dev/youki/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youki-dev%2Fyouki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27532620,"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-12-05T02:00:07.920Z","response_time":54,"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":["containers","docker","kubernetes","oci","rust"],"created_at":"2024-10-31T04:01:25.830Z","updated_at":"2025-12-12T02:35:43.278Z","avatar_url":"https://github.com/youki-dev.png","language":"Rust","funding_links":[],"categories":["Rust","Applications","Recently Updated","rust","docker","Engine \u0026 Runtime"],"sub_categories":["Virtualization","[Oct 31, 2024](/content/2024/10/31/README.md)"],"readme":"# youki: A container runtime in Rust\n\n[![Discord](https://img.shields.io/discord/849943000770412575.svg?logo=discord)](https://discord.gg/zHnyXKSQFD)\n[![GitHub contributors](https://img.shields.io/github/contributors/youki-dev/youki)](https://github.com/youki-dev/youki/graphs/contributors)\n[![Github CI](https://github.com/youki-dev/youki/actions/workflows/basic.yml/badge.svg?branch=main)](https://github.com/youki-dev/youki/actions)\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fyouki-dev%2Fyouki.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fyouki-dev%2Fyouki?ref=badge_shield)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/youki.png\" width=\"450\"\u003e\n\u003c/p\u003e\n\n**youki** is an implementation of the [OCI runtime-spec](https://github.com/opencontainers/runtime-spec) in Rust, similar to [runc](https://github.com/opencontainers/runc).  \nYour ideas are welcome [here](https://github.com/youki-dev/youki/issues/10).\n\n# 🏷️ About the name\n\nyouki is pronounced as /joʊki/ or yoh-key.\nyouki is named after the Japanese word 'youki', which means 'a container'. In Japanese language, youki also means 'cheerful', 'merry', or 'hilarious'.\n\n# 🚀 Quick Start\n\n\u003e [!TIP]\n\u003e You can immediately set up your environment with youki on GitHub Codespaces and try it out.  \n\u003e\n\u003e [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/youki-dev/youki?quickstart=1)\n\u003e ```console\n\u003e just build\n\u003e docker run --runtime youki hello-world\n\u003e sudo podman run --cgroup-manager=cgroupfs --runtime /workspaces/youki/youki hello-world\n\u003e ```\n\n[User Documentation](https://youki-dev.github.io/youki/user/basic_setup.html#quick-install)\n\n# 🎯 Motivation\n\nHere is why we are writing a new container runtime in Rust.\n\n- Rust is one of the best languages to implement the oci-runtime spec. Many very nice container tools are currently written in Go. However, the container runtime requires the use of system calls, which requires a bit of special handling when implemented in Go. This is tricky (e.g. _namespaces(7)_, _fork(2)_); with Rust too, but it's not that tricky. And, unlike in C, Rust provides the benefit of memory safety. While Rust is not yet a major player in the container field, it has the potential to contribute a lot: something this project attempts to exemplify.\n- youki has the potential to be faster and use less memory than runc, and therefore work in environments with tight memory usage requirements. Here is a simple benchmark of a container from creation to deletion.\n  |  Runtime | Time (mean ± σ) | \tRange (min … max) | vs youki(mean) | Version | \n  | -------- | -------- | -------- | -------- | -------- |\n  | youki     | 111.5 ms ± 11.6 ms  | 84.0 ms ± 142.5 ms   | 100% | 0.3.3 |\n  | runc     | 224.6 ms ± 12.0 ms  | 190.5 ms ± 255.4 ms   | 200% | 1.1.7 |\n  | crun     | 47.3 ms ± 2.8 ms  | 42.4 ms ± 56.2 ms   | 42% | 1.15 |\n    \u003cdetails\u003e\n  \u003csummary\u003eDetails about the benchmark\u003c/summary\u003e\n\n  - A command used for the benchmark\n\n    ```bash\n    hyperfine --prepare 'sudo sync; echo 3 | sudo tee /proc/sys/vm/drop_caches' --warmup 10 --min-runs 100 'sudo ./youki create -b tutorial a \u0026\u0026 sudo ./youki start a \u0026\u0026 sudo ./youki delete -f a'\n    ```\n\n  - Environment\n\n    ```console\n    $ ./youki info\n    Version           0.3.3\n    Commit            4f3c8307\n    Kernel-Release    6.5.0-35-generic\n    Kernel-Version    #35~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Tue May  7 09:00:52 UTC 2\n    Architecture      x86_64\n    Operating System  Ubuntu 22.04.4 LTS\n    Cores             16\n    Total Memory      63870\n    Cgroup setup      unified\n    Cgroup mounts\n    Namespaces        enabled\n      mount           enabled\n      uts             enabled\n      ipc             enabled\n      user            enabled\n      pid             enabled\n      network         enabled\n      cgroup          enabled\n    Capabilities\n    CAP_BPF           available\n    CAP_PERFMON       available\n    CAP_CHECKPOINT_RESTORE available\n    ```\n\n  \u003c/details\u003e\n\n- I have fun implementing this. In fact, this may be the most important.\n\n# 📍 Status of youki\n\n**youki** has aced real-world use cases, including containerd's e2e test, and is now adopted by several production environments.\nWe have [our roadmap](https://github.com/orgs/containers/projects/15).\n\n![youki demo](docs/demo.gif)\n\n# 🔗 Related project\n\n- [youki-dev/oci-spec-rs](https://github.com/youki-dev/oci-spec-rs) - OCI Runtime and Image Spec in Rust\n\n# 🎨 Design and implementation of youki\n\nThe User and Developer Documentation for youki is hosted at [https://youki-dev.github.io/youki/](https://youki-dev.github.io/youki/)\n\n![Architecture](docs/.drawio.svg)\n\n# 🎬 Getting Started\n\nLocal build is only supported on Linux.\nFor other platforms, please use the [Vagrantfile](#setting-up-vagrant) that we have prepared. You can also spin up a fully preconfigured development environment in the cloud with [GitHub Codespaces](https://docs.github.com/en/codespaces/getting-started/quickstart).\n\n## Requires\n\n- Rust(See [here](https://www.rust-lang.org/tools/install)), edition 2024\n- linux kernel ≥ 5.3\n\n## Dependencies\n\nTo install `just`, follow the instruction [here](https://github.com/casey/just#installation).\n\n### Debian, Ubuntu and related distributions\n\n```console\nsudo apt-get install    \\\n      pkg-config        \\\n      libsystemd-dev    \\\n      build-essential   \\\n      libelf-dev        \\\n      libseccomp-dev    \\\n      libclang-dev      \\\n      libssl-dev\n```\n\n### Fedora, CentOS, RHEL and related distributions\n\n```console\nsudo dnf install            \\\n      pkg-config            \\\n      systemd-devel         \\\n      elfutils-libelf-devel \\\n      libseccomp-devel      \\\n      clang-devel           \\\n      openssl-devel\n```\n\n## Build\n\n```bash\ngit clone git@github.com:youki-dev/youki.git\ncd youki\njust youki-dev # or youki-release\n./youki -h # you can get information about youki command\n```\n\n## Tutorial\n\n### Requires\n\n- Docker(See [here](https://docs.docker.com/engine/install))\n\n### Create and run a container\n\nLet's try to run a container that executes `sleep 30` with youki. This tutorial may need root permission.\n\n```bash\ngit clone git@github.com:youki-dev/youki.git\ncd youki\njust youki-dev # or youki-release\n\nmkdir -p tutorial/rootfs\ncd tutorial\n# use docker to export busybox into the rootfs directory\ndocker export $(docker create busybox) | tar -C rootfs -xvf -\n```\n\nThen, we need to prepare a configuration file. This file contains metadata and specs for a container, such as the process to run, environment variables to inject, sandboxing features to use, etc.\n\n```bash\n../youki spec  # will generate a spec file named config.json\n```\n\nWe can edit the `config.json` to add customized behaviors for container. Here, we modify the `process` field to run `sleep 30`.\n\n```json\n  \"process\": {\n    ...\n    \"args\": [\n      \"sleep\", \"30\"\n    ],\n\n  ...\n  }\n```\n\nThen we can explore the lifecycle of a container:\n\n```bash\ncd ..                                                # go back to the repository root\nsudo ./youki create -b tutorial tutorial_container   # create a container with name `tutorial_container`\nsudo ./youki state tutorial_container                # you can see the state the container is `created`\nsudo ./youki start tutorial_container                # start the container\nsudo ./youki list                                    # will show the list of containers, the container is `running`\nsudo ./youki delete tutorial_container               # delete the container\n```\n\nChange the command to be executed in `config.json` and try something other than `sleep 30`.\n\n### Rootless container\n\n`youki` provides the ability to run containers as non-root user([rootless mode](https://docs.docker.com/engine/security/rootless/)). To run a container in rootless mode, we need to add some extra options in `config.json`, other steps are same with above:\n\n```bash\nmkdir -p tutorial/rootfs\ncd tutorial\n# use docker to export busybox into the rootfs directory\ndocker export $(docker create busybox) | tar -C rootfs -xvf -\n\n../youki spec --rootless          # will generate a spec file named config.json with rootless mode\n## Modify the `args` field as you like\n\n../youki run rootless-container   # will create and run a container with rootless mode\n```\n\n## Usage\n\nStart the docker daemon.\n\n```bash\ndockerd --experimental --add-runtime=\"youki=$(pwd)/youki\"\n```\n\nIf you get an error like the below, that means your normal Docker daemon is running, and it needs to be stopped. Do that with your init system (i.e., with systemd, run `sudo systemctl stop docker`, as root if necessary).\n\n```console\nfailed to start daemon: pid file found, ensure docker is not running or delete /var/run/docker.pid\n```\n\nNow repeat the command, which should start the docker daemon.\n\nYou can use youki in a different terminal to start the container.\n\n```bash\ndocker run -it --rm --runtime youki busybox\n```\n\nAfterwards, you can close the docker daemon process in other the other terminal. To restart normal docker daemon (if you had stopped it before), run:\n\n```bash\nsudo systemctl start docker\n```\n\n### Integration Tests\n\nGo and node-tap are required to run integration tests. See the [opencontainers/runtime-tools](https://github.com/opencontainers/runtime-tools) README for details.\n\n```bash\ngit submodule update --init --recursive\njust test-oci\n```\n\n### Setting up Vagrant\n\nYou can try youki on platforms other than Linux by using the Vagrantfile we have prepared. We have prepared two environments for vagrant, namely rootless mode and rootful mode\n\n```bash\ngit clone git@github.com:youki-dev/youki.git\ncd youki\n\n# If you want to develop in rootless mode, and this is the default mode\nvagrant up default\nvagrant ssh default\n\n# or if you want to develop in rootful mode\nvagrant up rootful\nvagrant ssh rootful\n\n# in virtual machine\ncd youki\njust youki-dev # or youki-release\n```\n\n# 👥 Community and Contributing\n\nPlease refer to [our community page](https://youki-dev.github.io/youki/community/introduction.html).\n\nThanks to all the people who already contributed!\n\n\u003ca href=\"https://github.com/youki-dev/youki/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contributors-img.web.app/image?repo=youki-dev/youki\" /\u003e\n\u003c/a\u003e\n\n- - -\n**We are a [Cloud Native Computing Foundation](https://cncf.io/) sandbox project.**\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://www.cncf.io/wp-content/uploads/2022/07/cncf-white-logo.svg\"\u003e\n  \u003cimg src=\"https://www.cncf.io/wp-content/uploads/2022/07/cncf-color-bg.svg\" width=300 /\u003e\n\u003c/picture\u003e\n\nThe Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage).\n\n\n## License\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fyouki-dev%2Fyouki.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fyouki-dev%2Fyouki?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyouki-dev%2Fyouki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyouki-dev%2Fyouki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyouki-dev%2Fyouki/lists"}