github.com/mhy12345/docker@v1.12.3/daemon/config_unix.go (about)

     1  // +build linux freebsd
     2  
     3  package daemon
     4  
     5  import (
     6  	"fmt"
     7  	"net"
     8  
     9  	"github.com/docker/docker/opts"
    10  	flag "github.com/docker/docker/pkg/mflag"
    11  	runconfigopts "github.com/docker/docker/runconfig/opts"
    12  	"github.com/docker/engine-api/types"
    13  	"github.com/docker/go-units"
    14  )
    15  
    16  var (
    17  	defaultPidFile  = "/var/run/docker.pid"
    18  	defaultGraph    = "/var/lib/docker"
    19  	defaultExecRoot = "/var/run/docker"
    20  )
    21  
    22  // Config defines the configuration of a docker daemon.
    23  // It includes json tags to deserialize configuration from a file
    24  // using the same names that the flags in the command line uses.
    25  type Config struct {
    26  	CommonConfig
    27  
    28  	// Fields below here are platform specific.
    29  	CgroupParent         string                   `json:"cgroup-parent,omitempty"`
    30  	ContainerdAddr       string                   `json:"containerd,omitempty"`
    31  	EnableSelinuxSupport bool                     `json:"selinux-enabled,omitempty"`
    32  	ExecRoot             string                   `json:"exec-root,omitempty"`
    33  	RemappedRoot         string                   `json:"userns-remap,omitempty"`
    34  	Ulimits              map[string]*units.Ulimit `json:"default-ulimits,omitempty"`
    35  	Runtimes             map[string]types.Runtime `json:"runtimes,omitempty"`
    36  	DefaultRuntime       string                   `json:"default-runtime,omitempty"`
    37  	OOMScoreAdjust       int                      `json:"oom-score-adjust,omitempty"`
    38  }
    39  
    40  // bridgeConfig stores all the bridge driver specific
    41  // configuration.
    42  type bridgeConfig struct {
    43  	commonBridgeConfig
    44  
    45  	// Fields below here are platform specific.
    46  	EnableIPv6                  bool   `json:"ipv6,omitempty"`
    47  	EnableIPTables              bool   `json:"iptables,omitempty"`
    48  	EnableIPForward             bool   `json:"ip-forward,omitempty"`
    49  	EnableIPMasq                bool   `json:"ip-masq,omitempty"`
    50  	EnableUserlandProxy         bool   `json:"userland-proxy,omitempty"`
    51  	DefaultIP                   net.IP `json:"ip,omitempty"`
    52  	IP                          string `json:"bip,omitempty"`
    53  	FixedCIDRv6                 string `json:"fixed-cidr-v6,omitempty"`
    54  	DefaultGatewayIPv4          net.IP `json:"default-gateway,omitempty"`
    55  	DefaultGatewayIPv6          net.IP `json:"default-gateway-v6,omitempty"`
    56  	InterContainerCommunication bool   `json:"icc,omitempty"`
    57  }
    58  
    59  // InstallFlags adds command-line options to the top-level flag parser for
    60  // the current process.
    61  // Subsequent calls to `flag.Parse` will populate config with values parsed
    62  // from the command-line.
    63  func (config *Config) InstallFlags(cmd *flag.FlagSet, usageFn func(string) string) {
    64  	// First handle install flags which are consistent cross-platform
    65  	config.InstallCommonFlags(cmd, usageFn)
    66  
    67  	// Then platform-specific install flags
    68  	cmd.BoolVar(&config.EnableSelinuxSupport, []string{"-selinux-enabled"}, false, usageFn("Enable selinux support"))
    69  	cmd.StringVar(&config.SocketGroup, []string{"G", "-group"}, "docker", usageFn("Group for the unix socket"))
    70  	config.Ulimits = make(map[string]*units.Ulimit)
    71  	cmd.Var(runconfigopts.NewUlimitOpt(&config.Ulimits), []string{"-default-ulimit"}, usageFn("Default ulimits for containers"))
    72  	cmd.BoolVar(&config.bridgeConfig.EnableIPTables, []string{"#iptables", "-iptables"}, true, usageFn("Enable addition of iptables rules"))
    73  	cmd.BoolVar(&config.bridgeConfig.EnableIPForward, []string{"#ip-forward", "-ip-forward"}, true, usageFn("Enable net.ipv4.ip_forward"))
    74  	cmd.BoolVar(&config.bridgeConfig.EnableIPMasq, []string{"-ip-masq"}, true, usageFn("Enable IP masquerading"))
    75  	cmd.BoolVar(&config.bridgeConfig.EnableIPv6, []string{"-ipv6"}, false, usageFn("Enable IPv6 networking"))
    76  	cmd.StringVar(&config.ExecRoot, []string{"-exec-root"}, defaultExecRoot, usageFn("Root directory for execution state files"))
    77  	cmd.StringVar(&config.bridgeConfig.IP, []string{"#bip", "-bip"}, "", usageFn("Specify network bridge IP"))
    78  	cmd.StringVar(&config.bridgeConfig.Iface, []string{"b", "-bridge"}, "", usageFn("Attach containers to a network bridge"))
    79  	cmd.StringVar(&config.bridgeConfig.FixedCIDR, []string{"-fixed-cidr"}, "", usageFn("IPv4 subnet for fixed IPs"))
    80  	cmd.StringVar(&config.bridgeConfig.FixedCIDRv6, []string{"-fixed-cidr-v6"}, "", usageFn("IPv6 subnet for fixed IPs"))
    81  	cmd.Var(opts.NewIPOpt(&config.bridgeConfig.DefaultGatewayIPv4, ""), []string{"-default-gateway"}, usageFn("Container default gateway IPv4 address"))
    82  	cmd.Var(opts.NewIPOpt(&config.bridgeConfig.DefaultGatewayIPv6, ""), []string{"-default-gateway-v6"}, usageFn("Container default gateway IPv6 address"))
    83  	cmd.BoolVar(&config.bridgeConfig.InterContainerCommunication, []string{"#icc", "-icc"}, true, usageFn("Enable inter-container communication"))
    84  	cmd.Var(opts.NewIPOpt(&config.bridgeConfig.DefaultIP, "0.0.0.0"), []string{"#ip", "-ip"}, usageFn("Default IP when binding container ports"))
    85  	cmd.BoolVar(&config.bridgeConfig.EnableUserlandProxy, []string{"-userland-proxy"}, true, usageFn("Use userland proxy for loopback traffic"))
    86  	cmd.BoolVar(&config.EnableCors, []string{"#api-enable-cors", "#-api-enable-cors"}, false, usageFn("Enable CORS headers in the remote API, this is deprecated by --api-cors-header"))
    87  	cmd.StringVar(&config.CgroupParent, []string{"-cgroup-parent"}, "", usageFn("Set parent cgroup for all containers"))
    88  	cmd.StringVar(&config.RemappedRoot, []string{"-userns-remap"}, "", usageFn("User/Group setting for user namespaces"))
    89  	cmd.StringVar(&config.ContainerdAddr, []string{"-containerd"}, "", usageFn("Path to containerd socket"))
    90  	cmd.BoolVar(&config.LiveRestore, []string{"-live-restore"}, false, usageFn("Enable live restore of docker when containers are still running"))
    91  	config.Runtimes = make(map[string]types.Runtime)
    92  	cmd.Var(runconfigopts.NewNamedRuntimeOpt("runtimes", &config.Runtimes, stockRuntimeName), []string{"-add-runtime"}, usageFn("Register an additional OCI compatible runtime"))
    93  	cmd.StringVar(&config.DefaultRuntime, []string{"-default-runtime"}, stockRuntimeName, usageFn("Default OCI runtime for containers"))
    94  	cmd.IntVar(&config.OOMScoreAdjust, []string{"-oom-score-adjust"}, -500, usageFn("Set the oom_score_adj for the daemon"))
    95  
    96  	config.attachExperimentalFlags(cmd, usageFn)
    97  }
    98  
    99  // GetRuntime returns the runtime path and arguments for a given
   100  // runtime name
   101  func (config *Config) GetRuntime(name string) *types.Runtime {
   102  	config.reloadLock.Lock()
   103  	defer config.reloadLock.Unlock()
   104  	if rt, ok := config.Runtimes[name]; ok {
   105  		return &rt
   106  	}
   107  	return nil
   108  }
   109  
   110  // GetDefaultRuntimeName returns the current default runtime
   111  func (config *Config) GetDefaultRuntimeName() string {
   112  	config.reloadLock.Lock()
   113  	rt := config.DefaultRuntime
   114  	config.reloadLock.Unlock()
   115  
   116  	return rt
   117  }
   118  
   119  // GetAllRuntimes returns a copy of the runtimes map
   120  func (config *Config) GetAllRuntimes() map[string]types.Runtime {
   121  	config.reloadLock.Lock()
   122  	rts := config.Runtimes
   123  	config.reloadLock.Unlock()
   124  	return rts
   125  }
   126  
   127  // GetExecRoot returns the user configured Exec-root
   128  func (config *Config) GetExecRoot() string {
   129  	return config.ExecRoot
   130  }
   131  
   132  func (config *Config) isSwarmCompatible() error {
   133  	if config.ClusterStore != "" || config.ClusterAdvertise != "" {
   134  		return fmt.Errorf("--cluster-store and --cluster-advertise daemon configurations are incompatible with swarm mode")
   135  	}
   136  	if config.LiveRestore {
   137  		return fmt.Errorf("--live-restore daemon configuration is incompatible with swarm mode")
   138  	}
   139  	return nil
   140  }