Skip to content

Commit db63f93

Browse files
vdemeestervdemeester
committed
Extract daemon configuration and discovery to their own package
This also moves some cli specific in `cmd/dockerd` as it does not really belong to the `daemon/config` package. Signed-off-by: Vincent Demeester <[email protected]>
1 parent 41650df commit db63f93

32 files changed

Lines changed: 885 additions & 733 deletions

‎cmd/dockerd/config.go‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
package main
2+
3+
import (
4+
"github.com/docker/docker/daemon/config"
5+
"github.com/docker/docker/opts"
6+
"github.com/spf13/pflag"
7+
)
8+
9+
const (
10+
// defaultShutdownTimeout is the default shutdown timeout for the daemon
11+
defaultShutdownTimeout = 15
12+
)
13+
14+
// installCommonConfigFlags adds flags to the pflag.FlagSet to configure the daemon
15+
func installCommonConfigFlags(conf *config.Config, flags *pflag.FlagSet) {
16+
var maxConcurrentDownloads, maxConcurrentUploads int
17+
18+
conf.ServiceOptions.InstallCliFlags(flags)
19+
20+
flags.Var(opts.NewNamedListOptsRef("storage-opts", &conf.GraphOptions, nil), "storage-opt", "Storage driver options")
21+
flags.Var(opts.NewNamedListOptsRef("authorization-plugins", &conf.AuthorizationPlugins, nil), "authorization-plugin", "Authorization plugins to load")
22+
flags.Var(opts.NewNamedListOptsRef("exec-opts", &conf.ExecOptions, nil), "exec-opt", "Runtime execution options")
23+
flags.StringVarP(&conf.Pidfile, "pidfile", "p", defaultPidFile, "Path to use for daemon PID file")
24+
flags.StringVarP(&conf.Root, "graph", "g", defaultGraph, "Root of the Docker runtime")
25+
flags.BoolVarP(&conf.AutoRestart, "restart", "r", true, "--restart on the daemon has been deprecated in favor of --restart policies on docker run")
26+
flags.MarkDeprecated("restart", "Please use a restart policy on docker run")
27+
flags.StringVarP(&conf.GraphDriver, "storage-driver", "s", "", "Storage driver to use")
28+
flags.IntVar(&conf.Mtu, "mtu", 0, "Set the containers network MTU")
29+
flags.BoolVar(&conf.RawLogs, "raw-logs", false, "Full timestamps without ANSI coloring")
30+
// FIXME: why the inconsistency between "hosts" and "sockets"?
31+
flags.Var(opts.NewListOptsRef(&conf.DNS, opts.ValidateIPAddress), "dns", "DNS server to use")
32+
flags.Var(opts.NewNamedListOptsRef("dns-opts", &conf.DNSOptions, nil), "dns-opt", "DNS options to use")
33+
flags.Var(opts.NewListOptsRef(&conf.DNSSearch, opts.ValidateDNSSearch), "dns-search", "DNS search domains to use")
34+
flags.Var(opts.NewNamedListOptsRef("labels", &conf.Labels, opts.ValidateLabel), "label", "Set key=value labels to the daemon")
35+
flags.StringVar(&conf.LogConfig.Type, "log-driver", "json-file", "Default driver for container logs")
36+
flags.Var(opts.NewNamedMapOpts("log-opts", conf.LogConfig.Config, nil), "log-opt", "Default log driver options for containers")
37+
flags.StringVar(&conf.ClusterAdvertise, "cluster-advertise", "", "Address or interface name to advertise")
38+
flags.StringVar(&conf.ClusterStore, "cluster-store", "", "URL of the distributed storage backend")
39+
flags.Var(opts.NewNamedMapOpts("cluster-store-opts", conf.ClusterOpts, nil), "cluster-store-opt", "Set cluster store options")
40+
flags.StringVar(&conf.CorsHeaders, "api-cors-header", "", "Set CORS headers in the Engine API")
41+
flags.IntVar(&maxConcurrentDownloads, "max-concurrent-downloads", config.DefaultMaxConcurrentDownloads, "Set the max concurrent downloads for each pull")
42+
flags.IntVar(&maxConcurrentUploads, "max-concurrent-uploads", config.DefaultMaxConcurrentUploads, "Set the max concurrent uploads for each push")
43+
flags.IntVar(&conf.ShutdownTimeout, "shutdown-timeout", defaultShutdownTimeout, "Set the default shutdown timeout")
44+
45+
flags.StringVar(&conf.SwarmDefaultAdvertiseAddr, "swarm-default-advertise-addr", "", "Set default address or interface for swarm advertised address")
46+
flags.BoolVar(&conf.Experimental, "experimental", false, "Enable experimental features")
47+
48+
flags.StringVar(&conf.MetricsAddress, "metrics-addr", "", "Set default address and port to serve the metrics api on")
49+
50+
conf.MaxConcurrentDownloads = &maxConcurrentDownloads
51+
conf.MaxConcurrentUploads = &maxConcurrentUploads
52+
}

