docker

Documentation

Index

• func New(opts ...Option) (engine.Interface, error)
• type Config
  • func (c *Config) AddRuntime(name string, path string, setAsDefault bool) error
  • func (c Config) DefaultRuntime() string
  • func (c *Config) GetRuntimeConfig(name string) (engine.RuntimeConfig, error)
  • func (c *Config) RemoveRuntime(name string) error
  • func (c Config) Save(path string) (int64, error)
  • func (c *Config) Set(key string, value interface{})
• type Option
  • func WithLogger(logger logger.Interface) Option
  • func WithPath(path string) Option

Functions

func New

func New(opts ...Option) (engine.Interface, error)

New creates a docker config with the specified options

Types

type Config

type Config map[string]interface{}

Config defines a docker config file. TODO: This should not be public, but we need to access it from the tests in tools/container/docker

func (*Config) AddRuntime

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

AddRuntime adds a new runtime to the docker config

func (Config) DefaultRuntime

func (c Config) DefaultRuntime() string

DefaultRuntime returns the default runtime for the docker config

func (*Config) GetRuntimeConfig

func (c *Config) GetRuntimeConfig(name string) (engine.RuntimeConfig, error)

GetRuntimeConfig returns the runtime info of the runtime passed as input

func (*Config) RemoveRuntime

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

RemoveRuntime removes a runtime from the docker config

func (Config) Save

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

Save writes the config to the specified path

func (*Config) Set

func (c *Config) Set(key string, value interface{})

Set sets the specified docker option

type Option

type Option func(*builder)

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

func WithLogger

func WithLogger(logger logger.Interface) Option

WithLogger sets the logger for the config builder

func WithPath

func WithPath(path string) Option

WithPath sets the path for the config builder