Config fixes.

2024-09-27 06:25:44 +00:00 · 2013-11-19 08:33:12 -07:00
parent 8952c1bd42
commit a414b15f9a
3 changed files with 234 additions and 32 deletions
--- a/server/config.go
+++ b/server/config.go
@@ -19,6 +19,28 @@ import (
 // The default location for the etcd configuration file.
 const DefaultSystemConfigPath = "/etc/etcd/etcd.conf"

+// A lookup of deprecated flags to their new flag name.
+var newFlagNameLookup = map[string]string{
+	"C": "peers",
+	"CF": "peers-file",
+	"n": "name",
+	"c": "addr",
+	"cl": "bind-addr",
+	"s": "peer-addr",
+	"sl": "peer-bind-addr",
+	"d": "data-dir",
+	"m": "max-result-buffer",
+	"r": "max-retry-attempts",
+	"maxsize": "max-cluster-size",
+	"clientCAFile": "ca-file",
+	"clientCert": "cert-file",
+	"clientKey": "key-file",
+	"serverCAFile": "peer-ca-file",
+	"serverCert": "peer-cert-file",
+	"serverKey": "peer-key-file",
+	"snapshotCount": "snapshot-count",
+}
+
 // Config represents the server configuration.
 type Config struct {
 	SystemPath string
@@ -27,8 +49,9 @@ type Config struct {
 	BindAddr         string   `toml:"bind_addr" env:"ETCD_BIND_ADDR"`
 	CAFile           string   `toml:"ca_file" env:"ETCD_CA_FILE"`
 	CertFile         string   `toml:"cert_file" env:"ETCD_CERT_FILE"`
-	CorsOrigins      []string `toml:"cors_origins" env:"ETCD_CORS_ORIGINS"`
+	CorsOrigins      []string `toml:"cors" env:"ETCD_CORS"`
 	DataDir          string   `toml:"data_dir" env:"ETCD_DATA_DIR"`
+	Force            bool
 	KeyFile          string   `toml:"key_file" env:"ETCD_KEY_FILE"`
 	Peers            []string `toml:"peers" env:"ETCD_PEERS"`
 	PeersFile        string   `toml:"peers_file" env:"ETCD_PEERS_FILE"`
@@ -40,7 +63,6 @@ type Config struct {
 	SnapshotCount    int      `toml:"snapshot_count" env:"ETCD_SNAPSHOTCOUNT"`
 	Verbose          bool     `toml:"verbose" env:"ETCD_VERBOSE"`
 	VeryVerbose      bool     `toml:"very_verbose" env:"ETCD_VERY_VERBOSE"`
-	WebURL           string   `toml:"web_url" env:"ETCD_WEB_URL"`

 	Peer struct {
 		Addr     string `toml:"addr" env:"ETCD_PEER_ADDR"`
@@ -95,6 +117,15 @@ func (c *Config) Load(arguments []string) error {
 		return err
 	}

+	// Load from command line flags (deprecated).
+	if err := c.LoadDeprecatedFlags(arguments); err != nil {
+		if err, ok := err.(*DeprecationError); ok {
+			fmt.Fprintln(os.Stderr, err.Error())
+		} else {
+			return err
+		}
+	}
+
 	// Loads peers if a peer file was specified.
 	if err := c.LoadPeersFile(); err != nil {
 		return err
@@ -164,14 +195,65 @@ func (c *Config) loadEnv(target interface{}) error {
 	return nil
 }

+// Loads deprecated configuration settings from the command line.
+func (c *Config) LoadDeprecatedFlags(arguments []string) error {
+	var peers string
+
+	f := flag.NewFlagSet(os.Args[0], flag.ContinueOnError)
+	f.SetOutput(ioutil.Discard)
+
+	f.StringVar(&peers, "C", "", "(deprecated)")
+	f.StringVar(&c.PeersFile, "CF", c.PeersFile, "(deprecated)")
+
+	f.StringVar(&c.Name, "n", c.Name, "(deprecated)")
+	f.StringVar(&c.Addr, "c", c.Addr, "(deprecated)")
+	f.StringVar(&c.BindAddr, "cl", c.BindAddr, "the listening hostname for etcd client communication (defaults to advertised ip)")
+	f.StringVar(&c.Peer.Addr, "s", c.Peer.Addr, "the advertised public hostname:port for raft server communication")
+	f.StringVar(&c.Peer.BindAddr, "sl", c.Peer.BindAddr, "the listening hostname for raft server communication (defaults to advertised ip)")
+
+	f.StringVar(&c.Peer.CAFile, "serverCAFile", c.Peer.CAFile, "the path of the CAFile")
+	f.StringVar(&c.Peer.CertFile, "serverCert", c.Peer.CertFile, "the cert file of the server")
+	f.StringVar(&c.Peer.KeyFile, "serverKey", c.Peer.KeyFile, "the key file of the server")
+
+	f.StringVar(&c.CAFile, "clientCAFile", c.CAFile, "the path of the client CAFile")
+	f.StringVar(&c.CertFile, "clientCert", c.CertFile, "the cert file of the client")
+	f.StringVar(&c.KeyFile, "clientKey", c.KeyFile, "the key file of the client")
+
+	f.StringVar(&c.DataDir, "d", c.DataDir, "the directory to store log and snapshot")
+	f.IntVar(&c.MaxResultBuffer, "m", c.MaxResultBuffer, "the max size of result buffer")
+	f.IntVar(&c.MaxRetryAttempts, "r", c.MaxRetryAttempts, "the max retry attempts when trying to join a cluster")
+	f.IntVar(&c.MaxClusterSize, "maxsize", c.MaxClusterSize, "the max size of the cluster")
+
+	f.IntVar(&c.SnapshotCount, "snapshotCount", c.SnapshotCount, "save the in-memory logs and states to a snapshot file a given number of transactions")
+
+	f.Parse(arguments)
+
+	// Convert some parameters to lists.
+	if peers != "" {
+		c.Peers = trimsplit(peers, ",")
+	}
+
+	// Generate deprecation warning.
+	warnings := make([]string, 0)
+	f.Visit(func(f *flag.Flag) {
+		warnings = append(warnings, fmt.Sprintf("[deprecated] use -%s, not -%s", newFlagNameLookup[f.Name], f.Name))
+	})
+	if len(warnings) > 0 {
+		return &DeprecationError{strings.Join(warnings, "\n")}
+	}
+
+	return nil
+}
+
 // Loads configuration from command line flags.
 func (c *Config) LoadFlags(arguments []string) error {
 	var peers, cors string
-	var force bool

 	f := flag.NewFlagSet(os.Args[0], flag.ContinueOnError)
+	f.SetOutput(ioutil.Discard)

-	f.BoolVar(&force, "force-config", false, "force new node configuration if existing is found (WARNING: data loss!)")
+	f.BoolVar(&c.Force, "f", false, "force new node configuration if existing is found (WARNING: data loss!)")
+	f.BoolVar(&c.Force, "force", false, "force new node configuration if existing is found (WARNING: data loss!)")

 	f.BoolVar(&c.Verbose, "v", c.Verbose, "verbose logging")
 	f.BoolVar(&c.VeryVerbose, "vv", c.Verbose, "very verbose logging")
@@ -184,7 +266,6 @@ func (c *Config) LoadFlags(arguments []string) error {
 	f.StringVar(&c.BindAddr, "bind-addr", c.BindAddr, "the listening hostname for etcd client communication (defaults to advertised ip)")
 	f.StringVar(&c.Peer.Addr, "peer-addr", c.Peer.Addr, "the advertised public hostname:port for raft server communication")
 	f.StringVar(&c.Peer.BindAddr, "peer-bind-addr", c.Peer.BindAddr, "the listening hostname for raft server communication (defaults to advertised ip)")
-	f.StringVar(&c.WebURL, "web-url", c.WebURL, "the hostname:port of web interface")

 	f.StringVar(&c.Peer.CAFile, "peer-ca-file", c.Peer.CAFile, "the path of the CAFile")
 	f.StringVar(&c.Peer.CertFile, "peer-cert-file", c.Peer.CertFile, "the cert file of the server")
@@ -198,7 +279,7 @@ func (c *Config) LoadFlags(arguments []string) error {
 	f.IntVar(&c.MaxResultBuffer, "max-result-buffer", c.MaxResultBuffer, "the max size of result buffer")
 	f.IntVar(&c.MaxRetryAttempts, "max-retry-attempts", c.MaxRetryAttempts, "the max retry attempts when trying to join a cluster")
 	f.IntVar(&c.MaxClusterSize, "max-cluster-size", c.MaxClusterSize, "the max size of the cluster")
-	f.StringVar(&cors, "cors-origins", "", "whitelist origins for cross-origin resource sharing (e.g. '*' or 'http://localhost:8001,etc')")
+	f.StringVar(&cors, "cors", "", "whitelist origins for cross-origin resource sharing (e.g. '*' or 'http://localhost:8001,etc')")

 	f.BoolVar(&c.Snapshot, "snapshot", c.Snapshot, "open or close snapshot")
 	f.IntVar(&c.SnapshotCount, "snapshot-count", c.SnapshotCount, "save the in-memory logs and states to a snapshot file a given number of transactions")
@@ -218,7 +299,7 @@ func (c *Config) LoadFlags(arguments []string) error {
 	}

 	// Force remove server configuration if specified.
-	if force {
+	if c.Force {
 		c.Reset()
 	}

@@ -281,7 +362,6 @@ func (c *Config) Info() (*Info, error) {
 	info.EtcdListenHost = c.BindAddr
 	info.RaftURL = c.Peer.Addr
 	info.RaftListenHost = c.Peer.BindAddr
-	info.WebURL = c.WebURL
 	info.EtcdTLS = c.TLSInfo()
 	info.RaftTLS = c.PeerTLSInfo()

@@ -318,9 +398,6 @@ func (c *Config) Sanitize() error {
 	if c.BindAddr, err = sanitizeBindAddr(c.BindAddr, c.Addr); err != nil {
 		return fmt.Errorf("Listen Host: %s", err)
 	}
-	if c.WebURL, err = sanitizeURL(c.WebURL, "http"); err != nil {
-		return fmt.Errorf("Web URL: %s", err)
-	}
 	if c.Peer.Addr, err = sanitizeURL(c.Peer.Addr, peerTlsConfig.Scheme); err != nil {
 		return fmt.Errorf("Peer Advertised URL: %s", err)
 	}
@@ -402,3 +479,15 @@ func sanitizeBindAddr(bindAddr string, addr string) (string, error) {

 	return net.JoinHostPort(bindAddr, aport), nil
 }
+
+
+// DeprecationError is a warning for CLI users that one or more arguments will
+// not be supported in future released.
+type DeprecationError struct {
+	s string
+}
+
+func (e *DeprecationError) Error() string {
+	return e.s
+}
+
--- a/server/config_test.go
+++ b/server/config_test.go
@@ -15,7 +15,7 @@ func TestConfigTOML(t *testing.T) {
 		addr = "127.0.0.1:4002"
 		ca_file = "/tmp/file.ca"
 		cert_file = "/tmp/file.cert"
-		cors_origins = ["*"]
+		cors = ["*"]
 		cpu_profile_file = "XXX"
 		data_dir = "/tmp/data"
 		key_file = "/tmp/file.key"
@@ -57,7 +57,6 @@ func TestConfigTOML(t *testing.T) {
 	assert.Equal(t, c.Snapshot, true, "")
 	assert.Equal(t, c.Verbose, true, "")
 	assert.Equal(t, c.VeryVerbose, true, "")
-	assert.Equal(t, c.WebURL, "/web", "")
 	assert.Equal(t, c.Peer.Addr, "127.0.0.1:7002", "")
 	assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
 	assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
@@ -70,7 +69,7 @@ func TestConfigEnv(t *testing.T) {
 	os.Setenv("ETCD_CA_FILE", "/tmp/file.ca")
 	os.Setenv("ETCD_CERT_FILE", "/tmp/file.cert")
 	os.Setenv("ETCD_CPU_PROFILE_FILE", "XXX")
-	os.Setenv("ETCD_CORS_ORIGINS", "localhost:4001,localhost:4002")
+	os.Setenv("ETCD_CORS", "localhost:4001,localhost:4002")
 	os.Setenv("ETCD_DATA_DIR", "/tmp/data")
 	os.Setenv("ETCD_KEY_FILE", "/tmp/file.key")
 	os.Setenv("ETCD_BIND_ADDR", "127.0.0.1:4003")
@@ -94,7 +93,7 @@ func TestConfigEnv(t *testing.T) {
 	c.LoadEnv()
 	assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
 	assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
-	assert.Equal(t, c.CorsOrigins, []string{"localhost:4001", "localhost:4002"}, "")
+	assert.Equal(t, c.CorsOrigins, []string{"localhost:4001", "localhost:4002"}, "") 
 	assert.Equal(t, c.DataDir, "/tmp/data", "")
 	assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
 	assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
@@ -107,7 +106,6 @@ func TestConfigEnv(t *testing.T) {
 	assert.Equal(t, c.Snapshot, true, "")
 	assert.Equal(t, c.Verbose, true, "")
 	assert.Equal(t, c.VeryVerbose, true, "")
-	assert.Equal(t, c.WebURL, "/web", "")
 	assert.Equal(t, c.Peer.Addr, "127.0.0.1:7002", "")
 	assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
 	assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
@@ -115,6 +113,20 @@ func TestConfigEnv(t *testing.T) {
 	assert.Equal(t, c.Peer.BindAddr, "127.0.0.1:7003", "")
 }

+// Ensures that the "force config" flag can be parsed.
+func TestConfigForceFlag(t *testing.T) {
+	c := NewConfig()
+	assert.Nil(t, c.LoadFlags([]string{"-force"}), "")
+	assert.True(t, c.Force)
+}
+
+// Ensures that the abbreviated "force config" flag can be parsed.
+func TestConfigAbbreviatedForceFlag(t *testing.T) {
+	c := NewConfig()
+	assert.Nil(t, c.LoadFlags([]string{"-f"}), "")
+	assert.True(t, c.Force)
+}
+
 // Ensures that a the advertised url can be parsed from the environment.
 func TestConfigAddrEnv(t *testing.T) {
 	withEnv("ETCD_ADDR", "127.0.0.1:4002", func(c *Config) {
@@ -325,21 +337,6 @@ func TestConfigVeryVerboseFlag(t *testing.T) {
 	assert.Equal(t, c.VeryVerbose, true, "")
 }

-// Ensures that Web URL can be parsed from the environment.
-func TestConfigWebURLEnv(t *testing.T) {
-	withEnv("ETCD_WEB_URL", "/web", func(c *Config) {
-		assert.Nil(t, c.LoadEnv(), "")
-		assert.Equal(t, c.WebURL, "/web", "")
-	})
-}
-
-// Ensures that a the Web URL flag can be parsed.
-func TestConfigWebURLFlag(t *testing.T) {
-	c := NewConfig()
-	assert.Nil(t, c.LoadFlags([]string{"-web-url", "/web"}), "")
-	assert.Equal(t, c.WebURL, "/web", "")
-}
-
 // Ensures that the Peer Advertised URL can be parsed from the environment.
 func TestConfigPeerAddrEnv(t *testing.T) {
 	withEnv("ETCD_PEER_ADDR", "localhost:7002", func(c *Config) {
@@ -454,6 +451,123 @@ func TestConfigCLIArgsOverrideEnvVar(t *testing.T) {
 	assert.Equal(t, c.Addr, "http://127.0.0.1:2000", "")
 }

+//--------------------------------------
+// DEPRECATED (v1)
+//--------------------------------------
+
+func TestConfigDeprecatedAddrFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-c", "127.0.0.1:4002"})
+	assert.Equal(t, err.Error(), "[deprecated] use -addr, not -c", "")
+	assert.Equal(t, c.Addr, "127.0.0.1:4002", "")
+}
+
+func TestConfigDeprecatedBindAddrFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-cl", "127.0.0.1:4003"})
+	assert.Equal(t, err.Error(), "[deprecated] use -bind-addr, not -cl", "")
+	assert.Equal(t, c.BindAddr, "127.0.0.1:4003", "")
+}
+
+func TestConfigDeprecatedCAFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-clientCAFile", "/tmp/file.ca"})
+	assert.Equal(t, err.Error(), "[deprecated] use -ca-file, not -clientCAFile", "")
+	assert.Equal(t, c.CAFile, "/tmp/file.ca", "")
+}
+
+func TestConfigDeprecatedCertFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-clientCert", "/tmp/file.cert"})
+	assert.Equal(t, err.Error(), "[deprecated] use -cert-file, not -clientCert", "")
+	assert.Equal(t, c.CertFile, "/tmp/file.cert", "")
+}
+
+func TestConfigDeprecatedKeyFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-clientKey", "/tmp/file.key"})
+	assert.Equal(t, err.Error(), "[deprecated] use -key-file, not -clientKey", "")
+	assert.Equal(t, c.KeyFile, "/tmp/file.key", "")
+}
+
+func TestConfigDeprecatedPeersFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-C", "coreos.com:4001,coreos.com:4002"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peers, not -C", "")
+	assert.Equal(t, c.Peers, []string{"coreos.com:4001", "coreos.com:4002"}, "")
+}
+
+func TestConfigDeprecatedPeersFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-CF", "/tmp/machines"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peers-file, not -CF", "")
+	assert.Equal(t, c.PeersFile, "/tmp/machines", "")
+}
+
+func TestConfigDeprecatedMaxClusterSizeFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-maxsize", "5"})
+	assert.Equal(t, err.Error(), "[deprecated] use -max-cluster-size, not -maxsize", "")
+	assert.Equal(t, c.MaxClusterSize, 5, "")
+}
+
+func TestConfigDeprecatedMaxResultBufferFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-m", "512"})
+	assert.Equal(t, err.Error(), "[deprecated] use -max-result-buffer, not -m", "")
+	assert.Equal(t, c.MaxResultBuffer, 512, "")
+}
+
+func TestConfigDeprecatedMaxRetryAttemptsFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-r", "10"})
+	assert.Equal(t, err.Error(), "[deprecated] use -max-retry-attempts, not -r", "")
+	assert.Equal(t, c.MaxRetryAttempts, 10, "")
+}
+
+func TestConfigDeprecatedNameFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-n", "test-name"})
+	assert.Equal(t, err.Error(), "[deprecated] use -name, not -n", "")
+	assert.Equal(t, c.Name, "test-name", "")
+}
+
+func TestConfigDeprecatedPeerAddrFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-s", "localhost:7002"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peer-addr, not -s", "")
+	assert.Equal(t, c.Peer.Addr, "localhost:7002", "")
+}
+
+func TestConfigDeprecatedPeerBindAddrFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-sl", "127.0.0.1:4003"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peer-bind-addr, not -sl", "")
+	assert.Equal(t, c.Peer.BindAddr, "127.0.0.1:4003", "")
+}
+
+func TestConfigDeprecatedPeerCAFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-serverCAFile", "/tmp/peer/file.ca"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peer-ca-file, not -serverCAFile", "")
+	assert.Equal(t, c.Peer.CAFile, "/tmp/peer/file.ca", "")
+}
+
+func TestConfigDeprecatedPeerCertFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-serverCert", "/tmp/peer/file.cert"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peer-cert-file, not -serverCert", "")
+	assert.Equal(t, c.Peer.CertFile, "/tmp/peer/file.cert", "")
+}
+
+func TestConfigDeprecatedPeerKeyFileFlag(t *testing.T) {
+	c := NewConfig()
+	err := c.LoadDeprecatedFlags([]string{"-serverKey", "/tmp/peer/file.key"})
+	assert.Equal(t, err.Error(), "[deprecated] use -peer-key-file, not -serverKey", "")
+	assert.Equal(t, c.Peer.KeyFile, "/tmp/peer/file.key", "")
+}
+
+
 //--------------------------------------
 // Helpers
 //--------------------------------------
--- a/server/info.go
+++ b/server/info.go
@@ -8,7 +8,6 @@ type Info struct {

 	RaftURL string `json:"raftURL"`
 	EtcdURL string `json:"etcdURL"`
-	WebURL  string `json:"webURL"`

 	RaftListenHost string `json:"raftListenHost"`
 	EtcdListenHost string `json:"etcdListenHost"`