‎cmd/dockerd/config_common_unix.go‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// +build solaris linux freebsd
2+
3+
package main
4+
5+
import (
6+
"github.com/docker/docker/api/types"
7+
"github.com/docker/docker/daemon/config"
8+
"github.com/docker/docker/opts"
9+
"github.com/spf13/pflag"
10+
)
11+
12+
var (
13+
defaultPidFile = "/var/run/docker.pid"
14+
defaultGraph = "/var/lib/docker"
15+
defaultExecRoot = "/var/run/docker"
16+
)
17+
18+
// installUnixConfigFlags adds command-line options to the top-level flag parser for
19+
// the current process that are common across Unix platforms.
20+
func installUnixConfigFlags(conf *config.Config, flags *pflag.FlagSet) {
21+
conf.Runtimes = make(map[string]types.Runtime)
22+
23+
flags.StringVarP(&conf.SocketGroup, "group", "G", "docker", "Group for the unix socket")
24+
flags.StringVar(&conf.BridgeConfig.IP, "bip", "", "Specify network bridge IP")
25+
flags.StringVarP(&conf.BridgeConfig.Iface, "bridge", "b", "", "Attach containers to a network bridge")
26+
flags.StringVar(&conf.BridgeConfig.FixedCIDR, "fixed-cidr", "", "IPv4 subnet for fixed IPs")
27+
flags.Var(opts.NewIPOpt(&conf.BridgeConfig.DefaultGatewayIPv4, ""), "default-gateway", "Container default gateway IPv4 address")
28+
flags.Var(opts.NewIPOpt(&conf.BridgeConfig.DefaultGatewayIPv6, ""), "default-gateway-v6", "Container default gateway IPv6 address")
29+
flags.BoolVar(&conf.BridgeConfig.InterContainerCommunication, "icc", true, "Enable inter-container communication")
30+
flags.Var(opts.NewIPOpt(&conf.BridgeConfig.DefaultIP, "0.0.0.0"), "ip", "Default IP when binding container ports")
31+
flags.Var(opts.NewNamedRuntimeOpt("runtimes", &conf.Runtimes, config.StockRuntimeName), "add-runtime", "Register an additional OCI compatible runtime")
32+
flags.StringVar(&conf.DefaultRuntime, "default-runtime", config.StockRuntimeName, "Default OCI runtime for containers")
33+
34+
}

‎cmd/dockerd/config_experimental.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package main
2+
3+
import (
4+
"github.com/docker/docker/daemon/config"
5+
"github.com/spf13/pflag"
6+
)
7+
8+
func attachExperimentalFlags(conf *config.Config, cmd *pflag.FlagSet) {
9+
}

‎cmd/dockerd/config_solaris.go‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package main
2+
3+
import (
4+
"github.com/docker/docker/daemon/config"
5+
runconfigopts "github.com/docker/docker/runconfig/opts"
6+
units "github.com/docker/go-units"
7+
"github.com/spf13/pflag"
8+
)
9+
10+
// installConfigFlags adds flags to the pflag.FlagSet to configure the daemon
11+
func installConfigFlags(conf *config.Config, flags *pflag.FlagSet) {
12+
// First handle install flags which are consistent cross-platform
13+
installCommonConfigFlags(conf, flags)
14+
15+
// Then install flags common to unix platforms
16+
installUnixConfigFlags(conf, flags)
17+
18+
attachExperimentalFlags(conf, flags)
19+
}

