-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move concepts into specific files for easy management Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@docker.com> (github: crosbymichael) Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@docker.com> (github: vmarmol)
- Loading branch information
Showing
7 changed files
with
193 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
package libcontainer | ||
|
||
import ( | ||
"github.com/docker/libcontainer/cgroups" | ||
"github.com/docker/libcontainer/mount" | ||
"github.com/docker/libcontainer/network" | ||
) | ||
|
||
type MountConfig mount.MountConfig | ||
|
||
type Network network.Network | ||
|
||
// Config defines configuration options for executing a process inside a contained environment. | ||
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"` | ||
} | ||
|
||
// 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 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"` | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,86 +1,63 @@ | ||
/* | ||
NOTE: The API is in flux and mainly not implemented. Proceed with caution until further notice. | ||
*/ | ||
package libcontainer | ||
|
||
import ( | ||
"github.com/docker/libcontainer/cgroups" | ||
"github.com/docker/libcontainer/mount" | ||
"github.com/docker/libcontainer/network" | ||
) | ||
|
||
type MountConfig mount.MountConfig | ||
|
||
type Network network.Network | ||
|
||
// Config defines configuration options for executing a process inside a contained environment. | ||
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"` | ||
} | ||
|
||
// Routes can be specified to create entries in the route table as the container is started | ||
// A libcontainer container object. | ||
// | ||
// 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 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"` | ||
// Each container is thread-safe within the same process. Since a container can | ||
// be destroyed by a separate process, any function may return that the container | ||
// was not found. | ||
type Container interface { | ||
// Returns the ID of this container. | ||
ID() string | ||
|
||
// Returns the current run state of the container. | ||
// | ||
// Errors: container no longer exists, | ||
// system error. | ||
RunState() (*RunState, error) | ||
|
||
// Returns the current config of the container. | ||
Config() *Config | ||
|
||
// Destroys the container after killing all running processes. | ||
// | ||
// Any event registrations are removed before the container is destroyed. | ||
// No error is returned if the container is already destroyed. | ||
// | ||
// Errors: system error. | ||
Destroy() error | ||
|
||
// Returns the PIDs inside this container. The PIDs are in the namespace of the calling process. | ||
// | ||
// Errors: container no longer exists, | ||
// system error. | ||
// | ||
// Some of the returned PIDs may no longer refer to processes in the Container, unless | ||
// the Container state is PAUSED in which case every PID in the slice is valid. | ||
Processes() ([]int, error) | ||
|
||
// Returns statistics for the container. | ||
// | ||
// Errors: container no longer exists, | ||
// system error. | ||
Stats() (*ContainerStats, error) | ||
|
||
// If the Container state is RUNNING or PAUSING, sets the Container state to PAUSING and pauses | ||
// the execution of any user processes. Asynchronously, when the container finished being paused the | ||
// state is changed to PAUSED. | ||
// If the Container state is PAUSED, do nothing. | ||
// | ||
// Errors: container no longer exists, | ||
// system error. | ||
Pause() error | ||
|
||
// If the Container state is PAUSED, resumes the execution of any user processes in the | ||
// Container before setting the Container state to RUNNING. | ||
// If the Container state is RUNNING, do nothing. | ||
// | ||
// Errors: container no longer exists, | ||
// system error. | ||
Resume() error | ||
} |
Oops, something went wrong.