Giter VIP home page Giter VIP logo

sysbox-runc's Introduction

sysbox-runc

Introduction

sysbox-runc is part of Sysbox.

sysbox-runc is the program that does the low level kernel setup for execution of system containers. It's the "front-end" of Sysbox: higher layers (e.g., Docker & containerd) invoke sysbox-runc to launch system containers.

sysbox-runc is tightly integrated with sysbox-fs and sysbox-mgr via gRPC. Refer to the Sysbox design doc for further info.

sysbox-runc is a fork of the excellent OCI runc, modified for running system containers. It was forked in early 2019 and has undergone significant changes since then.

sysbox-runc is mostly (but not 100%) compatible with the OCI runtime specification (more on this here).

Building

sysbox-runc is built as part of the Sysbox build process. Refer to the Sysbox developer's guide for more on this.

Running the test suite

sysbox-runc is normally tested as part of the Sysbox test suite. That test suite has Makefile targets to run sysbox-runc unit and integration tests.

Alternatively, you can run the sysbox-runc tests directly as follows:

make test

There are additional make targets for running the tests outside of a container but this is not recommended as the tests are written with the expectation that they can write and remove anywhere.

You can run a specific test case by setting the TESTFLAGS variable.

# make test TESTFLAGS="-run=SomeTestFunction"

You can run a specific integration test by setting the TESTPATH variable.

# make integration TESTPATH="/checkpoint.bats"

You can run a test in your proxy environment by setting DOCKER_BUILD_PROXY and DOCKER_RUN_PROXY variables.

# make test DOCKER_BUILD_PROXY="--build-arg HTTP_PROXY=http://yourproxy/" DOCKER_RUN_PROXY="-e HTTP_PROXY=http://yourproxy/"

Using sysbox-runc

See the Sysbox User Guide for more info on this.

Libcontainer

The libcontainer package in sysbox-runc is not meant to be usable as a standalone library (unlike the libcontainer package in the OCI runc). It has undergone changes that tie it deeply into sysbox-runc.

sysbox-runc's People

Contributors

adrianreber avatar akihirosuda avatar alexlarsson avatar avagin avatar boucher avatar creack avatar crosbymichael avatar ctalledo avatar cyphar avatar datawolf avatar dqminh avatar estesp avatar giuseppe avatar hqhq avatar jessfraz avatar lk4d4 avatar mlaventure avatar mrunalp avatar rajasec avatar rhatdan avatar rjnagal avatar rodnymolina avatar runcom avatar tianon avatar tklauser avatar vieux avatar vishh avatar vmarmol avatar xiaochenshen avatar zhaoleidd avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.