github/kata-containers
1
0
Fork 2
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-10-21 11:58:41 +00:00
Code Issues Projects Releases Wiki Activity
Files
bd8b585c79e5c4f5da34f5bc6131a95dbce99b8e
kata-containers/virtcontainers/documentation/Developers.md
Samuel Ortiz 24eff72d82 virtcontainers: Initial import 
This is a virtcontainers 1.0.8 import into Kata Containers runtime.

virtcontainers is a Go library designed to manage hardware virtualized
pods and containers. It is the core Clear Containers framework and will
become the core Kata Containers framework, as discussed at
https://github.com/kata-containers/runtime/issues/33

Some more more pointers:

virtcontainers README, including some design and architecure notes:
https://github.com/containers/virtcontainers/blob/master/README.md

virtcontainers 1.0 API:
https://github.com/containers/virtcontainers/blob/master/documentation/api/1.0/api.md

Fixes #40

Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
2018-03-13 00:49:46 +01:00

1.1 KiB
Raw Blame History

Table of Contents

Prerequisites

virtcontainers has a few prerequisites for development:

  • docker
  • CNI
  • golang
  • gometalinter

A number of these can be installed using the virtcontainers-setup.sh script.

Building

To build virtcontainers, at the top level directory run:

# make

Testing

Before testing virtcontainers, ensure you have met the prerequisites.

Before testing you need to install virtcontainers. The following command will install virtcontainers into its own area (/usr/bin/virtcontainers/bin/ by default).

# sudo -E PATH=$PATH make install

To test virtcontainers, at the top level run:

# make check

This will:

  • run static code checks on the code base.
  • run go test unit tests from the code base.

Submitting changes

For details on the format and how to submit changes, refer to the Contributing document.