github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/cluster/client/etcd/config.go

// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package etcd

import (
	"os"
	"time"

	"github.com/uber-go/tally"
	"google.golang.org/grpc"

	"github.com/m3db/m3/src/cluster/client"
	"github.com/m3db/m3/src/cluster/services"
	"github.com/m3db/m3/src/x/instrument"
	"github.com/m3db/m3/src/x/retry"
)

// ClusterConfig is the config for a zoned etcd cluster.
type ClusterConfig struct {
	Zone      string           `yaml:"zone"`
	Endpoints []string         `yaml:"endpoints"`
	KeepAlive *KeepAliveConfig `yaml:"keepAlive"`
	TLS       *TLSConfig       `yaml:"tls"`
	// AutoSyncInterval configures the etcd client's AutoSyncInterval
	// (go.etcd.io/etcd/client/v3@v3.6.0-alpha.0/config.go:32).
	// By default, it is 1m.
	//
	// Advanced:
	//
	// One important difference from the etcd config: we have autosync *on* by default (unlike etcd), meaning that
	// the zero value here doesn't indicate autosync off.
	// Instead, users should pass in a negative value to indicate "disable autosync"
	// Only do this if you truly have a good reason for it! Most production use cases want autosync on.
	AutoSyncInterval time.Duration `yaml:"autoSyncInterval"`
	DialTimeout      time.Duration `yaml:"dialTimeout"`

	DialOptions []grpc.DialOption `yaml:"-"` // nonserializable
}

// NewCluster creates a new Cluster.
func (c ClusterConfig) NewCluster() Cluster {
	keepAliveOpts := NewKeepAliveOptions()
	if c.KeepAlive != nil {
		keepAliveOpts = c.KeepAlive.NewOptions()
	}

	cluster := NewCluster().
		SetZone(c.Zone).
		SetEndpoints(c.Endpoints).
		SetDialOptions(c.DialOptions).
		SetKeepAliveOptions(keepAliveOpts).
		SetTLSOptions(c.TLS.newOptions())

	// Autosync should *always* be on, unless the user very explicitly requests it to be off. They can do this via a
	// negative value (in which case we can assume they know what they're doing).
	// Therefore, only update if it's nonzero, on the assumption that zero is just the empty value.
	if c.AutoSyncInterval != 0 {
		cluster = cluster.SetAutoSyncInterval(c.AutoSyncInterval)
	}

	if c.DialTimeout > 0 {
		cluster = cluster.SetDialTimeout(c.DialTimeout)
	}

	return cluster
}

// TLSConfig is the config for TLS.
type TLSConfig struct {
	CrtPath   string `yaml:"crtPath"`
	CACrtPath string `yaml:"caCrtPath"`
	KeyPath   string `yaml:"keyPath"`
}

func (c *TLSConfig) newOptions() TLSOptions {
	opts := NewTLSOptions()
	if c == nil {
		return opts
	}

	return opts.
		SetCrtPath(c.CrtPath).
		SetKeyPath(c.KeyPath).
		SetCACrtPath(c.CACrtPath)
}

// KeepAliveConfig configures keepAlive behavior.
type KeepAliveConfig struct {
	Enabled bool          `yaml:"enabled"`
	Period  time.Duration `yaml:"period"`
	Jitter  time.Duration `yaml:"jitter"`
	Timeout time.Duration `yaml:"timeout"`
}

// NewOptions constructs options based on the config.
func (c *KeepAliveConfig) NewOptions() KeepAliveOptions {
	return NewKeepAliveOptions().
		SetKeepAliveEnabled(c.Enabled).
		SetKeepAlivePeriod(c.Period).
		SetKeepAlivePeriodMaxJitter(c.Jitter).
		SetKeepAliveTimeout(c.Timeout)
}

// Configuration is for config service client.
type Configuration struct {
	Zone              string                 `yaml:"zone"`
	Env               string                 `yaml:"env"`
	Service           string                 `yaml:"service" validate:"nonzero"`
	CacheDir          string                 `yaml:"cacheDir"`
	ETCDClusters      []ClusterConfig        `yaml:"etcdClusters"`
	SDConfig          services.Configuration `yaml:"m3sd"`
	WatchWithRevision int64                  `yaml:"watchWithRevision"`
	NewDirectoryMode  *os.FileMode           `yaml:"newDirectoryMode"`

	Retry                  retry.Configuration `yaml:"retry"`
	RequestTimeout         time.Duration       `yaml:"requestTimeout"`
	WatchChanInitTimeout   time.Duration       `yaml:"watchChanInitTimeout"`
	WatchChanCheckInterval time.Duration       `yaml:"watchChanCheckInterval"`
	WatchChanResetInterval time.Duration       `yaml:"watchChanResetInterval"`
	// EnableFastGets trades consistency for latency and throughput using clientv3.WithSerializable()
	// on etcd ops.
	EnableFastGets bool `yaml:"enableFastGets"`
}

// NewClient creates a new config service client.
func (cfg Configuration) NewClient(iopts instrument.Options) (client.Client, error) {
	return NewConfigServiceClient(cfg.NewOptions().SetInstrumentOptions(iopts))
}

// NewOptions returns a new Options.
func (cfg Configuration) NewOptions() Options {
	opts := NewOptions().
		SetZone(cfg.Zone).
		SetEnv(cfg.Env).
		SetService(cfg.Service).
		SetCacheDir(cfg.CacheDir).
		SetClusters(cfg.etcdClusters()).
		SetServicesOptions(cfg.SDConfig.NewOptions()).
		SetWatchWithRevision(cfg.WatchWithRevision).
		SetEnableFastGets(cfg.EnableFastGets).
		SetRetryOptions(cfg.Retry.NewOptions(tally.NoopScope))

	if cfg.RequestTimeout > 0 {
		opts = opts.SetRequestTimeout(cfg.RequestTimeout)
	}

	if cfg.WatchChanInitTimeout > 0 {
		opts = opts.SetWatchChanInitTimeout(cfg.WatchChanInitTimeout)
	}

	if cfg.WatchChanCheckInterval > 0 {
		opts = opts.SetWatchChanCheckInterval(cfg.WatchChanCheckInterval)
	}

	if cfg.WatchChanResetInterval > 0 {
		opts = opts.SetWatchChanResetInterval(cfg.WatchChanResetInterval)
	}

	if v := cfg.NewDirectoryMode; v != nil {
		opts = opts.SetNewDirectoryMode(*v)
	} else {
		opts = opts.SetNewDirectoryMode(defaultDirectoryMode)
	}

	return opts
}

func (cfg Configuration) etcdClusters() []Cluster {
	res := make([]Cluster, len(cfg.ETCDClusters))
	for i, c := range cfg.ETCDClusters {
		res[i] = c.NewCluster()
	}

	return res
}