api

Documentation

Index

• Constants
• Variables
• func AcceptConnections(job *engine.Job) engine.Status
• func AttachProfiler(router *mux.Router)
• func ListenAndServe(proto, addr string, job *engine.Job) error
• func MatchesContentType(contentType, expectedType string) bool
• func ServeApi(job *engine.Job) engine.Status
• func ServeFd(addr string, handle http.Handler) error
• func ServeRequest(eng *engine.Engine, apiversion version.Version, w http.ResponseWriter, ...) error
• func ValidateHost(val string) (string, error)
• type Container
• type DockerCli
  • func NewDockerCli(in io.ReadCloser, out, err io.Writer, proto, addr string, ...) *DockerCli
  • func (cli *DockerCli) CmdAttach(args ...string) error
  • func (cli *DockerCli) CmdBuild(args ...string) error
  • func (cli *DockerCli) CmdCommit(args ...string) error
  • func (cli *DockerCli) CmdCp(args ...string) error
  • func (cli *DockerCli) CmdDiff(args ...string) error
  • func (cli *DockerCli) CmdEvents(args ...string) error
  • func (cli *DockerCli) CmdExport(args ...string) error
  • func (cli *DockerCli) CmdHelp(args ...string) error
  • func (cli *DockerCli) CmdHistory(args ...string) error
  • func (cli *DockerCli) CmdImages(args ...string) error
  • func (cli *DockerCli) CmdImport(args ...string) error
  • func (cli *DockerCli) CmdInfo(args ...string) error
  • func (cli *DockerCli) CmdInsert(args ...string) error
  • func (cli *DockerCli) CmdInspect(args ...string) error
  • func (cli *DockerCli) CmdKill(args ...string) error
  • func (cli *DockerCli) CmdLoad(args ...string) error
  • func (cli *DockerCli) CmdLogin(args ...string) error
  • func (cli *DockerCli) CmdLogs(args ...string) error
  • func (cli *DockerCli) CmdPort(args ...string) error
  • func (cli *DockerCli) CmdPs(args ...string) error
  • func (cli *DockerCli) CmdPull(args ...string) error
  • func (cli *DockerCli) CmdPush(args ...string) error
  • func (cli *DockerCli) CmdRestart(args ...string) error
  • func (cli *DockerCli) CmdRm(args ...string) error
  • func (cli *DockerCli) CmdRmi(args ...string) error
  • func (cli *DockerCli) CmdRun(args ...string) error
  • func (cli *DockerCli) CmdSave(args ...string) error
  • func (cli *DockerCli) CmdSearch(args ...string) error
  • func (cli *DockerCli) CmdStart(args ...string) error
  • func (cli *DockerCli) CmdStop(args ...string) error
  • func (cli *DockerCli) CmdTag(args ...string) error
  • func (cli *DockerCli) CmdTop(args ...string) error
  • func (cli *DockerCli) CmdVersion(args ...string) error
  • func (cli *DockerCli) CmdWait(args ...string) error
  • func (cli *DockerCli) LoadConfigFile() (err error)
  • func (cli *DockerCli) ParseCommands(args ...string) error
  • func (cli *DockerCli) Subcmd(name, signature, description string) *flag.FlagSet
  • func (cli *DockerCli) WalkTree(noTrunc bool, images *engine.Table, byParent map[string]*engine.Table, ...)
• type HttpApiFunc

Constants

const (
	APIVERSION        = "1.10"
	DEFAULTHTTPHOST   = "127.0.0.1"
	DEFAULTUNIXSOCKET = "/var/run/docker.sock"
)

Variables

var (
	ErrConnectionRefused = errors.New("Cannot connect to the Docker daemon. Is 'docker -d' running on this host?")
)

Functions

func AcceptConnections

func AcceptConnections(job *engine.Job) engine.Status

func AttachProfiler

func AttachProfiler(router *mux.Router)

func ListenAndServe

func ListenAndServe(proto, addr string, job *engine.Job) error

ListenAndServe sets up the required http.Server and gets it listening for each addr passed in and does protocol specific checking.

func MatchesContentType

func MatchesContentType(contentType, expectedType string) bool

func ServeApi

func ServeApi(job *engine.Job) engine.Status

ServeApi loops through all of the protocols sent in to docker and spawns off a go routine to setup a serving http.Server for each.

func ServeFd

func ServeFd(addr string, handle http.Handler) error

ServeFD creates an http.Server and sets it up to serve given a socket activated argument.

func ServeRequest

func ServeRequest(eng *engine.Engine, apiversion version.Version, w http.ResponseWriter, req *http.Request) error

ServeRequest processes a single http request to the docker remote api. FIXME: refactor this to be part of Server and not require re-creating a new router each time. This requires first moving ListenAndServe into Server.

func ValidateHost

func ValidateHost(val string) (string, error)

Types

