apiserver: separate transport setting from storagebackend.Config

Kubernetes-commit: 7b242533a217bd809e2c846c3e3fadf7bf6edee8
This commit is contained in:
Dr. Stefan Schimanski 2018-09-12 10:59:01 +02:00 committed by Kubernetes Publisher
parent fdeb778d73
commit 7d47897b55
8 changed files with 82 additions and 61 deletions

View File

@ -81,7 +81,7 @@ func (s *EtcdOptions) Validate() []error {
} }
allErrors := []error{} allErrors := []error{}
if len(s.StorageConfig.ServerList) == 0 { if len(s.StorageConfig.Transport.ServerList) == 0 {
allErrors = append(allErrors, fmt.Errorf("--etcd-servers must be specified")) allErrors = append(allErrors, fmt.Errorf("--etcd-servers must be specified"))
} }
@ -148,19 +148,19 @@ func (s *EtcdOptions) AddFlags(fs *pflag.FlagSet) {
fs.IntVar(&dummyCacheSize, "deserialization-cache-size", 0, "Number of deserialized json objects to cache in memory.") fs.IntVar(&dummyCacheSize, "deserialization-cache-size", 0, "Number of deserialized json objects to cache in memory.")
fs.MarkDeprecated("deserialization-cache-size", "the deserialization cache was dropped in 1.13 with support for etcd2") fs.MarkDeprecated("deserialization-cache-size", "the deserialization cache was dropped in 1.13 with support for etcd2")
fs.StringSliceVar(&s.StorageConfig.ServerList, "etcd-servers", s.StorageConfig.ServerList, fs.StringSliceVar(&s.StorageConfig.Transport.ServerList, "etcd-servers", s.StorageConfig.Transport.ServerList,
"List of etcd servers to connect with (scheme://ip:port), comma separated.") "List of etcd servers to connect with (scheme://ip:port), comma separated.")
fs.StringVar(&s.StorageConfig.Prefix, "etcd-prefix", s.StorageConfig.Prefix, fs.StringVar(&s.StorageConfig.Prefix, "etcd-prefix", s.StorageConfig.Prefix,
"The prefix to prepend to all resource paths in etcd.") "The prefix to prepend to all resource paths in etcd.")
fs.StringVar(&s.StorageConfig.KeyFile, "etcd-keyfile", s.StorageConfig.KeyFile, fs.StringVar(&s.StorageConfig.Transport.KeyFile, "etcd-keyfile", s.StorageConfig.Transport.KeyFile,
"SSL key file used to secure etcd communication.") "SSL key file used to secure etcd communication.")
fs.StringVar(&s.StorageConfig.CertFile, "etcd-certfile", s.StorageConfig.CertFile, fs.StringVar(&s.StorageConfig.Transport.CertFile, "etcd-certfile", s.StorageConfig.Transport.CertFile,
"SSL certification file used to secure etcd communication.") "SSL certification file used to secure etcd communication.")
fs.StringVar(&s.StorageConfig.CAFile, "etcd-cafile", s.StorageConfig.CAFile, fs.StringVar(&s.StorageConfig.Transport.CAFile, "etcd-cafile", s.StorageConfig.Transport.CAFile,
"SSL Certificate Authority file used to secure etcd communication.") "SSL Certificate Authority file used to secure etcd communication.")
fs.StringVar(&s.EncryptionProviderConfigFilepath, "experimental-encryption-provider-config", s.EncryptionProviderConfigFilepath, fs.StringVar(&s.EncryptionProviderConfigFilepath, "experimental-encryption-provider-config", s.EncryptionProviderConfigFilepath,

View File

@ -36,12 +36,14 @@ func TestEtcdOptionsValidate(t *testing.T) {
name: "test when ServerList is not specified", name: "test when ServerList is not specified",
testOptions: &EtcdOptions{ testOptions: &EtcdOptions{
StorageConfig: storagebackend.Config{ StorageConfig: storagebackend.Config{
Type: "etcd3", Type: "etcd3",
ServerList: nil, Prefix: "/registry",
Prefix: "/registry", Transport: storagebackend.TransportConfig{
KeyFile: "/var/run/kubernetes/etcd.key", ServerList: nil,
CAFile: "/var/run/kubernetes/etcdca.crt", KeyFile: "/var/run/kubernetes/etcd.key",
CertFile: "/var/run/kubernetes/etcdce.crt", CAFile: "/var/run/kubernetes/etcdca.crt",
CertFile: "/var/run/kubernetes/etcdce.crt",
},
CompactionInterval: storagebackend.DefaultCompactInterval, CompactionInterval: storagebackend.DefaultCompactInterval,
CountMetricPollPeriod: time.Minute, CountMetricPollPeriod: time.Minute,
}, },
@ -58,12 +60,14 @@ func TestEtcdOptionsValidate(t *testing.T) {
name: "test when storage-backend is invalid", name: "test when storage-backend is invalid",
testOptions: &EtcdOptions{ testOptions: &EtcdOptions{
StorageConfig: storagebackend.Config{ StorageConfig: storagebackend.Config{
Type: "etcd4", Type: "etcd4",
ServerList: []string{"http://127.0.0.1"}, Prefix: "/registry",
Prefix: "/registry", Transport: storagebackend.TransportConfig{
KeyFile: "/var/run/kubernetes/etcd.key", ServerList: []string{"http://127.0.0.1"},
CAFile: "/var/run/kubernetes/etcdca.crt", KeyFile: "/var/run/kubernetes/etcd.key",
CertFile: "/var/run/kubernetes/etcdce.crt", CAFile: "/var/run/kubernetes/etcdca.crt",
CertFile: "/var/run/kubernetes/etcdce.crt",
},
CompactionInterval: storagebackend.DefaultCompactInterval, CompactionInterval: storagebackend.DefaultCompactInterval,
CountMetricPollPeriod: time.Minute, CountMetricPollPeriod: time.Minute,
}, },
@ -80,12 +84,14 @@ func TestEtcdOptionsValidate(t *testing.T) {
name: "test when etcd-servers-overrides is invalid", name: "test when etcd-servers-overrides is invalid",
testOptions: &EtcdOptions{ testOptions: &EtcdOptions{
StorageConfig: storagebackend.Config{ StorageConfig: storagebackend.Config{
Type: "etcd3", Type: "etcd3",
ServerList: []string{"http://127.0.0.1"}, Transport: storagebackend.TransportConfig{
ServerList: []string{"http://127.0.0.1"},
KeyFile: "/var/run/kubernetes/etcd.key",
CAFile: "/var/run/kubernetes/etcdca.crt",
CertFile: "/var/run/kubernetes/etcdce.crt",
},
Prefix: "/registry", Prefix: "/registry",
KeyFile: "/var/run/kubernetes/etcd.key",
CAFile: "/var/run/kubernetes/etcdca.crt",
CertFile: "/var/run/kubernetes/etcdce.crt",
CompactionInterval: storagebackend.DefaultCompactInterval, CompactionInterval: storagebackend.DefaultCompactInterval,
CountMetricPollPeriod: time.Minute, CountMetricPollPeriod: time.Minute,
}, },
@ -102,12 +108,14 @@ func TestEtcdOptionsValidate(t *testing.T) {
name: "test when EtcdOptions is valid", name: "test when EtcdOptions is valid",
testOptions: &EtcdOptions{ testOptions: &EtcdOptions{
StorageConfig: storagebackend.Config{ StorageConfig: storagebackend.Config{
Type: "etcd3", Type: "etcd3",
ServerList: []string{"http://127.0.0.1"}, Prefix: "/registry",
Prefix: "/registry", Transport: storagebackend.TransportConfig{
KeyFile: "/var/run/kubernetes/etcd.key", ServerList: []string{"http://127.0.0.1"},
CAFile: "/var/run/kubernetes/etcdca.crt", KeyFile: "/var/run/kubernetes/etcd.key",
CertFile: "/var/run/kubernetes/etcdce.crt", CAFile: "/var/run/kubernetes/etcdca.crt",
CertFile: "/var/run/kubernetes/etcdce.crt",
},
CompactionInterval: storagebackend.DefaultCompactInterval, CompactionInterval: storagebackend.DefaultCompactInterval,
CountMetricPollPeriod: time.Minute, CountMetricPollPeriod: time.Minute,
}, },

View File

@ -121,7 +121,7 @@ type groupResourceOverrides struct {
// Apply overrides the provided config and options if the override has a value in that position // Apply overrides the provided config and options if the override has a value in that position
func (o groupResourceOverrides) Apply(config *storagebackend.Config, options *StorageCodecConfig) { func (o groupResourceOverrides) Apply(config *storagebackend.Config, options *StorageCodecConfig) {
if len(o.etcdLocation) > 0 { if len(o.etcdLocation) > 0 {
config.ServerList = o.etcdLocation config.Transport.ServerList = o.etcdLocation
} }
if len(o.etcdPrefix) > 0 { if len(o.etcdPrefix) > 0 {
config.Prefix = o.etcdPrefix config.Prefix = o.etcdPrefix
@ -290,7 +290,7 @@ func (s *DefaultStorageFactory) NewConfig(groupResource schema.GroupResource) (*
// Backends returns all backends for all registered storage destinations. // Backends returns all backends for all registered storage destinations.
// Used for getting all instances for health validations. // Used for getting all instances for health validations.
func (s *DefaultStorageFactory) Backends() []Backend { func (s *DefaultStorageFactory) Backends() []Backend {
servers := sets.NewString(s.StorageConfig.ServerList...) servers := sets.NewString(s.StorageConfig.Transport.ServerList...)
for _, overrides := range s.Overrides { for _, overrides := range s.Overrides {
servers.Insert(overrides.etcdLocation...) servers.Insert(overrides.etcdLocation...)
@ -299,16 +299,16 @@ func (s *DefaultStorageFactory) Backends() []Backend {
tlsConfig := &tls.Config{ tlsConfig := &tls.Config{
InsecureSkipVerify: true, InsecureSkipVerify: true,
} }
if len(s.StorageConfig.CertFile) > 0 && len(s.StorageConfig.KeyFile) > 0 { if len(s.StorageConfig.Transport.CertFile) > 0 && len(s.StorageConfig.Transport.KeyFile) > 0 {
cert, err := tls.LoadX509KeyPair(s.StorageConfig.CertFile, s.StorageConfig.KeyFile) cert, err := tls.LoadX509KeyPair(s.StorageConfig.Transport.CertFile, s.StorageConfig.Transport.KeyFile)
if err != nil { if err != nil {
klog.Errorf("failed to load key pair while getting backends: %s", err) klog.Errorf("failed to load key pair while getting backends: %s", err)
} else { } else {
tlsConfig.Certificates = []tls.Certificate{cert} tlsConfig.Certificates = []tls.Certificate{cert}
} }
} }
if len(s.StorageConfig.CAFile) > 0 { if len(s.StorageConfig.Transport.CAFile) > 0 {
if caCert, err := ioutil.ReadFile(s.StorageConfig.CAFile); err != nil { if caCert, err := ioutil.ReadFile(s.StorageConfig.Transport.CAFile); err != nil {
klog.Errorf("failed to read ca file while getting backends: %s", err) klog.Errorf("failed to read ca file while getting backends: %s", err)
} else { } else {
caPool := x509.NewCertPool() caPool := x509.NewCertPool()

View File

@ -104,7 +104,7 @@ func TestConfigurableStorageFactory(t *testing.T) {
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
if config.Prefix != "/prefix_for_test" || !reflect.DeepEqual(config.ServerList, []string{"/server2"}) { if config.Prefix != "/prefix_for_test" || !reflect.DeepEqual(config.Transport.ServerList, []string{"/server2"}) {
t.Errorf("unexpected config %#v", config) t.Errorf("unexpected config %#v", config)
} }
if !called { if !called {
@ -136,8 +136,10 @@ func TestUpdateEtcdOverrides(t *testing.T) {
defaultEtcdLocation := []string{"http://127.0.0.1"} defaultEtcdLocation := []string{"http://127.0.0.1"}
for i, test := range testCases { for i, test := range testCases {
defaultConfig := storagebackend.Config{ defaultConfig := storagebackend.Config{
Prefix: "/registry", Prefix: "/registry",
ServerList: defaultEtcdLocation, Transport: storagebackend.TransportConfig{
ServerList: defaultEtcdLocation,
},
} }
storageFactory := NewDefaultStorageFactory(defaultConfig, "", codecs, NewDefaultResourceEncodingConfig(scheme), NewResourceConfig(), nil) storageFactory := NewDefaultStorageFactory(defaultConfig, "", codecs, NewDefaultResourceEncodingConfig(scheme), NewResourceConfig(), nil)
storageFactory.SetEtcdLocation(test.resource, test.servers) storageFactory.SetEtcdLocation(test.resource, test.servers)
@ -148,8 +150,8 @@ func TestUpdateEtcdOverrides(t *testing.T) {
t.Errorf("%d: unexpected error %v", i, err) t.Errorf("%d: unexpected error %v", i, err)
continue continue
} }
if !reflect.DeepEqual(config.ServerList, test.servers) { if !reflect.DeepEqual(config.Transport.ServerList, test.servers) {
t.Errorf("%d: expected %v, got %v", i, test.servers, config.ServerList) t.Errorf("%d: expected %v, got %v", i, test.servers, config.Transport.ServerList)
continue continue
} }
@ -158,8 +160,8 @@ func TestUpdateEtcdOverrides(t *testing.T) {
t.Errorf("%d: unexpected error %v", i, err) t.Errorf("%d: unexpected error %v", i, err)
continue continue
} }
if !reflect.DeepEqual(config.ServerList, defaultEtcdLocation) { if !reflect.DeepEqual(config.Transport.ServerList, defaultEtcdLocation) {
t.Errorf("%d: expected %v, got %v", i, defaultEtcdLocation, config.ServerList) t.Errorf("%d: expected %v, got %v", i, defaultEtcdLocation, config.Transport.ServerList)
continue continue
} }

View File

@ -293,10 +293,12 @@ func NewUnsecuredEtcd3TestClientServer(t *testing.T) (*EtcdTestServer, *storageb
} }
server.V3Client = server.v3Cluster.RandClient() server.V3Client = server.v3Cluster.RandClient()
config := &storagebackend.Config{ config := &storagebackend.Config{
Type: "etcd3", Type: "etcd3",
Prefix: etcdtest.PathPrefix(), Prefix: etcdtest.PathPrefix(),
ServerList: server.V3Client.Endpoints(), Transport: storagebackend.TransportConfig{
Paging: true, ServerList: server.V3Client.Endpoints(),
},
Paging: true,
} }
return server, config return server, config
} }

View File

@ -30,18 +30,26 @@ const (
DefaultCompactInterval = 5 * time.Minute DefaultCompactInterval = 5 * time.Minute
) )
// Config is configuration for creating a storage backend. // TransportConfig holds all connection related info, i.e. equal TransportConfig means equal servers we talk to.
type Config struct { type TransportConfig struct {
// Type defines the type of storage backend. Default ("") is "etcd3".
Type string
// Prefix is the prefix to all keys passed to storage.Interface methods.
Prefix string
// ServerList is the list of storage servers to connect with. // ServerList is the list of storage servers to connect with.
ServerList []string ServerList []string
// TLS credentials // TLS credentials
KeyFile string KeyFile string
CertFile string CertFile string
CAFile string CAFile string
}
// Config is configuration for creating a storage backend.
type Config struct {
// Type defines the type of storage backend. Default ("") is "etcd3".
Type string
// Prefix is the prefix to all keys passed to storage.Interface methods.
Prefix string
// Transport holds all connection related info, i.e. equal TransportConfig means equal servers we talk to.
Transport TransportConfig
// Quorum indicates that whether read operations should be quorum-level consistent.
Quorum bool
// Paging indicates whether the server implementation should allow paging (if it is // Paging indicates whether the server implementation should allow paging (if it is
// supported). This is generally configured by feature gating, or by a specific // supported). This is generally configured by feature gating, or by a specific
// resource type not wishing to allow paging, and is not intended for end users to // resource type not wishing to allow paging, and is not intended for end users to
@ -55,7 +63,6 @@ type Config struct {
// CompactionInterval is an interval of requesting compaction from apiserver. // CompactionInterval is an interval of requesting compaction from apiserver.
// If the value is 0, no compaction will be issued. // If the value is 0, no compaction will be issued.
CompactionInterval time.Duration CompactionInterval time.Duration
// CountMetricPollPeriod specifies how often should count metric be updated // CountMetricPollPeriod specifies how often should count metric be updated
CountMetricPollPeriod time.Duration CountMetricPollPeriod time.Duration
} }

View File

@ -54,7 +54,7 @@ func newETCD3HealthCheck(c storagebackend.Config) (func() error, error) {
clientErrMsg.Store("etcd client connection not yet established") clientErrMsg.Store("etcd client connection not yet established")
go wait.PollUntil(time.Second, func() (bool, error) { go wait.PollUntil(time.Second, func() (bool, error) {
client, err := newETCD3Client(c) client, err := newETCD3Client(c.Transport)
if err != nil { if err != nil {
clientErrMsg.Store(err.Error()) clientErrMsg.Store(err.Error())
return false, nil return false, nil
@ -78,7 +78,7 @@ func newETCD3HealthCheck(c storagebackend.Config) (func() error, error) {
}, nil }, nil
} }
func newETCD3Client(c storagebackend.Config) (*clientv3.Client, error) { func newETCD3Client(c storagebackend.TransportConfig) (*clientv3.Client, error) {
tlsInfo := transport.TLSInfo{ tlsInfo := transport.TLSInfo{
CertFile: c.CertFile, CertFile: c.CertFile,
KeyFile: c.KeyFile, KeyFile: c.KeyFile,
@ -109,7 +109,7 @@ func newETCD3Client(c storagebackend.Config) (*clientv3.Client, error) {
} }
func newETCD3Storage(c storagebackend.Config) (storage.Interface, DestroyFunc, error) { func newETCD3Storage(c storagebackend.Config) (storage.Interface, DestroyFunc, error) {
client, err := newETCD3Client(c) client, err := newETCD3Client(c.Transport)
if err != nil { if err != nil {
return nil, nil, err return nil, nil, err
} }

View File

@ -66,12 +66,14 @@ func TestTLSConnection(t *testing.T) {
defer cluster.Terminate(t) defer cluster.Terminate(t)
cfg := storagebackend.Config{ cfg := storagebackend.Config{
Type: storagebackend.StorageTypeETCD3, Type: storagebackend.StorageTypeETCD3,
ServerList: []string{cluster.Members[0].GRPCAddr()}, Transport: storagebackend.TransportConfig{
CertFile: certFile, ServerList: []string{cluster.Members[0].GRPCAddr()},
KeyFile: keyFile, CertFile: certFile,
CAFile: caFile, KeyFile: keyFile,
Codec: codec, CAFile: caFile,
},
Codec: codec,
} }
storage, destroyFunc, err := newETCD3Storage(cfg) storage, destroyFunc, err := newETCD3Storage(cfg)
defer destroyFunc() defer destroyFunc()