docker

Documentation

Index

• Constants
• func GetByName(name string) (*types.Container, error)
• func ImageBuild(opts ImageBuildOptions) (*types.ImageSummary, error)
• func ImageList(listFilters []string) ([]types.ImageSummary, error)
• func ImageRemove(id string, force bool) (err error)
• func Kill(containerID string) (err error)
• func List(listFilters []string) (list []types.Container, err error)
• func Remove(containerID string, forceRemove bool) (err error)
• func Start(opts ContainerStartOptions) (*types.Container, error)
• type ContainerCreated
  • func Create(opts *CreateOptions) (*ContainerCreated, error)
• type ContainerEvent
• type ContainerStartOptions
• type CreateOptions
• type ExecOptions
• type ExecResult
  • func Exec(opts ExecOptions) (*ExecResult, error)
• type ImageBuildOptions

Constants

const CmdEnvKey = "MUFAASSOURCECMD"

const DefaultLabel = "mufaas"

DefaultLabel for containers

Functions

func GetByName

func GetByName(name string) (*types.Container, error)

GetByName return a container by name

func ImageBuild

func ImageBuild(opts ImageBuildOptions) (*types.ImageSummary, error)

ImageBuild builds a docker image from the image directory

func ImageList

func ImageList(listFilters []string) ([]types.ImageSummary, error)

List return built images, filtered by a list of docker compatible filters (key=value) eg. [id=..., name=...]

func ImageRemove

func ImageRemove(id string, force bool) (err error)

ImageRemove remove an image

func Kill

func Kill(containerID string) (err error)

Kill a running container

func List

func List(listFilters []string) (list []types.Container, err error)

List containers

func Remove

func Remove(containerID string, forceRemove bool) (err error)

Remove a container

func Start

func Start(opts ContainerStartOptions) (*types.Container, error)

Start a container

Types

type ContainerCreated

type ContainerCreated struct {
	ID   string
	Name string
}

func Create

func Create(opts *CreateOptions) (*ContainerCreated, error)

Create a new container

type ContainerEvent

type ContainerEvent struct {
	ID      string
	Name    string
	Action  string
	Message events.Message
}

ContainerEvent store a container event

type ContainerStartOptions

type ContainerStartOptions struct {
	Name      string
	ImageName string
}

type CreateOptions

type CreateOptions struct {
	Name       string
	Image      string
	Cmd        []string
	Env        []string
	Privileged bool
}

type ExecOptions

type ExecOptions struct {
	Name       string
	Cmd        []string
	Env        []string
	Stdin      []byte
	Args       []string
	Privileged bool
	// Timeout in second to stop the container
	Timeout int64
	Remove  bool
}

ExecOptions control how a container is executed

type ExecResult

type ExecResult struct {
	ID     string
	Stdout *bytes.Buffer
	Stderr *bytes.Buffer
}

ExecResult return the execution results

func Exec

func Exec(opts ExecOptions) (*ExecResult, error)

Exec spawn a container and wait for its output

type ImageBuildOptions

type ImageBuildOptions struct {
	Name       string
	Type       string
	TypesPath  []string
	Archive    string
	Dockerfile string
	Labels     map[string]string
}