‎cmd/dockerd/config_unix.go‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// +build linux,!solaris freebsd,!solaris
2+
3+
package main
4+
5+
import (
6+
"github.com/docker/docker/daemon/config"
7+
"github.com/docker/docker/opts"
8+
units "github.com/docker/go-units"
9+
"github.com/spf13/pflag"
10+
)
11+
12+
// installConfigFlags adds flags to the pflag.FlagSet to configure the daemon
13+
func installConfigFlags(conf *config.Config, flags *pflag.FlagSet) {
14+
// First handle install flags which are consistent cross-platform
15+
installCommonConfigFlags(conf, flags)
16+
17+
// Then install flags common to unix platforms
18+
installUnixConfigFlags(conf, flags)
19+
20+
conf.Ulimits = make(map[string]*units.Ulimit)
21+
22+
// Set default value for `--default-shm-size`
23+
conf.ShmSize = opts.MemBytes(config.DefaultShmSize)
24+
25+
// Then platform-specific install flags
26+
flags.BoolVar(&conf.EnableSelinuxSupport, "selinux-enabled", false, "Enable selinux support")
27+
flags.Var(opts.NewUlimitOpt(&conf.Ulimits), "default-ulimit", "Default ulimits for containers")
28+
flags.BoolVar(&conf.BridgeConfig.EnableIPTables, "iptables", true, "Enable addition of iptables rules")
29+
flags.BoolVar(&conf.BridgeConfig.EnableIPForward, "ip-forward", true, "Enable net.ipv4.ip_forward")
30+
flags.BoolVar(&conf.BridgeConfig.EnableIPMasq, "ip-masq", true, "Enable IP masquerading")
31+
flags.BoolVar(&conf.BridgeConfig.EnableIPv6, "ipv6", false, "Enable IPv6 networking")
32+
flags.StringVar(&conf.ExecRoot, "exec-root", defaultExecRoot, "Root directory for execution state files")
33+
flags.StringVar(&conf.BridgeConfig.FixedCIDRv6, "fixed-cidr-v6", "", "IPv6 subnet for fixed IPs")
34+
flags.BoolVar(&conf.BridgeConfig.EnableUserlandProxy, "userland-proxy", true, "Use userland proxy for loopback traffic")
35+
flags.StringVar(&conf.BridgeConfig.UserlandProxyPath, "userland-proxy-path", "", "Path to the userland proxy binary")
36+
flags.BoolVar(&conf.EnableCors, "api-enable-cors", false, "Enable CORS headers in the Engine API, this is deprecated by --api-cors-header")
37+
flags.MarkDeprecated("api-enable-cors", "Please use --api-cors-header")
38+
flags.StringVar(&conf.CgroupParent, "cgroup-parent", "", "Set parent cgroup for all containers")
39+
flags.StringVar(&conf.RemappedRoot, "userns-remap", "", "User/Group setting for user namespaces")
40+
flags.StringVar(&conf.ContainerdAddr, "containerd", "", "Path to containerd socket")
41+
flags.BoolVar(&conf.LiveRestoreEnabled, "live-restore", false, "Enable live restore of docker when containers are still running")
42+
flags.IntVar(&conf.OOMScoreAdjust, "oom-score-adjust", -500, "Set the oom_score_adj for the daemon")
43+
flags.BoolVar(&conf.Init, "init", false, "Run an init in the container to forward signals and reap processes")
44+
flags.StringVar(&conf.InitPath, "init-path", "", "Path to the docker-init binary")
45+
flags.Int64Var(&conf.CPURealtimePeriod, "cpu-rt-period", 0, "Limit the CPU real-time period in microseconds")
46+
flags.Int64Var(&conf.CPURealtimeRuntime, "cpu-rt-runtime", 0, "Limit the CPU real-time runtime in microseconds")
47+
flags.StringVar(&conf.SeccompProfile, "seccomp-profile", "", "Path to seccomp profile")
48+
flags.Var(&conf.ShmSize, "default-shm-size", "Default shm size for containers")
49+
50+
attachExperimentalFlags(conf, flags)
51+
}

‎cmd/dockerd/config_unix_test.go‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// +build linux,!solaris freebsd,!solaris
2+
3+
package main
4+
5+
import (
6+
"runtime"
7+
"testing"
8+
9+
"github.com/docker/docker/daemon/config"
10+
"github.com/docker/docker/pkg/testutil/assert"
11+
"github.com/spf13/pflag"
12+
)
13+
14+
func TestDaemonParseShmSize(t *testing.T) {
15+
if runtime.GOOS == "solaris" {
16+
t.Skip("ShmSize not supported on Solaris\n")
17+
}
18+
flags := pflag.NewFlagSet("test", pflag.ContinueOnError)
19+
20+
conf := &config.Config{}
21+
installConfigFlags(conf, flags)
22+
// By default `--default-shm-size=64M`
23+
expectedValue := 64 * 1024 * 1024
24+
if conf.ShmSize.Value() != int64(expectedValue) {
25+
t.Fatalf("expected default shm size %d, got %d", expectedValue, conf.ShmSize.Value())
26+
}
27+
assert.NilError(t, flags.Set("default-shm-size", "128M"))
28+
expectedValue = 128 * 1024 * 1024
29+
if conf.ShmSize.Value() != int64(expectedValue) {
30+
t.Fatalf("expected default shm size %d, got %d", expectedValue, conf.ShmSize.Value())
31+
}
32+
}

