README
¶
Background
The packages in this directory comprise most of the code used to build the guest side agent for Linux Hyper-V containers on Windows (LCOW). The guest agent is designed to run inside a custom Linux OS for supporting Linux container payloads. It's a process that is designed to be connected to from a host machine to carry out requests for running containers in the Linux guest.
The two binaries of importance that are built from this code are the main guest agent that facilitates communication between the host and guest and a generic tools binary for additional functionality for device scenarios.
As most of the rest of the repository is designed in part to run on Windows, the guest package tries to serve as a separation between the two. Any guest side LCOW specific feature work should end up here.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bridge defines the bridge struct, which implements the control loop and functions of the GCS's bridge client.
|
Package bridge defines the bridge struct, which implements the control loop and functions of the GCS's bridge client. |
|
Package kmsg contains support for parsing Linux kernel log entries read from /dev/kmsg.
|
Package kmsg contains support for parsing Linux kernel log entries read from /dev/kmsg. |
|
Package linux contains definitions required for making a linux ioctl.
|
Package linux contains definitions required for making a linux ioctl. |
|
Package prot defines any structures used in the communication between the HCS and the GCS.
|
Package prot defines any structures used in the communication between the HCS and the GCS. |
|
Package runtime defines the interface between the GCS and an OCI container runtime.
|
Package runtime defines the interface between the GCS and an OCI container runtime. |
|
runc
Package runc defines an implementation of the Runtime interface which uses runC as the container runtime.
|
Package runc defines an implementation of the Runtime interface which uses runC as the container runtime. |
|
Package spec encapsulates a number of GCS specific oci spec modifications, e.g., networking mounts, sandbox path substitutions in guest etc.
|
Package spec encapsulates a number of GCS specific oci spec modifications, e.g., networking mounts, sandbox path substitutions in guest etc. |
|
Package transport defines the interfaces describing a connection-like data transport mechanism.
|
Package transport defines the interfaces describing a connection-like data transport mechanism. |