config

Documentation

Index

• func IsValidName(name string) bool
• type ClusterCfg
• type Config
  • func ParseConfig(tomlCfgFile string) (*Config, error)
  • func ParseConfigOptions(cfgOptions ...Option) *Config
  • func (c *Config) LoadDefaultScopes(dataDir string)
  • func (c *Config) ProcessOptions(options ...Option)
• type DaemonCfg
• type Option
  • func OptionAgent() Option
  • func OptionBind(bind string) Option
  • func OptionDataDir(dataDir string) Option
  • func OptionDefaultDriver(dd string) Option
  • func OptionDefaultNetwork(dn string) Option
  • func OptionDiscoveryAddress(address string) Option
  • func OptionDiscoveryWatcher(watcher discovery.Watcher) Option
  • func OptionDriverConfig(networkType string, config map[string]interface{}) Option
  • func OptionKVOpts(opts map[string]string) Option
  • func OptionKVProvider(provider string) Option
  • func OptionKVProviderURL(url string) Option
  • func OptionLabels(labels []string) Option
  • func OptionLocalKVProvider(provider string) Option
  • func OptionLocalKVProviderConfig(config *store.Config) Option
  • func OptionLocalKVProviderURL(url string) Option
  • func OptionNeighbors(neighbors []string) Option

Functions

func IsValidName

func IsValidName(name string) bool

IsValidName validates configuration objects supported by libnetwork

Types

type ClusterCfg

type ClusterCfg struct {
	Watcher   discovery.Watcher
	Address   string
	Discovery string
	Heartbeat uint64
}

ClusterCfg represents cluster configuration

type Config

type Config struct {
	Daemon  DaemonCfg
	Cluster ClusterCfg
	Scopes  map[string]*datastore.ScopeCfg
}

Config encapsulates configurations of various Libnetwork components

func ParseConfig

func ParseConfig(tomlCfgFile string) (*Config, error)

ParseConfig parses the libnetwork configuration file

func ParseConfigOptions

func ParseConfigOptions(cfgOptions ...Option) *Config

ParseConfigOptions parses the configuration options and returns a reference to the corresponding Config structure

func (*Config) LoadDefaultScopes

func (c *Config) LoadDefaultScopes(dataDir string)

LoadDefaultScopes loads default scope configs for scopes which doesn't have explicit user specified configs.

func (*Config) ProcessOptions

func (c *Config) ProcessOptions(options ...Option)

ProcessOptions processes options and stores it in config

type DaemonCfg

type DaemonCfg struct {
	Debug          bool
	IsAgent        bool
	DataDir        string
	DefaultNetwork string
	DefaultDriver  string
	Bind           string
	Neighbors      []string
	Labels         []string
	DriverCfg      map[string]interface{}
}

DaemonCfg represents libnetwork core configuration

type Option

type Option func(c *Config)

Option is an option setter function type used to pass various configurations to the controller

func OptionAgent

func OptionAgent() Option

OptionAgent function returns an option setter for setting agent mode

func OptionBind

func OptionBind(bind string) Option

OptionBind function returns an option setter for setting a bind interface or address

func OptionDataDir

func OptionDataDir(dataDir string) Option

OptionDataDir function returns an option setter for data folder

func OptionDefaultDriver

func OptionDefaultDriver(dd string) Option

OptionDefaultDriver function returns an option setter for default driver

func OptionDefaultNetwork

func OptionDefaultNetwork(dn string) Option

OptionDefaultNetwork function returns an option setter for a default network

func OptionDiscoveryAddress

func OptionDiscoveryAddress(address string) Option

OptionDiscoveryAddress function returns an option setter for self discovery address

func OptionDiscoveryWatcher

func OptionDiscoveryWatcher(watcher discovery.Watcher) Option

OptionDiscoveryWatcher function returns an option setter for discovery watcher

func OptionDriverConfig

func OptionDriverConfig(networkType string, config map[string]interface{}) Option

OptionDriverConfig returns an option setter for driver configuration.

func OptionKVOpts

func OptionKVOpts(opts map[string]string) Option

OptionKVOpts function returns an option setter for kvstore options

func OptionKVProvider

func OptionKVProvider(provider string) Option

OptionKVProvider function returns an option setter for kvstore provider

func OptionKVProviderURL

func OptionKVProviderURL(url string) Option

OptionKVProviderURL function returns an option setter for kvstore url

func OptionLabels

func OptionLabels(labels []string) Option

OptionLabels function returns an option setter for labels

func OptionLocalKVProvider

func OptionLocalKVProvider(provider string) Option

OptionLocalKVProvider function returns an option setter for kvstore provider

func OptionLocalKVProviderConfig

func OptionLocalKVProviderConfig(config *store.Config) Option

OptionLocalKVProviderConfig function returns an option setter for kvstore config

func OptionLocalKVProviderURL

func OptionLocalKVProviderURL(url string) Option

OptionLocalKVProviderURL function returns an option setter for kvstore url

func OptionNeighbors

func OptionNeighbors(neighbors []string) Option

OptionNeighbors function returns an option setter for setting a list of neighbors to join.