Welcome to Kata Containers!

This repository is the home of the Kata Containers code for the 2.0 and newer releases.

If you want to learn about Kata Containers, visit the main Kata Containers website.

Kata Containers is an open source project and community working to build a standard implementation of lightweight Virtual Machines (VMs) that feel and perform like containers, but provide the workload isolation and security advantages of VMs.

The code is licensed under the Apache 2.0 license. See the license file for further details.

Kata Containers currently runs on 64-bit systems supporting the following technologies:

The Kata Containers runtime provides a command to determine if your host system is capable of running and creating a Kata Container:

$ kata-runtime check

Notes:

• This command runs a number of checks including connecting to the network to determine if a newer release of Kata Containers is available on GitHub. If you do not wish this to check to run, add the --no-network-checks option.

• By default, only a brief success / failure message is printed. If more details are needed, the --verbose flag can be used to display the list of all the checks performed.

• If the command is run as the root user additional checks are run (including checking if another incompatible hypervisor is running). When running as root, network checks are automatically disabled.

See the installation documentation.

See the official documentation including:

• Installation guides
• Developer guide
• Design documents
  • Architecture overview
  • Architecture 3.0 overview

Kata Containers uses a single configuration file which contains a number of sections for various parts of the Kata Containers system including the runtime, the agent and the hypervisor.

See the hypervisors document and the Hypervisor specific configuration details.

To learn more about the project, its community and governance, see the community repository. This is the first place to go if you wish to contribute to the project.

See the community section for ways to contact us.

Please raise an issue in this repository.

Note: If you are reporting a security issue, please follow the vulnerability reporting process

See the developer guide.

The table below lists the core parts of the project:

The table below lists the remaining parts of the project:

Kata Containers is now available natively for most distributions.

See the tests documentation.

See the metrics documentation.

See the glossary of terms related to Kata Containers.