youki
Experimental implementation of the oci-runtime in Rust
Overview
youki is an implementation of runtime-spec in Rust, referring to runc. This project is in the experimental stage at this point. I think Rust is one of the best languages to implement oci-runtime, so I'm having fun experimenting with it.
Building
Two types of building are available: devcontainer or local. You can choose whichever you like, but the local one will only work on Linux.
Local
Requires
- Rust(See here)
- Docker
Building
$ git clone [email protected]:utam0k/youki.git
$ cargo build
$ RUST_BACKTRACE=full YOUKI_LOG_LEVEL=debug YOUKI_MODE=/var/lib/docker/containers/ dockerd --experimental --add-runtime="youki=$(pwd)/target/x86_64-unknown-linux-gnu/debug/youki"
Devcontainer
We prepared devcontainer as a development environment. If you use devcontainer for the first time, please refer to this page.
The following explanation assumes that devcontainer is used. The first time it starts up will take a while, so have a cup of coffee and wait ;)
Requires
- VSCode
- Docker
Bulding
This commands should be run runs in your local terminal.
$ git clone [email protected]:utam0k/youki.git
$ code youki
And use devcontainer in your vscode.
dockerd is already running when you start devcontainer. You can get more information about the startup process by referring to .devcontainer/scripts/init.sh.
Usage
youki with Docker
$ docker run -it --rm --runtime youki hello-world
$ docker run -it --rm --runtime youki busybox
Integration test
$ /workspaces/youki/.devcontainer/scripts/setup_test.sh # only the first time
$ /workspaces/youki/.devcontainer/scripts/test.sh
HelloWorld with youki
Do Hello, World using the log function of Youki. If you want to explore youki, please use it.
Try adding the following code to the line in src/main.rs after initializing the logger of the main function and try to cargo build in your terminal.
log::debug!("Hello, World");
When you run busybox, sh will start and stop.
$ docker run -it --rm --runtime youki --name youki busybox
If you run the following command in a different terminal, you will see the Hello, World that you added above.
$ docker logs youki
Features
- somehow works
- run with docker
- namespace
- rlimits
- cgroup
- hooks
Contribution
This project welcomes your PR and issues. For example, refactoring, adding features, correcting English, etc. If you need any help, you can contact me on Twitter.
4.2k Dec 29, 2022
73 Jan 9, 2023
175 Dec 29, 2022
9.9k Jan 5, 2023
5 May 11, 2023
438 Dec 26, 2022
1.8k Jan 8, 2023
12 May 27, 2023
29 Jul 15, 2024
16 Feb 14, 2022
83 Nov 30, 2022
321 Dec 11, 2022
1.3k Jan 1, 2023
155 Jan 1, 2023
365 Dec 30, 2022
102 Dec 24, 2022
48 Apr 26, 2022
103 Dec 29, 2022