Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README.md #105

Merged
merged 1 commit into from
Jun 22, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,21 @@ Here is why I am rewriting a new container runtime in Rust.
youki is not at the practical stage yet. However, it is getting closer to practical use, running with docker and passing all the default tests provided by [opencontainers/runtime-tools](https://github.com/opencontainers/runtime-tools).
![youki demo](docs/demo.gif)

## Features

- [x] run with docker
- [ ] run with podman(WIP on [#24](https://github.com/containers/youki/issues/24))
- [x] pivot root
- [x] mount devices
- [x] namespaces
- [x] capabilities
- [x] rlimits
- [ ] cgroups v1(WIP on [#9](https://github.com/containers/youki/issues/9))
- [ ] cgroups v2(WIP on [#78](https://github.com/containers/youki/issues/78))
- [ ] seccomp(WIP on [#25](https://github.com/containers/youki/issues/25))
- [ ] hooks(WIP on [#13](https://github.com/containers/youki/issues/13))
- [ ] rootless(WIP on [#77](https://github.com/containers/youki/issues/77))

# Getting Started

Local build is only supported on linux.
Expand All @@ -41,20 +56,22 @@ For other platforms, please use the devcontainer that we prepared.
- Docker(See [here](https://docs.docker.com/engine/install))

## Dependencies

```sh
$ cargo install cargo-when
```

### Debian, Ubuntu and related distributions

```sh
$ sudo dnf install \
pkg-config \
libsystemd-dev \
libdbus-glib-1-dev
```


### Fedora, Centos, RHEL and related distributions

```sh
$ sudo dnf install \
pkg-config \
Expand All @@ -63,6 +80,7 @@ $ sudo dnf install \
```

## Build

```sh
$ git clone [email protected]:containers/youki.git
$ cd youki
Expand Down Expand Up @@ -130,21 +148,6 @@ We also have an active [Discord](https://discord.gg/h7R3HgWUct) if you'd like to

TBD(WIP on [#14](https://github.com/containers/youki/issues/14))

# Features

- [x] run with docker
- [ ] run with podman
- [x] pivot root
- [x] mount devices
- [x] namespaces
- [x] capabilities
- [x] rlimits
- [ ] cgroups v1(WIP on [#9](https://github.com/containers/youki/issues/9))
- [ ] cgroups v2
- [ ] seccomp
- [ ] hooks(WIP on [#13](https://github.com/containers/youki/issues/13))
- [ ] rootless

# Contribution

This project welcomes your PR and issues.
Expand Down