docker

Documentation

Overview

Package docker has utilities to work with Docker.

Index

• type Helper
  • func NewHelper() *Helper
  • func (_ *Helper) GetClient() (client *docker.Client, endpoint string, err error)
  • func (h *Helper) GetClientOrExit() (*docker.Client, string)
  • func (_ *Helper) InstallFlags(flags *pflag.FlagSet)

Types

type Helper

type Helper struct {
}

Helper contains all the valid config options for connecting to Docker from a command line.

func NewHelper

func NewHelper() *Helper

NewHelper creates a Flags object with the default values set. Use this to use consistent Docker client loading behavior from different contexts.

func (*Helper) GetClient

func (_ *Helper) GetClient() (client *docker.Client, endpoint string, err error)

GetClient returns a valid Docker client, the address of the client, or an error if the client couldn't be created.

func (*Helper) GetClientOrExit

func (h *Helper) GetClientOrExit() (*docker.Client, string)

GetClientOrExit returns a valid Docker client and the address of the client, or prints an error and exits.

func (*Helper) InstallFlags

func (_ *Helper) InstallFlags(flags *pflag.FlagSet)

InstallFlags installs the Docker flag helper into a FlagSet with the default options and default values from the Helper object.