type Container

type Container struct {
	Config     runconfig.Config
	HostConfig runconfig.HostConfig
	State      struct {
		Running  bool
		ExitCode int
	}
	NetworkSettings struct {
		Ports nat.PortMap
	}
}

type DockerCli

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

func NewDockerCli

func NewDockerCli(in io.ReadCloser, out, err io.Writer, proto, addr string, tlsConfig *tls.Config) *DockerCli

func (*DockerCli) CmdAttach

func (cli *DockerCli) CmdAttach(args ...string) error

func (*DockerCli) CmdBuild

func (cli *DockerCli) CmdBuild(args ...string) error

func (*DockerCli) CmdCommit

func (cli *DockerCli) CmdCommit(args ...string) error

func (*DockerCli) CmdCp

func (cli *DockerCli) CmdCp(args ...string) error

func (*DockerCli) CmdDiff

func (cli *DockerCli) CmdDiff(args ...string) error

func (*DockerCli) CmdEvents

func (cli *DockerCli) CmdEvents(args ...string) error

func (*DockerCli) CmdExport

func (cli *DockerCli) CmdExport(args ...string) error

func (*DockerCli) CmdHelp

func (cli *DockerCli) CmdHelp(args ...string) error

func (*DockerCli) CmdHistory

func (cli *DockerCli) CmdHistory(args ...string) error

func (*DockerCli) CmdImages

func (cli *DockerCli) CmdImages(args ...string) error

func (*DockerCli) CmdImport

func (cli *DockerCli) CmdImport(args ...string) error

func (*DockerCli) CmdInfo

func (cli *DockerCli) CmdInfo(args ...string) error

'docker info': display system-wide information.

func (*DockerCli) CmdInsert

func (cli *DockerCli) CmdInsert(args ...string) error

func (*DockerCli) CmdInspect

func (cli *DockerCli) CmdInspect(args ...string) error

func (*DockerCli) CmdKill

func (cli *DockerCli) CmdKill(args ...string) error

'docker kill NAME' kills a running container

func (*DockerCli) CmdLoad

func (cli *DockerCli) CmdLoad(args ...string) error

func (*DockerCli) CmdLogin

func (cli *DockerCli) CmdLogin(args ...string) error

'docker login': login / register a user to registry service.

func (*DockerCli) CmdLogs

func (cli *DockerCli) CmdLogs(args ...string) error

func (*DockerCli) CmdPort

func (cli *DockerCli) CmdPort(args ...string) error

func (*DockerCli) CmdPs

func (cli *DockerCli) CmdPs(args ...string) error

func (*DockerCli) CmdPull

func (cli *DockerCli) CmdPull(args ...string) error

func (*DockerCli) CmdPush

func (cli *DockerCli) CmdPush(args ...string) error

func (*DockerCli) CmdRestart

func (cli *DockerCli) CmdRestart(args ...string) error

func (*DockerCli) CmdRm

func (cli *DockerCli) CmdRm(args ...string) error

func (*DockerCli) CmdRmi

func (cli *DockerCli) CmdRmi(args ...string) error

'docker rmi IMAGE' removes all images with the name IMAGE

func (*DockerCli) CmdRun

func (cli *DockerCli) CmdRun(args ...string) error

func (*DockerCli) CmdSave

func (cli *DockerCli) CmdSave(args ...string) error

func (*DockerCli) CmdSearch

func (cli *DockerCli) CmdSearch(args ...string) error

func (*DockerCli) CmdStart

func (cli *DockerCli) CmdStart(args ...string) error

func (*DockerCli) CmdStop

func (cli *DockerCli) CmdStop(args ...string) error

func (*DockerCli) CmdTag

func (cli *DockerCli) CmdTag(args ...string) error

func (*DockerCli) CmdTop

func (cli *DockerCli) CmdTop(args ...string) error

func (*DockerCli) CmdVersion

func (cli *DockerCli) CmdVersion(args ...string) error

'docker version': show version information

func (*DockerCli) CmdWait

func (cli *DockerCli) CmdWait(args ...string) error

'docker wait': block until a container stops

func (*DockerCli) LoadConfigFile

func (cli *DockerCli) LoadConfigFile() (err error)

func (*DockerCli) ParseCommands

func (cli *DockerCli) ParseCommands(args ...string) error

func (*DockerCli) Subcmd

func (cli *DockerCli) Subcmd(name, signature, description string) *flag.FlagSet

func (*DockerCli) WalkTree

func (cli *DockerCli) WalkTree(noTrunc bool, images *engine.Table, byParent map[string]*engine.Table, prefix string, printNode func(cli *DockerCli, noTrunc bool, image *engine.Env, prefix string))

type HttpApiFunc

type HttpApiFunc func(eng *engine.Engine, version version.Version, w http.ResponseWriter, r *http.Request, vars map[string]string) error