mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
487 lines
16 KiB
Go
487 lines
16 KiB
Go
package runconfig
|
|
|
|
import (
|
|
"fmt"
|
|
"path"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/docker/docker/nat"
|
|
"github.com/docker/docker/opts"
|
|
flag "github.com/docker/docker/pkg/mflag"
|
|
"github.com/docker/docker/pkg/parsers"
|
|
"github.com/docker/docker/pkg/ulimit"
|
|
"github.com/docker/docker/pkg/units"
|
|
"github.com/docker/docker/utils"
|
|
)
|
|
|
|
var (
|
|
ErrInvalidWorkingDirectory = fmt.Errorf("The working directory is invalid. It needs to be an absolute path.")
|
|
ErrConflictContainerNetworkAndLinks = fmt.Errorf("Conflicting options: --net=container can't be used with links. This would result in undefined behavior.")
|
|
ErrConflictContainerNetworkAndDns = fmt.Errorf("Conflicting options: --net=container can't be used with --dns. This configuration is invalid.")
|
|
ErrConflictNetworkHostname = fmt.Errorf("Conflicting options: -h and the network mode (--net)")
|
|
ErrConflictHostNetworkAndDns = fmt.Errorf("Conflicting options: --net=host can't be used with --dns. This configuration is invalid.")
|
|
ErrConflictHostNetworkAndLinks = fmt.Errorf("Conflicting options: --net=host can't be used with links. This would result in undefined behavior.")
|
|
)
|
|
|
|
func Parse(cmd *flag.FlagSet, args []string) (*Config, *HostConfig, *flag.FlagSet, error) {
|
|
var (
|
|
// FIXME: use utils.ListOpts for attach and volumes?
|
|
flAttach = opts.NewListOpts(opts.ValidateAttach)
|
|
flVolumes = opts.NewListOpts(opts.ValidatePath)
|
|
flLinks = opts.NewListOpts(opts.ValidateLink)
|
|
flEnv = opts.NewListOpts(opts.ValidateEnv)
|
|
flLabels = opts.NewListOpts(opts.ValidateEnv)
|
|
flDevices = opts.NewListOpts(opts.ValidatePath)
|
|
|
|
ulimits = make(map[string]*ulimit.Ulimit)
|
|
flUlimits = opts.NewUlimitOpt(ulimits)
|
|
|
|
flPublish = opts.NewListOpts(nil)
|
|
flExpose = opts.NewListOpts(nil)
|
|
flDns = opts.NewListOpts(opts.ValidateIPAddress)
|
|
flDnsSearch = opts.NewListOpts(opts.ValidateDnsSearch)
|
|
flExtraHosts = opts.NewListOpts(opts.ValidateExtraHost)
|
|
flVolumesFrom = opts.NewListOpts(nil)
|
|
flLxcOpts = opts.NewListOpts(nil)
|
|
flEnvFile = opts.NewListOpts(nil)
|
|
flCapAdd = opts.NewListOpts(nil)
|
|
flCapDrop = opts.NewListOpts(nil)
|
|
flSecurityOpt = opts.NewListOpts(nil)
|
|
flLabelsFile = opts.NewListOpts(nil)
|
|
|
|
flNetwork = cmd.Bool([]string{"#n", "#-networking"}, true, "Enable networking for this container")
|
|
flPrivileged = cmd.Bool([]string{"#privileged", "-privileged"}, false, "Give extended privileges to this container")
|
|
flPidMode = cmd.String([]string{"-pid"}, "", "PID namespace to use")
|
|
flPublishAll = cmd.Bool([]string{"P", "-publish-all"}, false, "Publish all exposed ports to random ports")
|
|
flStdin = cmd.Bool([]string{"i", "-interactive"}, false, "Keep STDIN open even if not attached")
|
|
flTty = cmd.Bool([]string{"t", "-tty"}, false, "Allocate a pseudo-TTY")
|
|
flContainerIDFile = cmd.String([]string{"#cidfile", "-cidfile"}, "", "Write the container ID to the file")
|
|
flEntrypoint = cmd.String([]string{"#entrypoint", "-entrypoint"}, "", "Overwrite the default ENTRYPOINT of the image")
|
|
flHostname = cmd.String([]string{"h", "-hostname"}, "", "Container host name")
|
|
flMemoryString = cmd.String([]string{"m", "-memory"}, "", "Memory limit")
|
|
flMemorySwap = cmd.String([]string{"-memory-swap"}, "", "Total memory (memory + swap), '-1' to disable swap")
|
|
flUser = cmd.String([]string{"u", "-user"}, "", "Username or UID (format: <name|uid>[:<group|gid>])")
|
|
flWorkingDir = cmd.String([]string{"w", "-workdir"}, "", "Working directory inside the container")
|
|
flCpuShares = cmd.Int64([]string{"c", "-cpu-shares"}, 0, "CPU shares (relative weight)")
|
|
flCpusetCpus = cmd.String([]string{"#-cpuset", "-cpuset-cpus"}, "", "CPUs in which to allow execution (0-3, 0,1)")
|
|
flNetMode = cmd.String([]string{"-net"}, "bridge", "Set the Network mode for the container")
|
|
flMacAddress = cmd.String([]string{"-mac-address"}, "", "Container MAC address (e.g. 92:d0:c6:0a:29:33)")
|
|
flIpcMode = cmd.String([]string{"-ipc"}, "", "IPC namespace to use")
|
|
flRestartPolicy = cmd.String([]string{"-restart"}, "no", "Restart policy to apply when a container exits")
|
|
flReadonlyRootfs = cmd.Bool([]string{"-read-only"}, false, "Mount the container's root filesystem as read only")
|
|
flLoggingDriver = cmd.String([]string{"-log-driver"}, "", "Logging driver for container")
|
|
flCgroupParent = cmd.String([]string{"-cgroup-parent"}, "", "Optional parent cgroup for the container")
|
|
)
|
|
|
|
cmd.Var(&flAttach, []string{"a", "-attach"}, "Attach to STDIN, STDOUT or STDERR")
|
|
cmd.Var(&flVolumes, []string{"v", "-volume"}, "Bind mount a volume")
|
|
cmd.Var(&flLinks, []string{"#link", "-link"}, "Add link to another container")
|
|
cmd.Var(&flDevices, []string{"-device"}, "Add a host device to the container")
|
|
cmd.Var(&flLabels, []string{"l", "-label"}, "Set meta data on a container")
|
|
cmd.Var(&flLabelsFile, []string{"-label-file"}, "Read in a line delimited file of labels")
|
|
cmd.Var(&flEnv, []string{"e", "-env"}, "Set environment variables")
|
|
cmd.Var(&flEnvFile, []string{"-env-file"}, "Read in a file of environment variables")
|
|
cmd.Var(&flPublish, []string{"p", "-publish"}, "Publish a container's port(s) to the host")
|
|
cmd.Var(&flExpose, []string{"#expose", "-expose"}, "Expose a port or a range of ports")
|
|
cmd.Var(&flDns, []string{"#dns", "-dns"}, "Set custom DNS servers")
|
|
cmd.Var(&flDnsSearch, []string{"-dns-search"}, "Set custom DNS search domains")
|
|
cmd.Var(&flExtraHosts, []string{"-add-host"}, "Add a custom host-to-IP mapping (host:ip)")
|
|
cmd.Var(&flVolumesFrom, []string{"#volumes-from", "-volumes-from"}, "Mount volumes from the specified container(s)")
|
|
cmd.Var(&flLxcOpts, []string{"#lxc-conf", "-lxc-conf"}, "Add custom lxc options")
|
|
cmd.Var(&flCapAdd, []string{"-cap-add"}, "Add Linux capabilities")
|
|
cmd.Var(&flCapDrop, []string{"-cap-drop"}, "Drop Linux capabilities")
|
|
cmd.Var(&flSecurityOpt, []string{"-security-opt"}, "Security Options")
|
|
cmd.Var(flUlimits, []string{"-ulimit"}, "Ulimit options")
|
|
|
|
cmd.Require(flag.Min, 1)
|
|
|
|
if err := cmd.ParseFlags(args, true); err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
|
|
// Validate input params
|
|
if *flWorkingDir != "" && !path.IsAbs(*flWorkingDir) {
|
|
return nil, nil, cmd, ErrInvalidWorkingDirectory
|
|
}
|
|
|
|
// Validate the input mac address
|
|
if *flMacAddress != "" {
|
|
if _, err := opts.ValidateMACAddress(*flMacAddress); err != nil {
|
|
return nil, nil, cmd, fmt.Errorf("%s is not a valid mac address", *flMacAddress)
|
|
}
|
|
}
|
|
var (
|
|
attachStdin = flAttach.Get("stdin")
|
|
attachStdout = flAttach.Get("stdout")
|
|
attachStderr = flAttach.Get("stderr")
|
|
)
|
|
|
|
if *flNetMode != "bridge" && *flNetMode != "none" && *flHostname != "" {
|
|
return nil, nil, cmd, ErrConflictNetworkHostname
|
|
}
|
|
|
|
if *flNetMode == "host" && flLinks.Len() > 0 {
|
|
return nil, nil, cmd, ErrConflictHostNetworkAndLinks
|
|
}
|
|
|
|
if *flNetMode == "container" && flLinks.Len() > 0 {
|
|
return nil, nil, cmd, ErrConflictContainerNetworkAndLinks
|
|
}
|
|
|
|
if *flNetMode == "host" && flDns.Len() > 0 {
|
|
return nil, nil, cmd, ErrConflictHostNetworkAndDns
|
|
}
|
|
|
|
if *flNetMode == "container" && flDns.Len() > 0 {
|
|
return nil, nil, cmd, ErrConflictContainerNetworkAndDns
|
|
}
|
|
|
|
// If neither -d or -a are set, attach to everything by default
|
|
if flAttach.Len() == 0 {
|
|
attachStdout = true
|
|
attachStderr = true
|
|
if *flStdin {
|
|
attachStdin = true
|
|
}
|
|
}
|
|
|
|
var flMemory int64
|
|
if *flMemoryString != "" {
|
|
parsedMemory, err := units.RAMInBytes(*flMemoryString)
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
flMemory = parsedMemory
|
|
}
|
|
|
|
var MemorySwap int64
|
|
if *flMemorySwap != "" {
|
|
if *flMemorySwap == "-1" {
|
|
MemorySwap = -1
|
|
} else {
|
|
parsedMemorySwap, err := units.RAMInBytes(*flMemorySwap)
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
MemorySwap = parsedMemorySwap
|
|
}
|
|
}
|
|
|
|
var binds []string
|
|
// add any bind targets to the list of container volumes
|
|
for bind := range flVolumes.GetMap() {
|
|
if arr := strings.Split(bind, ":"); len(arr) > 1 {
|
|
if arr[1] == "/" {
|
|
return nil, nil, cmd, fmt.Errorf("Invalid bind mount: destination can't be '/'")
|
|
}
|
|
// after creating the bind mount we want to delete it from the flVolumes values because
|
|
// we do not want bind mounts being committed to image configs
|
|
binds = append(binds, bind)
|
|
flVolumes.Delete(bind)
|
|
} else if bind == "/" {
|
|
return nil, nil, cmd, fmt.Errorf("Invalid volume: path can't be '/'")
|
|
}
|
|
}
|
|
|
|
var (
|
|
parsedArgs = cmd.Args()
|
|
runCmd []string
|
|
entrypoint []string
|
|
image = cmd.Arg(0)
|
|
)
|
|
if len(parsedArgs) > 1 {
|
|
runCmd = parsedArgs[1:]
|
|
}
|
|
if *flEntrypoint != "" {
|
|
entrypoint = []string{*flEntrypoint}
|
|
}
|
|
|
|
lxcConf, err := parseKeyValueOpts(flLxcOpts)
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
|
|
var (
|
|
domainname string
|
|
hostname = *flHostname
|
|
parts = strings.SplitN(hostname, ".", 2)
|
|
)
|
|
if len(parts) > 1 {
|
|
hostname = parts[0]
|
|
domainname = parts[1]
|
|
}
|
|
|
|
ports, portBindings, err := nat.ParsePortSpecs(flPublish.GetAll())
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
|
|
// Merge in exposed ports to the map of published ports
|
|
for _, e := range flExpose.GetAll() {
|
|
if strings.Contains(e, ":") {
|
|
return nil, nil, cmd, fmt.Errorf("Invalid port format for --expose: %s", e)
|
|
}
|
|
//support two formats for expose, original format <portnum>/[<proto>] or <startport-endport>/[<proto>]
|
|
proto, port := nat.SplitProtoPort(e)
|
|
//parse the start and end port and create a sequence of ports to expose
|
|
//if expose a port, the start and end port are the same
|
|
start, end, err := parsers.ParsePortRange(port)
|
|
if err != nil {
|
|
return nil, nil, cmd, fmt.Errorf("Invalid range format for --expose: %s, error: %s", e, err)
|
|
}
|
|
for i := start; i <= end; i++ {
|
|
p := nat.NewPort(proto, strconv.FormatUint(i, 10))
|
|
if _, exists := ports[p]; !exists {
|
|
ports[p] = struct{}{}
|
|
}
|
|
}
|
|
}
|
|
|
|
// parse device mappings
|
|
deviceMappings := []DeviceMapping{}
|
|
for _, device := range flDevices.GetAll() {
|
|
deviceMapping, err := ParseDevice(device)
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
deviceMappings = append(deviceMappings, deviceMapping)
|
|
}
|
|
|
|
// collect all the environment variables for the container
|
|
envVariables, err := readKVStrings(flEnvFile.GetAll(), flEnv.GetAll())
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
|
|
// collect all the labels for the container
|
|
labels, err := readKVStrings(flLabelsFile.GetAll(), flLabels.GetAll())
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
|
|
ipcMode := IpcMode(*flIpcMode)
|
|
if !ipcMode.Valid() {
|
|
return nil, nil, cmd, fmt.Errorf("--ipc: invalid IPC mode")
|
|
}
|
|
|
|
pidMode := PidMode(*flPidMode)
|
|
if !pidMode.Valid() {
|
|
return nil, nil, cmd, fmt.Errorf("--pid: invalid PID mode")
|
|
}
|
|
|
|
netMode, err := parseNetMode(*flNetMode)
|
|
if err != nil {
|
|
return nil, nil, cmd, fmt.Errorf("--net: invalid net mode: %v", err)
|
|
}
|
|
|
|
restartPolicy, err := parseRestartPolicy(*flRestartPolicy)
|
|
if err != nil {
|
|
return nil, nil, cmd, err
|
|
}
|
|
|
|
config := &Config{
|
|
Hostname: hostname,
|
|
Domainname: domainname,
|
|
PortSpecs: nil, // Deprecated
|
|
ExposedPorts: ports,
|
|
User: *flUser,
|
|
Tty: *flTty,
|
|
NetworkDisabled: !*flNetwork,
|
|
OpenStdin: *flStdin,
|
|
Memory: flMemory, // FIXME: for backward compatibility
|
|
MemorySwap: MemorySwap, // FIXME: for backward compatibility
|
|
CpuShares: *flCpuShares, // FIXME: for backward compatibility
|
|
Cpuset: *flCpusetCpus, // FIXME: for backward compatibility
|
|
AttachStdin: attachStdin,
|
|
AttachStdout: attachStdout,
|
|
AttachStderr: attachStderr,
|
|
Env: envVariables,
|
|
Cmd: runCmd,
|
|
Image: image,
|
|
Volumes: flVolumes.GetMap(),
|
|
MacAddress: *flMacAddress,
|
|
Entrypoint: entrypoint,
|
|
WorkingDir: *flWorkingDir,
|
|
Labels: convertKVStringsToMap(labels),
|
|
}
|
|
|
|
hostConfig := &HostConfig{
|
|
Binds: binds,
|
|
ContainerIDFile: *flContainerIDFile,
|
|
LxcConf: lxcConf,
|
|
Memory: flMemory,
|
|
MemorySwap: MemorySwap,
|
|
CpuShares: *flCpuShares,
|
|
CpusetCpus: *flCpusetCpus,
|
|
Privileged: *flPrivileged,
|
|
PortBindings: portBindings,
|
|
Links: flLinks.GetAll(),
|
|
PublishAllPorts: *flPublishAll,
|
|
Dns: flDns.GetAll(),
|
|
DnsSearch: flDnsSearch.GetAll(),
|
|
ExtraHosts: flExtraHosts.GetAll(),
|
|
VolumesFrom: flVolumesFrom.GetAll(),
|
|
NetworkMode: netMode,
|
|
IpcMode: ipcMode,
|
|
PidMode: pidMode,
|
|
Devices: deviceMappings,
|
|
CapAdd: flCapAdd.GetAll(),
|
|
CapDrop: flCapDrop.GetAll(),
|
|
RestartPolicy: restartPolicy,
|
|
SecurityOpt: flSecurityOpt.GetAll(),
|
|
ReadonlyRootfs: *flReadonlyRootfs,
|
|
Ulimits: flUlimits.GetList(),
|
|
LogConfig: LogConfig{Type: *flLoggingDriver},
|
|
CgroupParent: *flCgroupParent,
|
|
}
|
|
|
|
// When allocating stdin in attached mode, close stdin at client disconnect
|
|
if config.OpenStdin && config.AttachStdin {
|
|
config.StdinOnce = true
|
|
}
|
|
return config, hostConfig, cmd, nil
|
|
}
|
|
|
|
// reads a file of line terminated key=value pairs and override that with override parameter
|
|
func readKVStrings(files []string, override []string) ([]string, error) {
|
|
envVariables := []string{}
|
|
for _, ef := range files {
|
|
parsedVars, err := opts.ParseEnvFile(ef)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
envVariables = append(envVariables, parsedVars...)
|
|
}
|
|
// parse the '-e' and '--env' after, to allow override
|
|
envVariables = append(envVariables, override...)
|
|
|
|
return envVariables, nil
|
|
}
|
|
|
|
// converts ["key=value"] to {"key":"value"}
|
|
func convertKVStringsToMap(values []string) map[string]string {
|
|
result := make(map[string]string, len(values))
|
|
for _, value := range values {
|
|
kv := strings.SplitN(value, "=", 2)
|
|
if len(kv) == 1 {
|
|
result[kv[0]] = ""
|
|
} else {
|
|
result[kv[0]] = kv[1]
|
|
}
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
// parseRestartPolicy returns the parsed policy or an error indicating what is incorrect
|
|
func parseRestartPolicy(policy string) (RestartPolicy, error) {
|
|
p := RestartPolicy{}
|
|
|
|
if policy == "" {
|
|
return p, nil
|
|
}
|
|
|
|
var (
|
|
parts = strings.Split(policy, ":")
|
|
name = parts[0]
|
|
)
|
|
|
|
p.Name = name
|
|
switch name {
|
|
case "always":
|
|
if len(parts) == 2 {
|
|
return p, fmt.Errorf("maximum restart count not valid with restart policy of \"always\"")
|
|
}
|
|
case "no":
|
|
// do nothing
|
|
case "on-failure":
|
|
if len(parts) == 2 {
|
|
count, err := strconv.Atoi(parts[1])
|
|
if err != nil {
|
|
return p, err
|
|
}
|
|
|
|
p.MaximumRetryCount = count
|
|
}
|
|
default:
|
|
return p, fmt.Errorf("invalid restart policy %s", name)
|
|
}
|
|
|
|
return p, nil
|
|
}
|
|
|
|
// options will come in the format of name.key=value or name.option
|
|
func parseDriverOpts(opts opts.ListOpts) (map[string][]string, error) {
|
|
out := make(map[string][]string, len(opts.GetAll()))
|
|
for _, o := range opts.GetAll() {
|
|
parts := strings.SplitN(o, ".", 2)
|
|
if len(parts) < 2 {
|
|
return nil, fmt.Errorf("invalid opt format %s", o)
|
|
} else if strings.TrimSpace(parts[0]) == "" {
|
|
return nil, fmt.Errorf("key cannot be empty %s", o)
|
|
}
|
|
values, exists := out[parts[0]]
|
|
if !exists {
|
|
values = []string{}
|
|
}
|
|
out[parts[0]] = append(values, parts[1])
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
func parseKeyValueOpts(opts opts.ListOpts) ([]utils.KeyValuePair, error) {
|
|
out := make([]utils.KeyValuePair, opts.Len())
|
|
for i, o := range opts.GetAll() {
|
|
k, v, err := parsers.ParseKeyValueOpt(o)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
out[i] = utils.KeyValuePair{Key: k, Value: v}
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
func parseNetMode(netMode string) (NetworkMode, error) {
|
|
parts := strings.Split(netMode, ":")
|
|
switch mode := parts[0]; mode {
|
|
case "bridge", "none", "host":
|
|
case "container":
|
|
if len(parts) < 2 || parts[1] == "" {
|
|
return "", fmt.Errorf("invalid container format container:<name|id>")
|
|
}
|
|
default:
|
|
return "", fmt.Errorf("invalid --net: %s", netMode)
|
|
}
|
|
return NetworkMode(netMode), nil
|
|
}
|
|
|
|
func ParseDevice(device string) (DeviceMapping, error) {
|
|
src := ""
|
|
dst := ""
|
|
permissions := "rwm"
|
|
arr := strings.Split(device, ":")
|
|
switch len(arr) {
|
|
case 3:
|
|
permissions = arr[2]
|
|
fallthrough
|
|
case 2:
|
|
dst = arr[1]
|
|
fallthrough
|
|
case 1:
|
|
src = arr[0]
|
|
default:
|
|
return DeviceMapping{}, fmt.Errorf("Invalid device specification: %s", device)
|
|
}
|
|
|
|
if dst == "" {
|
|
dst = src
|
|
}
|
|
|
|
deviceMapping := DeviceMapping{
|
|
PathOnHost: src,
|
|
PathInContainer: dst,
|
|
CgroupPermissions: permissions,
|
|
}
|
|
return deviceMapping, nil
|
|
}
|