To fulfill the Kata design requirements, and based on the discussion on Virtcontainers API extensions, the Kata runtime library features the following APIs:
- Sandbox based top API
- Storage and network hotplug API
- Plugin frameworks for external proprietary Kata runtime extensions
| Name | Description |
|---|---|
CreateSandbox(SandboxConfig, Factory) |
Create a sandbox and its containers, base on SandboxConfig and Factory. Return the Sandbox structure, but do not start them. |
| Name | Description |
|---|---|
sandbox.Delete() |
Shut down the VM in which the sandbox, and destroy the sandbox and remove all persistent metadata. |
sandbox.Monitor() |
Return a context handler for caller to monitor sandbox callbacks such as error termination. |
sandbox.Release() |
Release a sandbox data structure, close connections to the agent, and quit any goroutines associated with the Sandbox. Mostly used for daemon restart. |
sandbox.Start() |
Start a sandbox and the containers making the sandbox. |
sandbox.Stats() |
Get the stats of a running sandbox, return a SandboxStats structure. |
sandbox.Status() |
Get the status of the sandbox and containers, return a SandboxStatus structure. |
sandbox.Stop(force) |
Stop a sandbox and Destroy the containers in the sandbox. When force is true, ignore guest related stop failures. |
sandbox.CreateContainer(contConfig) |
Create new container in the sandbox with the ContainerConfig parameter. It will add new container config to sandbox.config.Containers. |
sandbox.DeleteContainer(containerID) |
Delete a container from the sandbox by containerID, return a Container structure. |
sandbox.EnterContainer(containerID, cmd) |
Run a new process in a container, executing customer's types.Cmd command. |
sandbox.KillContainer(containerID, signal, all) |
Signal a container in the sandbox by the containerID. |
sandbox.PauseContainer(containerID) |
Pause a running container in the sandbox by the containerID. |
sandbox.ProcessListContainer(containerID, options) |
List every process running inside a specific container in the sandbox, return a ProcessList structure. |
sandbox.ResumeContainer(containerID) |
Resume a paused container in the sandbox by the containerID. |
sandbox.StartContainer(containerID) |
Start a container in the sandbox by the containerID. |
sandbox.StatsContainer(containerID) |
Get the stats of a running container, return a ContainerStats structure. |
sandbox.StatusContainer(containerID) |
Get the status of a container in the sandbox, return a ContainerStatus structure. |
sandbox.StopContainer(containerID, force) |
Stop a container in the sandbox by the containerID. |
sandbox.UpdateContainer(containerID, resources) |
Update a running container in the sandbox. |
sandbox.WaitProcess(containerID, processID) |
Wait on a process to terminate. |
| Name | Description |
|---|---|
sandbox.AddDevice(info) |
Add new storage device DeviceInfo to the sandbox, return a Device structure. |
sandbox.AddInterface(inf) |
Add new NIC to the sandbox. |
sandbox.RemoveInterface(inf) |
Remove a NIC from the sandbox. |
sandbox.ListInterfaces() |
List all NICs and their configurations in the sandbox, return a pbTypes.Interface list. |
sandbox.UpdateRoutes(routes) |
Update the sandbox route table (e.g. for portmapping support), return a pbTypes.Route list. |
sandbox.ListRoutes() |
List the sandbox route table, return a pbTypes.Route list. |
| Name | Description |
|---|---|
sandbox.WinsizeProcess(containerID, processID, Height, Width) |
Relay TTY resize request to a process. |
sandbox.SignalProcess(containerID, processID, signalID, signalALL) |
Relay a signal to a process or all processes in a container. |
sandbox.IOStream(containerID, processID) |
Relay a process stdio. Return stdin/stdout/stderr pipes to the process stdin/stdout/stderr streams. |
| Name | Description |
|---|---|
sandbox.GetOOMEvent() |
Monitor the OOM events that occur in the sandbox.. |
sandbox.UpdateRuntimeMetrics() |
Update the shim/hypervisor metrics of the running sandbox. |
sandbox.GetAgentMetrics() |
Get metrics of the agent and the guest in the running sandbox. |
TBD.
The metadata storage plugin controls where sandbox metadata is saved. All metadata storage plugins must implement the following API:
| Name | Description |
|---|---|
storage.Save(key, value) |
Save a record. |
storage.Load(key) |
Load a record. |
storage.Delete(key) |
Delete a record. |
Built-in implementations include:
- Filesystem storage
- LevelDB storage
The VM factory plugin controls how a sandbox factory creates new VMs. All VM factory plugins must implement following API:
| Name | Description |
|---|---|
VMFactory.NewVM(HypervisorConfig) |
Create a new VM based on HypervisorConfig. |
Built-in implementations include:
| Name | Description |
|---|---|
CreateNew() |
Create brand new VM based on HypervisorConfig. |
CreateFromTemplate() |
Create new VM from template. |
CreateFromCache() |
Create new VM from VM caches. |
