157e055fdd
Fixes: #1224 35ecd6f (origin/change-name, change-name) Update readme eb6577e Change package name to cgroups-rs 8f6a7e0 Merge pull request #19 from Tim-Zhang/0.2.0 9baa065 (origin/0.2.0, 0.2.0) release: v0.2.0 e160df0 Make read_i64_from private and merge read_str_from to its caller e1e05d3 Make new_with_relative_paths=new and load_with_relative_paths=new in v2 a89f4a0 Support set notify_on_release & release_agent 61a0957 Fix set_swappiness in cgroup v2 0592045 Ignore kmem in cgroup v2 c254fff Update readme 438d774 Fix test 42ee1ba Make Cgroup can be stored in struct b6bb5ae docs: Hide Re-exports d2882b1 Print cause when println!("{}") abcb5ed Add more logs for create_dir error in controller.create 1f188be Detect subsystems and get root from /proc/self/mountinfo fbd7164 Fix warnings in tests f342254 Remove Box wrap of Cgroup.hire cd998f3 Do not place cgroup under relative path read from cgroup by default 1ac76b6 Make function find_v1_mount pub 121f78d Expose deletion error 0f76570 Avoid exception caused by cgroup writeback feature 10650e2 Update tests to adapt new type of fields in resource 567cdb4 Use Option as resource fields, remove the update switch: update_values 0c18b08 Support customized attributes for CpuController and MemController ca610bb add add_task_by_tgid Signed-off-by: Tim Zhang <tim@hyper.sh>
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.