Categorygithub.com/firecracker-microvm/firecracker-containerdagent
package
0.0.0-20241231175036-e5a3c7784f22
Repository: https://github.com/firecracker-microvm/firecracker-containerd.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
39
Dependents
0
Files
1.1k SLOC

# README

containerd-firecracker-agent

The containerd Firecracker agent is a component which runs inside containerd-managed Firecracker microVMs. The containerd Firecracker agent communicates with the containerd-firecracker-runtime over a vsock and proxies commands to runc

Installation

The containerd Firecracker agent must be embedded into the filesystem image used to launch the microVM and configured to start on boot.

Usage

Once started and set up with a properly-configured vsock, the containerd Firecracker agent is used automatically by the containerd-shim-aws-firecracker process running outside the microVM.

# Functions

NewTaskService creates new runc shim wrapper.
TaskExecID provides a unique string for a given (taskID, execID) pair.

# Structs

TaskService represents inner shim wrapper over runc in order to: - Add default namespace to ctx as it's not passed by ttrpc over vsock - Add debug logging to simplify debugging - Make place for future extensions as needed.