config
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- type Config
- type Option
- func OptionActiveSandboxes(sandboxes map[string]any) Option
- func OptionBridgeConfig(config bridge.Configuration) Option
- func OptionDataDir(dataDir string) Option
- func OptionDefaultAddressPoolConfig(addressPool []*ipamutils.NetworkToSplit) Option
- func OptionDefaultDriver(dd string) Option
- func OptionDefaultNetwork(dn string) Option
- func OptionExecRoot(execRoot string) Option
- func OptionFirewallBackend(val string) Option
- func OptionNetworkControlPlaneMTU(exp int) Option
- func OptionPluginGetter(pg plugingetter.PluginGetter) Option
- func OptionRootless(rootless bool) Option
- func OptionUserlandProxy(enabled bool, proxyPath string) Option
- type PlatformConfig
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeConfig¶
type Config struct {PlatformConfigDataDirstring// ExecRoot is the base-path for libnetwork external key listeners// (created in "<ExecRoot>/libnetwork/<Controller-Short-ID>.sock"),// and is passed as "-exec-root: argument for "libnetwork-setkey".//// It is only used on Linux, but referenced in some "unix" files// (linux and freebsd).//// FIXME(thaJeztah): ExecRoot is only used for Controller.startExternalKeyListener(), but "libnetwork-setkey" is only implemented on Linux.ExecRootstringDefaultNetworkstringDefaultDriverstringLabels []stringClusterProvidercluster.ProviderNetworkControlPlaneMTUintDefaultAddressPool []*ipamutils.NetworkToSplitDatastoreBucketstringActiveSandboxes map[string]anyPluginGetterplugingetter.PluginGetterFirewallBackendstringRootlessboolEnableUserlandProxyboolUserlandProxyPathstring}Config encapsulates configurations of various Libnetwork components
typeOption¶
type Option func(c *Config)
Option is an option setter function type used to pass various configurationsto the controller
funcOptionActiveSandboxes¶
OptionActiveSandboxes function returns an option setter for passing the sandboxeswhich were active during previous daemon life
funcOptionBridgeConfig¶
func OptionBridgeConfig(configbridge.Configuration)Option
OptionBridgeConfig returns an option setter for bridge driver config.
funcOptionDataDir¶
OptionDataDir function returns an option setter for data folder
funcOptionDefaultAddressPoolConfig¶
func OptionDefaultAddressPoolConfig(addressPool []*ipamutils.NetworkToSplit)Option
OptionDefaultAddressPoolConfig function returns an option setter for default address pool
funcOptionDefaultDriver¶
OptionDefaultDriver function returns an option setter for default driver
funcOptionDefaultNetwork¶
OptionDefaultNetwork function returns an option setter for a default network
funcOptionExecRoot¶
OptionExecRoot function returns an option setter for exec root folder.
On Linux, it sets both the controller's ExecRoot and osl.basePath, whereason FreeBSD, it only sets the controller's ExecRoot. It is a no-op on otherplatforms.
funcOptionFirewallBackend¶
OptionFirewallBackend returns an option setter for selection of the firewall backend.
funcOptionNetworkControlPlaneMTU¶
OptionNetworkControlPlaneMTU function returns an option setter for control plane MTU
funcOptionPluginGetter¶
func OptionPluginGetter(pgplugingetter.PluginGetter)Option
OptionPluginGetter returns a plugingetter for remote drivers.
funcOptionRootless¶
OptionRootless returns an option setter that indicates whether the daemon isrunning in rootless mode.
funcOptionUserlandProxy¶
OptionUserlandProxy returns an option setter that indicates whether theuserland proxy is enabled, and sets the path to the proxy binary.
typePlatformConfig¶
type PlatformConfig struct {BridgeConfigbridge.Configuration}PlatformConfig defines platform-specific configuration.