config

Documentation

Index

• func IsValidName(name string) bool
• type Config
  • func New(opts ...Option) *Config
• type Option
  • func OptionActiveSandboxes(sandboxes map[string]interface{}) Option
  • func OptionDataDir(dataDir string) Option
  • func OptionDefaultAddressPoolConfig(addressPool []*ipamutils.NetworkToSplit) Option
  • func OptionDefaultDriver(dd string) Option
  • func OptionDefaultNetwork(dn string) Option
  • func OptionDriverConfig(networkType string, config map[string]interface{}) Option
  • func OptionExecRoot(execRoot string) Option
  • func OptionLabels(labels []string) Option
  • func OptionLocalKVProvider(provider string) Option
  • func OptionLocalKVProviderConfig(config *store.Config) Option
  • func OptionLocalKVProviderURL(url string) Option
  • func OptionNetworkControlPlaneMTU(exp int) Option
  • func OptionPluginGetter(pg plugingetter.PluginGetter) Option

Functions

func IsValidName

func IsValidName(name string) bool

IsValidName validates configuration objects supported by libnetwork

Types

type Config

type Config struct {
	DataDir                string
	ExecRoot               string
	DefaultNetwork         string
	DefaultDriver          string
	Labels                 []string
	DriverCfg              map[string]interface{}
	ClusterProvider        cluster.Provider
	NetworkControlPlaneMTU int
	DefaultAddressPool     []*ipamutils.NetworkToSplit
	Scope                  datastore.ScopeCfg
	ActiveSandboxes        map[string]interface{}
	PluginGetter           plugingetter.PluginGetter
}

Config encapsulates configurations of various Libnetwork components

func New

func New(opts ...Option) *Config

New creates a new Config and initializes it with the given Options.

type Option

type Option func(c *Config)

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

func OptionActiveSandboxes

func OptionActiveSandboxes(sandboxes map[string]interface{}) Option

OptionActiveSandboxes function returns an option setter for passing the sandboxes which were active during previous daemon life

func OptionDataDir

func OptionDataDir(dataDir string) Option

OptionDataDir function returns an option setter for data folder

func OptionDefaultAddressPoolConfig

func OptionDefaultAddressPoolConfig(addressPool []*ipamutils.NetworkToSplit) Option

OptionDefaultAddressPoolConfig function returns an option setter for default address pool

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 OptionDriverConfig

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

OptionDriverConfig returns an option setter for driver configuration.

func OptionExecRoot

func OptionExecRoot(execRoot string) Option

OptionExecRoot function returns an option setter for exec root folder

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 OptionNetworkControlPlaneMTU

func OptionNetworkControlPlaneMTU(exp int) Option

OptionNetworkControlPlaneMTU function returns an option setter for control plane MTU

func OptionPluginGetter

func OptionPluginGetter(pg plugingetter.PluginGetter) Option

OptionPluginGetter returns a plugingetter for remote drivers.