Documentation
¶
Index ¶
- Variables
- type Config
- func (c *Config) Copy() *Config
- func (c *Config) NomadPluginConfig() *base.AgentConfig
- func (c *Config) Read(id string) string
- func (c *Config) ReadBool(id string) (bool, error)
- func (c *Config) ReadBoolDefault(id string, defaultValue bool) bool
- func (c *Config) ReadDefault(id string, defaultValue string) string
- func (c *Config) ReadDuration(id string) (time.Duration, error)
- func (c *Config) ReadDurationDefault(id string, defaultValue time.Duration) time.Duration
- func (c *Config) ReadInt(id string) (int, error)
- func (c *Config) ReadIntDefault(id string, defaultValue int) int
- func (c *Config) ReadStringListToMap(key string) map[string]struct{}
- func (c *Config) ReadStringListToMapDefault(key, defaultValue string) map[string]struct{}
- type RPCHandler
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // DefaultEnvBlacklist is the default set of environment variables that are // filtered when passing the environment variables of the host to a task. DefaultEnvBlacklist = strings.Join([]string{ "CONSUL_TOKEN", "VAULT_TOKEN", "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "GOOGLE_APPLICATION_CREDENTIALS", }, ",") // DefaultUserBlacklist is the default set of users that tasks are not // allowed to run as when using a driver in "user.checked_drivers" DefaultUserBlacklist = strings.Join([]string{ "root", "Administrator", }, ",") // DefaultUserCheckedDrivers is the set of drivers we apply the user // blacklist onto. For virtualized drivers it often doesn't make sense to // make this stipulation so by default they are ignored. DefaultUserCheckedDrivers = strings.Join([]string{ "exec", "qemu", "java", }, ",") // A mapping of directories on the host OS to attempt to embed inside each // task's chroot. DefaultChrootEnv = map[string]string{ "/bin": "/bin", "/etc": "/etc", "/lib": "/lib", "/lib32": "/lib32", "/lib64": "/lib64", "/run/resolvconf": "/run/resolvconf", "/sbin": "/sbin", "/usr": "/usr", } )
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// DevMode controls if we are in a development mode which
// avoids persistent storage.
DevMode bool
// StateDir is where we store our state
StateDir string
// AllocDir is where we store data for allocations
AllocDir string
// LogOutput is the destination for logs
LogOutput io.Writer
// Logger provides a logger to thhe client
Logger log.Logger
// Region is the clients region
Region string
// Network interface to be used in network fingerprinting
NetworkInterface string
// Network speed is the default speed of network interfaces if they can not
// be determined dynamically.
NetworkSpeed int
// CpuCompute is the default total CPU compute if they can not be determined
// dynamically. It should be given as Cores * MHz (2 Cores * 2 Ghz = 4000)
CpuCompute int
// MemoryMB is the default node total memory in megabytes if it cannot be
// determined dynamically.
MemoryMB int
// MaxKillTimeout allows capping the user-specifiable KillTimeout. If the
// task's KillTimeout is greater than the MaxKillTimeout, MaxKillTimeout is
// used.
MaxKillTimeout time.Duration
// Servers is a list of known server addresses. These are as "host:port"
Servers []string
// RPCHandler can be provided to avoid network traffic if the
// server is running locally.
RPCHandler RPCHandler
// Node provides the base node
Node *structs.Node
// ClientMaxPort is the upper range of the ports that the client uses for
// communicating with plugin subsystems over loopback
ClientMaxPort uint
// ClientMinPort is the lower range of the ports that the client uses for
// communicating with plugin subsystems over loopback
ClientMinPort uint
// A mapping of directories on the host OS to attempt to embed inside each
// task's chroot.
ChrootEnv map[string]string
// Options provides arbitrary key-value configuration for nomad internals,
// like fingerprinters and drivers. The format is:
//
// namespace.option = value
Options map[string]string
// Version is the version of the Nomad client
Version *version.VersionInfo
// ConsulConfig is this Agent's Consul configuration
ConsulConfig *config.ConsulConfig
// VaultConfig is this Agent's Vault configuration
VaultConfig *config.VaultConfig
// StatsCollectionInterval is the interval at which the Nomad client
// collects resource usage stats
StatsCollectionInterval time.Duration
// PublishNodeMetrics determines whether nomad is going to publish node
// level metrics to remote Telemetry sinks
PublishNodeMetrics bool
// PublishAllocationMetrics determines whether nomad is going to publish
// allocation metrics to remote Telemetry sinks
PublishAllocationMetrics bool
// TLSConfig holds various TLS related configurations
TLSConfig *config.TLSConfig
// GCInterval is the time interval at which the client triggers garbage
// collection
GCInterval time.Duration
// GCParallelDestroys is the number of parallel destroys the garbage
// collector will allow.
GCParallelDestroys int
// GCDiskUsageThreshold is the disk usage threshold given as a percent
// beyond which the Nomad client triggers GC of terminal allocations
GCDiskUsageThreshold float64
// GCInodeUsageThreshold is the inode usage threshold given as a percent
// beyond which the Nomad client triggers GC of the terminal allocations
GCInodeUsageThreshold float64
// GCMaxAllocs is the maximum number of allocations a node can have
// before garbage collection is triggered.
GCMaxAllocs int
// LogLevel is the level of the logs to putout
LogLevel string
// NoHostUUID disables using the host's UUID and will force generation of a
// random UUID.
NoHostUUID bool
// ACLEnabled controls if ACL enforcement and management is enabled.
ACLEnabled bool
// ACLTokenTTL is how long we cache token values for
ACLTokenTTL time.Duration
// ACLPolicyTTL is how long we cache policy values for
ACLPolicyTTL time.Duration
// DisableTaggedMetrics determines whether metrics will be displayed via a
// key/value/tag format, or simply a key/value format
DisableTaggedMetrics bool
// DisableRemoteExec disables remote exec targeting tasks on this client
DisableRemoteExec bool
// BackwardsCompatibleMetrics determines whether to show methods of
// displaying metrics for older versions, or to only show the new format
BackwardsCompatibleMetrics bool
// RPCHoldTimeout is how long an RPC can be "held" before it is errored.
// This is used to paper over a loss of leadership by instead holding RPCs,
// so that the caller experiences a slow response rather than an error.
// This period is meant to be long enough for a leader election to take
// place, and a small jitter is applied to avoid a thundering herd.
RPCHoldTimeout time.Duration
// PluginLoader is used to load plugins.
PluginLoader loader.PluginCatalog
// PluginSingletonLoader is a plugin loader that will returns singleton
// instances of the plugins.
PluginSingletonLoader loader.PluginCatalog
// StateDBFactory is used to override stateDB implementations,
StateDBFactory state.NewStateDBFunc
// CNIPath is the path used to search for CNI plugins. Multiple paths can
// be specified with colon delimited
CNIPath string
// BridgeNetworkName is the name to use for the bridge created in bridge
// networking mode. This defaults to 'nomad' if not set
BridgeNetworkName string
// BridgeNetworkAllocSubnet is the IP subnet to use for address allocation
// for allocations in bridge networking mode. Subnet must be in CIDR
// notation
BridgeNetworkAllocSubnet string
}
Config is used to parameterize and configure the behavior of the client
func DefaultConfig ¶ added in v0.4.0
func DefaultConfig() *Config
DefaultConfig returns the default configuration
func TestClientConfig ¶ added in v0.9.0
TestClientConfig returns a default client configuration for test clients and a cleanup func to remove the state and alloc dirs when finished.
func (*Config) NomadPluginConfig ¶ added in v0.9.0
func (c *Config) NomadPluginConfig() *base.AgentConfig
NomadPluginConfig produces the NomadConfig struct which is sent to Nomad plugins
func (*Config) ReadBoolDefault ¶ added in v0.2.0
ReadBoolDefault tries to parse the specified option as a boolean. If there is an error in parsing, the default option is returned.
func (*Config) ReadDefault ¶
ReadDefault returns the specified configuration value, or the specified default value if none is set.
func (*Config) ReadDuration ¶ added in v0.5.5
ReadDuration parses the specified option as a duration.
func (*Config) ReadDurationDefault ¶ added in v0.5.5
ReadDurationDefault tries to parse the specified option as a duration. If there is an error in parsing, the default option is returned.
func (*Config) ReadIntDefault ¶ added in v0.5.5
ReadIntDefault tries to parse the specified option as a int. If there is an error in parsing, the default option is returned.
func (*Config) ReadStringListToMap ¶ added in v0.2.1
ReadStringListToMap tries to parse the specified option as a comma separated list. If there is an error in parsing, an empty list is returned.
func (*Config) ReadStringListToMapDefault ¶ added in v0.3.2
ReadStringListToMap tries to parse the specified option as a comma separated list. If there is an error in parsing, an empty list is returned.
type RPCHandler ¶
RPCHandler can be provided to the Client if there is a local server to avoid going over the network. If not provided, the Client will maintain a connection pool to the servers
Source Files
Click to show internal directories.
Click to hide internal directories.