package libcontainer
import "github.com/docker/libcontainer"
Index ¶
- func DeleteState(basePath string) error
- func SaveState(basePath string, state *State) error
- type Config
- type ContainerStats
- type MountConfig
- type Network
- type Route
- type State
Functions ¶
func DeleteState ¶
DeleteState deletes the state.json file
func SaveState ¶
SaveState writes the container's runtime state to a state.json file in the specified path
Types ¶
type Config ¶
type Config struct { // Mount specific options. MountConfig *MountConfig `json:"mount_config,omitempty"` // Hostname optionally sets the container's hostname if provided Hostname string `json:"hostname,omitempty"` // User will set the uid and gid of the executing process running inside the container User string `json:"user,omitempty"` // WorkingDir will change the processes current working directory inside the container's rootfs WorkingDir string `json:"working_dir,omitempty"` // Env will populate the processes environment with the provided values // Any values from the parent processes will be cleared before the values // provided in Env are provided to the process Env []string `json:"environment,omitempty"` // Tty when true will allocate a pty slave on the host for access by the container's process // and ensure that it is mounted inside the container's rootfs Tty bool `json:"tty,omitempty"` // Namespaces specifies the container's namespaces that it should setup when cloning the init process // If a namespace is not provided that namespace is shared from the container's parent process Namespaces map[string]bool `json:"namespaces,omitempty"` // Capabilities specify the capabilities to keep when executing the process inside the container // All capbilities not specified will be dropped from the processes capability mask Capabilities []string `json:"capabilities,omitempty"` // Networks specifies the container's network setup to be created Networks []*Network `json:"networks,omitempty"` // Routes can be specified to create entries in the route table as the container is started Routes []*Route `json:"routes,omitempty"` // Cgroups specifies specific cgroup settings for the various subsystems that the container is // placed into to limit the resources the container has available Cgroups *cgroups.Cgroup `json:"cgroups,omitempty"` // AppArmorProfile specifies the profile to apply to the process running in the container and is // change at the time the process is execed AppArmorProfile string `json:"apparmor_profile,omitempty"` // ProcessLabel specifies the label to apply to the process running in the container. It is // commonly used by selinux ProcessLabel string `json:"process_label,omitempty"` // RestrictSys will remount /proc/sys, /sys, and mask over sysrq-trigger as well as /proc/irq and // /proc/bus RestrictSys bool `json:"restrict_sys,omitempty"` }
Config defines configuration options for executing a process inside a contained environment.
type ContainerStats ¶
type ContainerStats struct { NetworkStats network.NetworkStats `json:"network_stats, omitempty"` CgroupStats *cgroups.Stats `json:"cgroup_stats, omitempty"` }
func GetStats ¶
func GetStats(container *Config, state *State) (*ContainerStats, error)
Returns all available stats for the given container.
type MountConfig ¶
type MountConfig mount.MountConfig
type Network ¶
type Route ¶
type Route struct { // Sets the destination and mask, should be a CIDR. Accepts IPv4 and IPv6 Destination string `json:"destination,omitempty"` // Sets the source and mask, should be a CIDR. Accepts IPv4 and IPv6 Source string `json:"source,omitempty"` // Sets the gateway. Accepts IPv4 and IPv6 Gateway string `json:"gateway,omitempty"` // The device to set this route up for, for example: eth0 InterfaceName string `json:"interface_name,omitempty"` }
Routes can be specified to create entries in the route table as the container is started
All of destination, source, and gateway should be either IPv4 or IPv6. One of the three options must be present, and ommitted entries will use their IP family default for the route table. For IPv4 for example, setting the gateway to 1.2.3.4 and the interface to eth0 will set up a standard destination of 0.0.0.0(or *) when viewed in the route table.
type State ¶
type State struct { // InitPid is the init process id in the parent namespace InitPid int `json:"init_pid,omitempty"` // InitStartTime is the init process start time InitStartTime string `json:"init_start_time,omitempty"` // Network runtime state. NetworkState network.NetworkState `json:"network_state,omitempty"` }
State represents a running container's state
func GetState ¶
GetState reads the state.json file for a running container
Source Files ¶
api.go container.go state.go types.go
Directories ¶
Path | Synopsis |
---|---|
apparmor | |
cgroups | |
cgroups/fs | Utility for testing cgroup operations. |
cgroups/systemd | |
devices | |
label | |
mount | |
mount/nodes | |
namespaces | |
netlink | Packet netlink provide access to low level Netlink sockets and messages. |
network | |
nsinit | |
security | |
security/capabilities | |
security/restrict | |
selinux | |
utils |
- Version
- v1.1.0
- Published
- Jun 26, 2014
- Platform
- js/wasm
- Imports
- 7 packages
- Last checked
- 2 hours ago –
Tools for package owners.