environment

Documentation

Index

• type Configuration
  • func (c Configuration) Configure(cfgParams ConfigurationParameters) (ConfigureResults, error)
• type ConfigurationParameters
• type ConfigureResults
• type SeedNode
• type SeedNodeSecurityConfig
• type SeedNodesConfig
• type StaticConfiguration

Types

type Configuration

type Configuration struct {
	// Service is used when a topology initializer is not supplied.
	Service *etcdclient.Configuration `yaml:"service"`

	// StaticConfiguration is used for running M3DB with a static config
	Static *StaticConfiguration `yaml:"static"`

	// Presence of a (etcd) server in this config denotes an embedded cluster
	SeedNodes *SeedNodesConfig `yaml:"seedNodes"`

	// NamespaceResolutionTimeout is the maximum time to wait to discover namespaces from KV
	NamespaceResolutionTimeout time.Duration `yaml:"namespaceResolutionTimeout"`

	// TopologyResolutionTimeout is the maximum time to wait for a topology from KV
	TopologyResolutionTimeout time.Duration `yaml:"topologyResolutionTimeout"`
}

Configuration is a configuration that can be used to create namespaces, a topology, and kv store

func (Configuration) Configure

func (c Configuration) Configure(cfgParams ConfigurationParameters) (ConfigureResults, error)

Configure creates a new ConfigureResults

type ConfigurationParameters

type ConfigurationParameters struct {
	InstrumentOpts             instrument.Options
	HashingSeed                uint32
	HostID                     string
	NamespaceResolutionTimeout time.Duration
	TopologyResolutionTimeout  time.Duration
}

ConfigurationParameters are options used to create new ConfigureResults

type ConfigureResults

type ConfigureResults struct {
	NamespaceInitializer namespace.Initializer
	TopologyInitializer  topology.Initializer
	ClusterClient        clusterclient.Client
	KVStore              kv.Store
}

ConfigureResults stores initializers and kv store for dynamic and static configs

type SeedNode

type SeedNode struct {
	HostID   string `yaml:"hostID"`
	Endpoint string `yaml:"endpoint"`
}

SeedNode represents a seed node for the cluster

type SeedNodeSecurityConfig

type SeedNodeSecurityConfig struct {
	CAFile        string `yaml:"caFile"`
	CertFile      string `yaml:"certFile"`
	KeyFile       string `yaml:"keyFile"`
	TrustedCAFile string `yaml:"trustedCaFile"`
	CertAuth      bool   `yaml:"clientCertAuth"`
	AutoTLS       bool   `yaml:"autoTls"`
}

SeedNodeSecurityConfig contains the data used for security in seed nodes

type SeedNodesConfig

type SeedNodesConfig struct {
	RootDir                  string                 `yaml:"rootDir"`
	InitialAdvertisePeerUrls []string               `yaml:"initialAdvertisePeerUrls"`
	AdvertiseClientUrls      []string               `yaml:"advertiseClientUrls"`
	ListenPeerUrls           []string               `yaml:"listenPeerUrls"`
	ListenClientUrls         []string               `yaml:"listenClientUrls"`
	InitialCluster           []SeedNode             `yaml:"initialCluster"`
	ClientTransportSecurity  SeedNodeSecurityConfig `yaml:"clientTransportSecurity"`
	PeerTransportSecurity    SeedNodeSecurityConfig `yaml:"peerTransportSecurity"`
}

SeedNodesConfig defines fields for seed node

type StaticConfiguration

type StaticConfiguration struct {
	Namespaces     []namespace.MetadataConfiguration `yaml:"namespaces"`
	TopologyConfig *topology.StaticConfiguration     `yaml:"topology"`
	ListenAddress  string                            `yaml:"listenAddress"`
}

StaticConfiguration is used for running M3DB with a static config