containerruntime

Documentation

Index

• Constants
• type AuthConfig
• type Config
  • func Get(containerRuntimeName string, opts ...Opt) Config
  • func (cfg Config) Engine(kubeletVersion *semver.Version) Engine
  • func (cfg Config) String() string
• type Containerd
  • func (eng *Containerd) Config() (string, error)
  • func (eng *Containerd) ConfigFileName() string
  • func (eng *Containerd) KubeletFlags() []string
  • func (eng *Containerd) ScriptFor(os types.OperatingSystem) (string, error)
  • func (eng *Containerd) String() string
• type Docker
  • func (eng *Docker) Config() (string, error)
  • func (eng *Docker) ConfigFileName() string
  • func (eng *Docker) KubeletFlags() []string
  • func (eng *Docker) ScriptFor(os types.OperatingSystem) (string, error)
  • func (eng *Docker) String() string
• type Engine
• type Opt
  • func WithInsecureRegistries(registries []string) Opt
  • func WithRegistryCredentials(auth map[string]AuthConfig) Opt
  • func WithRegistryMirrors(mirrors map[string][]string) Opt
  • func WithSandboxImage(image string) Opt

Constants

const (
	DefaultDockerVersion = "19.03"
	LegacyDockerVersion  = "18.09"
)

const (
	DefaultContainerdVersion = "1.4"
)

Types

type AuthConfig

type AuthConfig struct {
	// Username is the username to login the registry.
	Username string `toml:"username,omitempty" json:"username,omitempty"`
	// Password is the password to login the registry.
	Password string `toml:"password,omitempty" json:"password,omitempty"`
	// Auth is a base64 encoded string from the concatenation of the username,
	// a colon, and the password.
	Auth string `toml:"auth,omitempty" json:"auth,omitempty"`
	// IdentityToken is used to authenticate the user and get
	// an access token for the registry.
	IdentityToken string `toml:"identitytoken,omitempty" json:"identitytoken,omitempty"`
}

AuthConfig is a COPY of github.com/containerd/containerd/pkg/cri/config.AuthConfig. AuthConfig contains the config related to authentication to a specific registry

type Config

type Config struct {
	Docker              *Docker               `json:",omitempty"`
	Containerd          *Containerd           `json:",omitempty"`
	InsecureRegistries  []string              `json:",omitempty"`
	RegistryMirrors     map[string][]string   `json:",omitempty"`
	RegistryCredentials map[string]AuthConfig `json:",omitempty"`
	SandboxImage        string                `json:",omitempty"`
}

func Get

func Get(containerRuntimeName string, opts ...Opt) Config

func (Config) Engine

func (cfg Config) Engine(kubeletVersion *semver.Version) Engine

func (Config) String

func (cfg Config) String() string

type Containerd

type Containerd struct {
	// contains filtered or unexported fields
}

func (*Containerd) Config

func (eng *Containerd) Config() (string, error)

func (*Containerd) ConfigFileName

func (eng *Containerd) ConfigFileName() string

func (*Containerd) KubeletFlags

func (eng *Containerd) KubeletFlags() []string

func (*Containerd) ScriptFor

func (eng *Containerd) ScriptFor(os types.OperatingSystem) (string, error)

func (*Containerd) String

func (eng *Containerd) String() string

type Docker

type Docker struct {
	// contains filtered or unexported fields
}

func (*Docker) Config

func (eng *Docker) Config() (string, error)

func (*Docker) ConfigFileName

func (eng *Docker) ConfigFileName() string

func (*Docker) KubeletFlags

func (eng *Docker) KubeletFlags() []string

func (*Docker) ScriptFor

func (eng *Docker) ScriptFor(os types.OperatingSystem) (string, error)

func (*Docker) String

func (eng *Docker) String() string

type Engine

type Engine interface {
	KubeletFlags() []string
	ScriptFor(os types.OperatingSystem) (string, error)
	ConfigFileName() string
	Config() (string, error)
	String() string
}

type Opt

type Opt func(*Config)

func WithInsecureRegistries

func WithInsecureRegistries(registries []string) Opt

func WithRegistryCredentials

func WithRegistryCredentials(auth map[string]AuthConfig) Opt

func WithRegistryMirrors

func WithRegistryMirrors(mirrors map[string][]string) Opt

func WithSandboxImage

func WithSandboxImage(image string) Opt