containerd

Documentation

Index

• func RestartContainerd(socket string) error
• type Config
  • func New(opts ...Option) (*Config, error)
  • func (c *Config) AddRuntime(name string, path string, setAsDefault bool) error
  • func (c *Config) DefaultRuntime() string
  • func (c *Config) RemoveRuntime(name string) error
  • func (c *Config) Save(path string) (int64, error)
• type Option
  • func WithPath(path string) Option
  • func WithPodAnnotations(podAnnotations ...string) Option
  • func WithRuntimeType(runtimeType string) Option
  • func WithUseLegacyConfig(useLegacyConfig bool) Option

Functions

func RestartContainerd

func RestartContainerd(socket string) error

RestartContainerd restarts containerd by sending a SIGHUP signal to the containerd daeon

Types

type Config

type Config struct {
	*toml.Tree
	RuntimeType           string
	UseDefaultRuntimeName bool
	PodAnnotations        []string
}

Config represents the containerd config

func New

func New(opts ...Option) (*Config, error)

New creates a containerd config with the specified options

func (*Config) AddRuntime

func (c *Config) AddRuntime(name string, path string, setAsDefault bool) error

AddRuntime adds a runtime to the containerd config

func (*Config) DefaultRuntime

func (c *Config) DefaultRuntime() string

DefaultRuntime returns the default runtime for the containerd config

func (*Config) RemoveRuntime

func (c *Config) RemoveRuntime(name string) error

RemoveRuntime removes a runtime from the containerd config

func (*Config) Save

func (c *Config) Save(path string) (int64, error)

Save writes the config to the specified path

type Option

type Option func(*builder)

Option defines a function that can be used to configure the config builder

func WithPath

func WithPath(path string) Option

WithPath sets the path for the config builder

func WithPodAnnotations

func WithPodAnnotations(podAnnotations ...string) Option

WithPodAnnotations sets the container annotations for the config builder

func WithRuntimeType

func WithRuntimeType(runtimeType string) Option

WithRuntimeType sets the runtime type for the config builder

func WithUseLegacyConfig

func WithUseLegacyConfig(useLegacyConfig bool) Option

WithUseLegacyConfig sets the useLegacyConfig flag for the config builder