github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-16 00:16:52 +00:00
Code Issues Projects Releases Wiki Activity
6,099 Commits 84 Branches 134 Tags 333 MiB
Rust 58%
Go 24.7%
Shell 10%
RPC 5.4%
Makefile 1%
Other 0.9%
0828f9ba70
Go to file
David Gibson 0828f9ba70 agent/uevent: Introduce wait_for_uevent() helper 
get_device_name() contains logic to wait for a specific uevent, then
extract the /dev node name from it.  In future we're going to want similar
logic to wait on uevents, but using different match criteria, or getting
different information out.

To simplify this, add a wait_for_uevent() helper in the uevent module,
which takes an explicit UeventMatcher object and returns the whole uevent
found.

To make testing easier, we also extract the cut down uevent watcher from
test_get_device_name() into a new spawn_test_watcher() helper.  Its used
for both test_get_device_name() and a new test_wait_for_uevent() amd will
be useful for more tests in future.

fixes #1484

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2021-04-06 21:14:52 +10:00
.github/workflows actions: enable unit tests in PR check 2021-03-24 20:12:14 +08:00
ci osbuild: build musl toolchain from source if needed 2021-03-03 17:22:39 +08:00
docs Merge pull request #1589 from fidencio/wip/update-install-docs-for-ubuntu 2021-03-31 11:54:34 -06:00
pkg/logging logging: Use guard to make threaded logging safe 2021-03-29 14:32:11 +01:00
snap snap: Use qemu.version to build snap 2021-03-24 17:52:52 +00:00
src agent/uevent: Introduce wait_for_uevent() helper 2021-04-06 21:14:52 +10:00
tools Merge pull request #1620 from eadamsintel/update-qat-dockerfile 2021-04-05 09:51:14 -05:00
utils branch: change 2.0-dev to main 2021-01-22 15:49:35 +08:00
.gitignore gitignore: Ignore *~ editor backup files 2021-02-19 09:54:53 +11:00
CODE_OF_CONDUCT.md docs: Add contributing and code of conduct docs 2018-02-06 10:41:09 +00:00
CODEOWNERS docs: fix static check errors 2020-09-28 11:01:03 +08:00
CONTRIBUTING.md docs: Add contributing and code of conduct docs 2018-02-06 10:41:09 +00:00
LICENSE Initial commit 2017-12-06 23:01:13 -06:00
Makefile Makefile: add default rule 2020-06-27 20:16:53 -07:00
README.md branch: change 2.0-dev to main 2021-01-22 15:49:35 +08:00
utils.mk build: Improve top-level Makefile 2020-06-25 11:19:12 +01:00
VERSION VERSION: Use the correct form 2021-04-01 20:43:34 +02:00
versions.yaml Merge pull request #1592 from likebreath/0330/versions_clh_v0.14.0 2021-03-31 12:39:35 -07:00

README.md

Kata Containers

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.

For further details on the older (first generation) Kata Containers 1.x versions, see the Kata Containers 1.x components section.

Introduction

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.

Getting started

See the installation documentation.

Documentation

See the official documentation (including installation guides, the developer guide, design documents and more).

Community

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.

Getting help

See the community section for ways to contact us.

Raising issues

Please raise an issue in this repository.

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

Kata Containers 1.x versions

For older Kata Containers 1.x releases, please raise an issue in the Kata Containers 1.x component repository that seems most appropriate.

If in doubt, raise an issue in the Kata Containers 1.x runtime repository.

Developers

Components

Component Type Description
agent-ctl utility Tool that provides low-level access for testing the agent.
agent core Management process running inside the virtual machine / POD that sets up the container environment.
documentation documentation Documentation common to all components (such as design and install documentation).
osbuilder infrastructure Tool to create "mini O/S" rootfs and initrd images for the hypervisor.
packaging infrastructure Scripts and metadata for producing packaged binaries
(components, hypervisors, kernel and rootfs).
runtime core Main component run by a container manager and providing a containerd shimv2 runtime implementation.
trace-forwarder utility Agent tracing helper.

Kata Containers 1.x components

For the first generation of Kata Containers (1.x versions), each component was kept in a separate repository.

For information on the Kata Containers 1.x releases, see the Kata Containers 1.x releases page.

For further information on particular Kata Containers 1.x components, see the individual component repositories:

Component Type Description
agent core See components.
documentation documentation
KSM throttler optional core Daemon that monitors containers and deduplicates memory to maximize container density on the host.
osbuilder infrastructure See components.
packaging infrastructure See components.
proxy core Multiplexes communications between the shims, agent and runtime.
runtime core See components.
shim core Handles standard I/O and signals on behalf of the container process.

Note:

  • There are more components for the original Kata Containers 1.x implementation.
  • The current implementation simplifies the design significantly: compare the current and previous generation designs.

Common repositories

The following repositories are used by both the current and first generation Kata Containers implementations:

Component Description Current First generation Notes
CI Continuous Integration configuration files and scripts. Kata 2.x Kata 1.x
kernel The Linux kernel used by the hypervisor to boot the guest image. Kata 2.x Kata 1.x Patches are stored in the packaging component.
tests Test code. Kata 2.x Kata 1.x Excludes unit tests which live with the main code.
www.katacontainers.io Contains the source for the main web site. Kata 2.x Kata 1.x

Packaging and releases

Kata Containers is now available natively for most distributions. However, packaging scripts and metadata are still used to generate snap and GitHub releases. See the components section for further details.