Skip to content

Commit

Permalink
Cleanup readme.
Browse files Browse the repository at this point in the history
Signed-off-by: Ruben Jenster <[email protected]>
  • Loading branch information
r10r committed Apr 21, 2021
1 parent 2a5a683 commit 4dc5e9c
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,18 @@ a drop-in container runtime replacement for use by [CRI-O](https://github.com/ku

### OCI compliance

With liblxc >= https://github.com/lxc/lxc/commit/b5daeddc5afce1cad4915aef3e71fdfe0f428709
With liblxc starting from [lxc-4.0.0-927-gb5daeddc5](https://github.com/lxc/lxc/commit/b5daeddc5afce1cad4915aef3e71fdfe0f428709)
it passes all sonobuoy conformance tests.

## Installation

For the installation of the runtime see [install.md](doc/install.md)</br>
For the installation and initialization of a kubernetes cluster see [kubernetes.md](doc/kubernetes.md)

## Bugs
## API Usage

* cli: --help shows environment values not defaults https://github.com/urfave/cli/issues/1206
Please have a look at the [runtime tests](runtime_test.go) for now.

## Requirements and restrictions
## Notes

* Only cgroupv2 (unified cgroup hierarchy) is supported.
* A recent kernel >= 5.8 is required for full cgroup support.

### Unimplemented features

* [runtime: Implement POSIX platform hooks](https://github.com/Drachenfels-GmbH/lxcri/issues/10)
* [runtime: Implement cgroup2 resource limits](https://github.com/Drachenfels-GmbH/lxcri/issues/11)
* It's currently only tested with cgroups v2.

0 comments on commit 4dc5e9c

Please sign in to comment.