/* Copyright The containerd Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package config import ( "github.com/BurntSushi/toml" "github.com/containerd/containerd/errdefs" "github.com/pkg/errors" ) // Config provides containerd configuration data for the server type Config struct { // Root is the path to a directory where containerd will store persistent data Root string `toml:"root"` // State is the path to a directory where containerd will store transient data State string `toml:"state"` // PluginDir is the directory for dynamic plugins to be stored PluginDir string `toml:"plugin_dir"` // GRPC configuration settings GRPC GRPCConfig `toml:"grpc"` // 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.Primitive `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"` md toml.MetaData } // GRPCConfig provides GRPC configuration for the socket type GRPCConfig struct { Address string `toml:"address"` TCPAddress string `toml:"tcp_address"` 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"` } // Debug provides debug configuration type Debug struct { Address string `toml:"address"` UID int `toml:"uid"` GID int `toml:"gid"` Level string `toml:"level"` } // MetricsConfig provides metrics configuration type MetricsConfig struct { Address string `toml:"address"` GRPCHistogram bool `toml:"grpc_histogram"` } // CgroupConfig provides cgroup configuration type CgroupConfig struct { Path string `toml:"path"` } // ProxyPlugin provides a proxy plugin configuration type ProxyPlugin struct { Type string `toml:"type"` Address string `toml:"address"` } // BoltConfig defines the configuration values for the bolt plugin, which is // loaded here, rather than back registered in the metadata package. type BoltConfig struct { // ContentSharingPolicy sets the sharing policy for content between // namespaces. // // The default mode "shared" will make blobs available in all // namespaces once it is pulled into any namespace. The blob will be pulled // into the namespace if a writer is opened with the "Expected" digest that // is already present in the backend. // // The alternative mode, "isolated" requires that clients prove they have // access to the content by providing all of the content to the ingest // before the blob is added to the namespace. // // Both modes share backing data, while "shared" will reduce total // bandwidth across namespaces, at the cost of allowing access to any blob // just by knowing its digest. ContentSharingPolicy string `toml:"content_sharing_policy"` } const ( // SharingPolicyShared represents the "shared" sharing policy SharingPolicyShared = "shared" // SharingPolicyIsolated represents the "isolated" sharing policy SharingPolicyIsolated = "isolated" ) // Validate validates if BoltConfig is valid func (bc *BoltConfig) Validate() error { switch bc.ContentSharingPolicy { case SharingPolicyShared, SharingPolicyIsolated: return nil default: return errors.Wrapf(errdefs.ErrInvalidArgument, "unknown policy: %s", bc.ContentSharingPolicy) } } // Decode unmarshals a plugin specific configuration by plugin id func (c *Config) Decode(id string, v interface{}) (interface{}, error) { data, ok := c.Plugins[id] if !ok { return v, nil } if err := c.md.PrimitiveDecode(data, v); err != nil { return nil, err } return v, nil } // LoadConfig loads the containerd server config from the provided path func LoadConfig(path string, v *Config) error { if v == nil { return errors.Wrapf(errdefs.ErrInvalidArgument, "argument v must not be nil") } md, err := toml.DecodeFile(path, v) if err != nil { return err } v.md = md return nil }