config

Documentation

Index

• func LoadConfig(path string, out *Config) error
• func V1DisabledFilter(list []string) plugin.DisableFilter
• func V2DisabledFilter(list []string) plugin.DisableFilter
• type CgroupConfig
• type Config
  • func (c *Config) Decode(p *plugin.Registration) (interface{}, error)
  • func (c *Config) GetVersion() int
  • func (c *Config) ValidateV2() error
• type Debug
• type GRPCConfig
• type MetricsConfig
• type ProxyPlugin
• type StreamProcessor
• type TTRPCConfig

Functions

func LoadConfig

func LoadConfig(path string, out *Config) error

LoadConfig loads the containerd server config from the provided path

func V1DisabledFilter

func V1DisabledFilter(list []string) plugin.DisableFilter

V1DisabledFilter matches based on ID

func V2DisabledFilter

func V2DisabledFilter(list []string) plugin.DisableFilter

V2DisabledFilter matches based on URI

Types

type CgroupConfig

type CgroupConfig struct {
	Path string `toml:"path"`
}

CgroupConfig provides cgroup configuration

type Config

type Config struct {
	// Version of the config file
	Version int `toml:"version"`
	// Root is the path to a directory where containerd will store persistent data
	Root string `toml:"root"`
	// CtrDataDir is the path to a directory where containerd will store persistente data of containers
	CtrDataDir string `toml:"ctr_data_dir"`

	DB string `toml:"db"`
	// State is the path to a directory where containerd will store transient data
	State string `toml:"state"`
	// TempDir is the path to a directory where to place containerd temporary files
	TempDir string `toml:"temp"`
	// PluginDir is the directory for dynamic plugins to be stored
	PluginDir string `toml:"plugin_dir"`
	// GRPC configuration settings
	GRPC GRPCConfig `toml:"grpc"`
	// TTRPC configuration settings
	TTRPC TTRPCConfig `toml:"ttrpc"`
	// Debug and profiling settings
	Debug Debug `toml:"debug"`
	// Metrics and monitoring settings
	Metrics MetricsConfig `toml:"metrics"`
	// DisabledPlugins are IDs of plugins to disable. Disabled plugins won't be
	// initialized and started.
	DisabledPlugins []string `toml:"disabled_plugins"`
	// RequiredPlugins are IDs of required plugins. Containerd exits if any
	// required plugin doesn't exist or fails to be initialized or started.
	RequiredPlugins []string `toml:"required_plugins"`
	// Plugins provides plugin specific configuration for the initialization of a plugin
	Plugins map[string]toml.Tree `toml:"plugins"`
	// OOMScore adjust the containerd's oom score
	OOMScore int `toml:"oom_score"`
	// Cgroup specifies cgroup information for the containerd daemon process
	Cgroup CgroupConfig `toml:"cgroup"`
	// ProxyPlugins configures plugins which are communicated to over GRPC
	ProxyPlugins map[string]ProxyPlugin `toml:"proxy_plugins"`
	// Timeouts specified as a duration
	Timeouts map[string]string `toml:"timeouts"`
	// Imports are additional file path list to config files that can overwrite main config file fields
	Imports []string `toml:"imports"`
	// StreamProcessors configuration
	StreamProcessors map[string]StreamProcessor `toml:"stream_processors"`
}

Config provides containerd configuration data for the server

func (*Config) Decode

func (c *Config) Decode(p *plugin.Registration) (interface{}, error)

Decode unmarshals a plugin specific configuration by plugin id

func (*Config) GetVersion

func (c *Config) GetVersion() int

GetVersion returns the config file's version

func (*Config) ValidateV2

func (c *Config) ValidateV2() error

ValidateV2 validates the config for a v2 file

type Debug

type Debug struct {
	Address string `toml:"address"`
	UID     int    `toml:"uid"`
	GID     int    `toml:"gid"`
	Level   string `toml:"level"`
	// Format represents the logging format. Supported values are 'text' and 'json'.
	Format string `toml:"format"`
}

Debug provides debug configuration

type GRPCConfig

type GRPCConfig struct {
	Address        string `toml:"address"`
	TCPAddress     string `toml:"tcp_address"`
	TCPTLSCA       string `toml:"tcp_tls_ca"`
	TCPTLSCert     string `toml:"tcp_tls_cert"`
	TCPTLSKey      string `toml:"tcp_tls_key"`
	UID            int    `toml:"uid"`
	GID            int    `toml:"gid"`
	MaxRecvMsgSize int    `toml:"max_recv_message_size"`
	MaxSendMsgSize int    `toml:"max_send_message_size"`
}

GRPCConfig provides GRPC configuration for the socket

type MetricsConfig

type MetricsConfig struct {
	Address       string `toml:"address"`
	GRPCHistogram bool   `toml:"grpc_histogram"`
}

MetricsConfig provides metrics configuration

type ProxyPlugin

type ProxyPlugin struct {
	Type    string `toml:"type"`
	Address string `toml:"address"`
}

ProxyPlugin provides a proxy plugin configuration

type StreamProcessor

type StreamProcessor struct {
	// Accepts specific media-types
	Accepts []string `toml:"accepts"`
	// Returns the media-type
	Returns string `toml:"returns"`
	// Path or name of the binary
	Path string `toml:"path"`
	// Args to the binary
	Args []string `toml:"args"`
	// Environment variables for the binary
	Env []string `toml:"env"`
}

StreamProcessor provides configuration for diff content processors

type TTRPCConfig

type TTRPCConfig struct {
	Address string `toml:"address"`
	UID     int    `toml:"uid"`
	GID     int    `toml:"gid"`
}

TTRPCConfig provides TTRPC configuration for the socket