config

Documentation

Index

• Constants
• func Dir() string
• func WithDir(path string)
• func WriteCurrentContext(dir string, name string) error
• type ContextKey
• type File
  • func LoadFile(dir string) (*File, error)

Constants

const (
	// ConfigFileName is the name of config file
	ConfigFileName = "config.json"
	// ConfigFileDir is the default folder where the config file is stored
	ConfigFileDir = ".docker"
	// ConfigFlagName is the name of the config flag
	ConfigFlagName = "config"
)

Functions

func Dir

func Dir() string

Dir returns the config directory path

func WithDir

func WithDir(path string)

WithDir sets the config directory path in the context

func WriteCurrentContext

func WriteCurrentContext(dir string, name string) error

WriteCurrentContext writes the selected current context to the Docker configuration file. Note, the validity of the context is not checked.

Types

type ContextKey

type ContextKey string

ContextKey defines a type for keys in the context passed

const ContextTypeKey ContextKey = "context_type"

ContextTypeKey is the key for context type stored in context.Context

type File

type File struct {
	CurrentContext string                       `json:"currentContext,omitempty"`
	Plugins        map[string]map[string]string `json:"plugins,omitempty"`
}

File contains the current context from the docker configuration file

func LoadFile

func LoadFile(dir string) (*File, error)

LoadFile loads the docker configuration