‎cmd/dockerd/config_windows.go‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
package main
2+
3+
import (
4+
"os"
5+
"path/filepath"
6+
7+
"github.com/docker/docker/daemon/config"
8+
"github.com/spf13/pflag"
9+
)
10+
11+
var (
12+
defaultPidFile string
13+
defaultGraph = filepath.Join(os.Getenv("programdata"), "docker")
14+
)
15+
16+
// installConfigFlags adds flags to the pflag.FlagSet to configure the daemon
17+
func installConfigFlags(conf *config.Config, flags *pflag.FlagSet) {
18+
// First handle install flags which are consistent cross-platform
19+
installCommonConfigFlags(conf, flags)
20+
21+
// Then platform-specific install flags.
22+
flags.StringVar(&conf.BridgeConfig.FixedCIDR, "fixed-cidr", "", "IPv4 subnet for fixed IPs")
23+
flags.StringVarP(&conf.BridgeConfig.Iface, "bridge", "b", "", "Attach containers to a virtual switch")
24+
flags.StringVarP(&conf.SocketGroup, "group", "G", "", "Users or groups that can access the named pipe")
25+
}

‎cmd/dockerd/daemon.go‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import (
3131
cliflags "github.com/docker/docker/cli/flags"
3232
"github.com/docker/docker/daemon"
3333
"github.com/docker/docker/daemon/cluster"
34+
"github.com/docker/docker/daemon/config"
3435
"github.com/docker/docker/daemon/logger"
3536
"github.com/docker/docker/dockerversion"
3637
"github.com/docker/docker/libcontainerd"
@@ -54,7 +55,7 @@ const (
5455

5556
// DaemonCli represents the daemon CLI.
5657
type DaemonCli struct {
57-
*daemon.Config
58+
*config.Config
5859
configFile *string
5960
flags *pflag.FlagSet
6061

@@ -68,7 +69,7 @@ func NewDaemonCli() *DaemonCli {
6869
return &DaemonCli{}
6970
}
7071

71-
func migrateKey(config *daemon.Config) (err error) {
72+
func migrateKey(config *config.Config) (err error) {
7273
// No migration necessary on Windows
7374
if runtime.GOOS == "windows" {
7475
return nil
@@ -335,7 +336,7 @@ func (cli *DaemonCli) start(opts daemonOptions) (err error) {
335336
}
336337

337338
func (cli *DaemonCli) reloadConfig() {
338-
reload := func(config *daemon.Config) {
339+
reload := func(config *config.Config) {
339340

340341
// Revalidate and reload the authorization plugins
341342
if err := validateAuthzPlugins(config.AuthorizationPlugins, cli.d.PluginStore); err != nil {
@@ -363,7 +364,7 @@ func (cli *DaemonCli) reloadConfig() {
363364
}
364365
}
365366

366-
if err := daemon.ReloadConfiguration(*cli.configFile, cli.flags, reload); err != nil {
367+
if err := config.Reload(*cli.configFile, cli.flags, reload); err != nil {
367368
logrus.Error(err)
368369
}
369370
}
@@ -395,24 +396,24 @@ func shutdownDaemon(d *daemon.Daemon) {
395396
}
396397
}
397398

398-
func loadDaemonCliConfig(opts daemonOptions) (*daemon.Config, error) {
399-
config := opts.daemonConfig
399+
func loadDaemonCliConfig(opts daemonOptions) (*config.Config, error) {
400+
conf := opts.daemonConfig
400401
flags := opts.flags
401-
config.Debug = opts.common.Debug
402-
config.Hosts = opts.common.Hosts
403-
config.LogLevel = opts.common.LogLevel
404-
config.TLS = opts.common.TLS
405-
config.TLSVerify = opts.common.TLSVerify
406-
config.CommonTLSOptions = daemon.CommonTLSOptions{}
402+
conf.Debug = opts.common.Debug
403+
conf.Hosts = opts.common.Hosts
404+
conf.LogLevel = opts.common.LogLevel
405+
conf.TLS = opts.common.TLS
406+
conf.TLSVerify = opts.common.TLSVerify
407+
conf.CommonTLSOptions = config.CommonTLSOptions{}
407408

408409
if opts.common.TLSOptions != nil {
409-
config.CommonTLSOptions.CAFile = opts.common.TLSOptions.CAFile
410-
config.CommonTLSOptions.CertFile = opts.common.TLSOptions.CertFile
411-
config.CommonTLSOptions.KeyFile = opts.common.TLSOptions.KeyFile
410+
conf.CommonTLSOptions.CAFile = opts.common.TLSOptions.CAFile
411+
conf.CommonTLSOptions.CertFile = opts.common.TLSOptions.CertFile
412+
conf.CommonTLSOptions.KeyFile = opts.common.TLSOptions.KeyFile
412413
}
413414

414415
if opts.configFile != "" {
415-
c, err := daemon.MergeDaemonConfigurations(config, flags, opts.configFile)
416+
c, err := config.MergeDaemonConfigurations(conf, flags, opts.configFile)
416417
if err != nil {
417418
if flags.Changed(flagDaemonConfigFile) || !os.IsNotExist(err) {
418419
return nil, fmt.Errorf("unable to configure the Docker daemon with file %s: %v\n", opts.configFile, err)
@@ -421,11 +422,11 @@ func loadDaemonCliConfig(opts daemonOptions) (*daemon.Config, error) {
421422
// the merged configuration can be nil if the config file didn't exist.
422423
// leave the current configuration as it is if when that happens.
423424
if c != nil {
424-
config = c
425+
conf = c
425426
}
426427
}
427428

428-
if err := daemon.ValidateConfiguration(config); err != nil {
429+
if err := config.Validate(conf); err != nil {
429430
return nil, err
430431
}
431432

@@ -442,20 +443,20 @@ func loadDaemonCliConfig(opts daemonOptions) (*daemon.Config, error) {
442443
// }
443444
// config.Labels = newLabels
444445
//
445-
if _, err := daemon.GetConflictFreeLabels(config.Labels); err != nil {
446+
if _, err := config.GetConflictFreeLabels(conf.Labels); err != nil {
446447
logrus.Warnf("Engine labels with duplicate keys and conflicting values have been deprecated: %s", err)
447448
}
448449

449450
// Regardless of whether the user sets it to true or false, if they
450451
// specify TLSVerify at all then we need to turn on TLS
451-
if config.IsValueSet(cliflags.FlagTLSVerify) {
452-
config.TLS = true
452+
if conf.IsValueSet(cliflags.FlagTLSVerify) {
453+
conf.TLS = true
453454
}
454455

455456
// ensure that the log level is the one set after merging configurations
456-
cliflags.SetLogLevel(config.LogLevel)
457+
cliflags.SetLogLevel(conf.LogLevel)
457458

458-
return config, nil
459+
return conf, nil
459460
}
460461

461462
func initRouter(s *apiserver.Server, d *daemon.Daemon, c *cluster.Cluster) {

‎cmd/dockerd/daemon_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ import (
55

66
"github.com/Sirupsen/logrus"
77
cliflags "github.com/docker/docker/cli/flags"
8-
"github.com/docker/docker/daemon"
8+
"github.com/docker/docker/daemon/config"
99
"github.com/docker/docker/pkg/testutil/assert"
1010
"github.com/docker/docker/pkg/testutil/tempfile"
1111
"github.com/spf13/pflag"
1212
)
1313

1414
func defaultOptions(configFile string) daemonOptions {
1515
opts := daemonOptions{
16-
daemonConfig: &daemon.Config{},
16+
daemonConfig: &config.Config{},
1717
flags: &pflag.FlagSet{},
1818
common: cliflags.NewCommonOptions(),
1919
}
2020
opts.common.InstallFlags(opts.flags)
21-
opts.daemonConfig.InstallFlags(opts.flags)
21+
installConfigFlags(opts.daemonConfig, opts.flags)
2222
opts.flags.StringVar(&opts.configFile, flagDaemonConfigFile, defaultDaemonConfigFile, "")
2323
opts.configFile = configFile
2424
return opts

0 commit comments

Comments
 (0)