mirror of https://github.com/kata-containers/kata-containers.git synced 2025-10-22 12:29:49 +00:00

Files

James O. D. Hunt bdb83f8282 runtime-rs: ch: Remove unused function

Remove the redundant `parse_mac()` function: this was never used and we
already have an implementation in `crates/resource/src/network/utils/mod.rs`.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>

2023-11-07 17:45:38 +00:00

arch

runtime-rs: Add default configuration file for clouf-hypervisor

2023-10-24 15:17:24 -07:00

config

runtime-rs: Log system enhancement

2023-10-31 04:57:46 +00:00

crates

runtime-rs: ch: Remove unused function

2023-11-07 17:45:38 +00:00

docs/images

docs: fix spelling of "crate"

2023-06-21 16:10:54 +08:00

tests

runtime-rs: add unit test for block driver

2023-08-16 11:45:27 +08:00

.gitignore

build: makefile for dragonball config

2022-06-29 11:19:07 +08:00

Cargo.lock

agent: updating Cargo.lock files

2023-11-06 16:49:58 +00:00

Cargo.toml

feat(runtime-rs): support vcpu resizing on runtime side

2023-06-12 17:53:16 +08:00

Makefile

Merge pull request #8250 from amshinde/runtime-rs-clh-config

2023-10-26 14:54:47 -07:00

README.md

runtime-rs: add binary to exercise shim proper w/o containerd dependencies

2022-12-13 14:55:21 +01:00

VERSION

…

README.md

runtime-rs

Wath's runtime-rs

runtime-rs is a new component introduced in Kata Containers 3.0, it is a Rust version of runtime(shim). It like runtime, but they have many difference:

runtime-rs is written in Rust, and runtime is written in Go.
runtime is the default shim in Kata Containers 3.0, runtime-rs is still under heavy development.
runtime-rs has a completed different architecture than runtime, you can check at the architecture overview.

Note:

runtime-rs is still under heavy development, you should avoid using it in critical system.

Architecture overview

Also, runtime-rs provides the following features:

Turn key solution with builtin Dragonball Sandbox, all components in one process
Async I/O to reduce resource consumption
Extensible framework for multiple services, runtimes and hypervisors
Lifecycle management for sandbox and container associated resources

See the architecture overview for details on the runtime-rs design.

runtime-rs is a runtime written in Rust, it is composed of several crates.

This picture shows the overview about the crates under this directory and the relation between crates.

Not all the features have been implemented yet, for details please check the roadmap.

Crates

The runtime-rs directory contains some crates in the crates directory that compose the containerd-shim-kata-v2.

Crate	Description
`shim`	containerd shimv2 implementation
`service`	services for containers, includes task service
`runtimes`	container runtimes
`resource`	sandbox and container resources
`hypervisor`	hypervisor that act as a sandbox
`agent`	library used to communicate with agent in the guest OS
`persist`	persist container state to disk

shim

shim is the entry point of the containerd shim process, it implements containerd shim's binary protocol:

start: start a new shim process
delete: delete exist a shim process
run: run ttRPC service in shim

containerd will launch a shim process and the shim process will serve as a ttRPC server to provide shim service through TaskService from service crate.

service

The runtime-rs has an extensible framework, includes extension of services, runtimes, and hypervisors.

Currently, only containerd compatible TaskService is implemented.

TaskService has implemented the containerd shim protocol, and interacts with runtimes through messages.

runtimes

Runtime is a container runtime, the runtime handler handles messages from task services to manage containers. Runtime handler and Runtime instance is used to deal with the operation for sandbox and container.

Currently, only VirtContainer has been implemented.

resource

In runtime-rs, all networks/volumes/rootfs are abstracted as resources.

Resources are classified into two types:

sandbox resources: network, share-fs
container resources: rootfs, volume, cgroup

Here is a detailed description of the resources.

hypervisor

For VirtContainer, there will be more hypervisors to choose.

Currently, only built-in Dragonball has been implemented.

agent

agent is used to communicate with agent in the guest OS from the shim side. The only supported agent is KataAgent.

persist

Persist defines traits and functions to help different components save state to disk and load state from disk.

helper libraries

Some helper libraries are maintained in the library directory so that they can be shared with other rust components.

Build and install

See the build from the source section of the rust runtime installation guide.

Configuration

runtime-rs has the same configuration as runtime with some limitations.

Logging

See the debugging section of the developer guide.

Debugging

See the debugging section of the developer guide.

An experimental alternative binary is available that removes containerd dependencies and makes it easier to run the shim proper outside of the runtime's usual deployment environment (i.e. on a developer machine).

Limitations

For Kata Containers limitations, see the limitations file for further details.

runtime-rs is under heavy developments, and doesn't support all features as the Golang version runtime, check the roadmap for details.