Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

docker

package

Go to main page

Versions in this module

v0

v0.11.2

Feb 28, 2024

v0.11.1

Oct 31, 2021

Changes in this version

+ const ContainerSource

+ const DaemonSource

+ const DefaultCapacity

+ const DefaultConnectionTimeout

+ const DefaultDockerHost

+ const ImageSource

+ const LabelNamespace

+ const NetworkSource

+ const NodeSource

+ const PluginSource

+ const SecretSource

+ const ServiceSource

+ const ShortLen

+ const VolumeSource

+ const Whale

+ const Whale0

+ const Whale1

+ const Whale2

+ const Whale3

+ const Whale4

+ const Whale5

+ const Whale6

+ const Whale7

+ var CommandDescriptions = justDescriptions(ContainerCommands)

+ var ContainerCommands = []CommandDescription

+ func DurationForHumans(duration int64) string

+ func GetBool(key string) (value bool)

+ func ImageID(uglyID string) string

+ func IsContainerRunning(container *Container) bool

+ func NewNodeAvailability(availability string) swarm.NodeAvailability

+ func ShortImageID(uglyID string) string

+ func SortContainers(containers []*Container, mode SortMode)

+ func SortImages(images []types.ImageSummary, mode SortMode)

+ func SortNetworks(networks []types.NetworkResource, mode SortMode)

+ func SortNodes(nodes []swarm.Node, mode SortMode)

+ func SortServices(services []swarm.Service, mode SortMode)

+ func SortStacks(stacks []Stack, mode SortMode)

+ func SortTasks(tasks []swarm.Task, mode SortMode)

+ func TruncateID(id string) string

+ type CallbackRegistry interface

+ Register func(actor SourceType, callback EventCallback)

+ var GlobalRegistry CallbackRegistry

+ type Command int

+ const HISTORY

+ const INSPECT

+ const KILL

+ const LOGS

+ const RESTART

+ const RM

+ const STATS

+ const STOP

+ func CommandFromDescription(d string) (Command, error)

+ type CommandDescription struct

+ Command Command

+ Description string

+ type Container struct

+ type ContainerAPI interface

+ ContainerByID func(id string) *Container

+ Containers func(filter []ContainerFilter, mode SortMode) []*Container

+ Inspect func(id string) (types.ContainerJSON, error)

+ IsContainerRunning func(id string) bool

+ Kill func(id string) error

+ Logs func(id string, since string, withTimeStamp bool) (io.ReadCloser, error)

+ RemoveAllStoppedContainers func() (int, error)

+ RestartContainer func(id string) error

+ StopContainer func(id string) error

+ type ContainerDaemon interface

+ DiskUsage func() (types.DiskUsage, error)

+ DockerEnv func() Env

+ EventLog func() *EventLog

+ Events func() (<-chan events.Message, chan<- struct{}, error)

+ Info func() (types.Info, error)

+ InspectImage func(id string) (types.ImageInspect, error)

+ Ok func() (bool, error)

+ Prune func() (*PruneReport, error)

+ Refresh func(notify func(error))

+ RemoveNetwork func(id string) error

+ Rm func(id string) error

+ Version func() (*types.Version, error)

+ type ContainerFilter func(*Container) bool

+ var ContainerFilters ContainerFilter

+ func (cf ContainerFilter) Apply(c []*Container) []*Container

+ func (cf ContainerFilter) ByID(id string) ContainerFilter

+ func (cf ContainerFilter) ByName(name string) ContainerFilter

+ func (cf ContainerFilter) ByRunningState(running bool) ContainerFilter

+ func (cf ContainerFilter) NotRunning() ContainerFilter

+ func (cf ContainerFilter) Running() ContainerFilter

+ func (cf ContainerFilter) Unfiltered() ContainerFilter

+ type ContainerRuntime interface

+ StatsChannel func(container *Container) (*StatsChannel, error)

+ Top func(ctx context.Context, id string) (container.ContainerTopOKBody, error)

+ type ContainerStore interface

+ Get func(id string) *Container

+ List func() []*Container

+ Remove func(id string)

+ Size func() int

+ func NewDockerContainerStore(client dockerAPI.ContainerAPIClient) (ContainerStore, error)

+ type DockerDaemon struct

+ func ConnectToDaemon(env Env) (*DockerDaemon, error)

+ func (daemon *DockerDaemon) ContainerByID(cid string) *Container

+ func (daemon *DockerDaemon) Containers(filters []ContainerFilter, mode SortMode) []*Container

+ func (daemon *DockerDaemon) DiskUsage() (dockerTypes.DiskUsage, error)

+ func (daemon *DockerDaemon) DockerEnv() Env

+ func (daemon *DockerDaemon) EventLog() *EventLog

+ func (daemon *DockerDaemon) Events() (<-chan dockerEvents.Message, chan<- struct{}, error)

+ func (daemon *DockerDaemon) History(id string) ([]image.HistoryResponseItem, error)

+ func (daemon *DockerDaemon) ImageByID(id string) (dockerTypes.ImageSummary, error)

+ func (daemon *DockerDaemon) Images() ([]dockerTypes.ImageSummary, error)

+ func (daemon *DockerDaemon) Info() (dockerTypes.Info, error)

+ func (daemon *DockerDaemon) Inspect(id string) (dockerTypes.ContainerJSON, error)

+ func (daemon *DockerDaemon) InspectImage(name string) (dockerTypes.ImageInspect, error)

+ func (daemon *DockerDaemon) IsContainerRunning(id string) bool

+ func (daemon *DockerDaemon) Kill(id string) error

+ func (daemon *DockerDaemon) Logs(id string, since string, withTimeStamps bool) (io.ReadCloser, error)

+ func (daemon *DockerDaemon) NetworkInspect(id string) (dockerTypes.NetworkResource, error)

+ func (daemon *DockerDaemon) Networks() ([]dockerTypes.NetworkResource, error)

+ func (daemon *DockerDaemon) Node(id string) (*swarm.Node, error)

+ func (daemon *DockerDaemon) NodeChangeAvailability(nodeID string, availability swarm.NodeAvailability) error

+ func (daemon *DockerDaemon) NodeTasks(nodeID string) ([]swarm.Task, error)

+ func (daemon *DockerDaemon) Nodes() ([]swarm.Node, error)

+ func (daemon *DockerDaemon) Ok() (bool, error)

+ func (daemon *DockerDaemon) Prune() (*PruneReport, error)

+ func (daemon *DockerDaemon) Refresh(notify func(error))

+ func (daemon *DockerDaemon) RemoveAllStoppedContainers() (int, error)

+ func (daemon *DockerDaemon) RemoveDanglingImages() (int, error)

+ func (daemon *DockerDaemon) RemoveNetwork(id string) error

+ func (daemon *DockerDaemon) RemoveUnusedImages() (int, error)

+ func (daemon *DockerDaemon) ResolveNode(id string) (string, error)

+ func (daemon *DockerDaemon) ResolveService(id string) (string, error)

+ func (daemon *DockerDaemon) RestartContainer(id string) error

+ func (daemon *DockerDaemon) Rm(id string) error

+ func (daemon *DockerDaemon) Rmi(name string, force bool) ([]dockerTypes.ImageDeleteResponseItem, error)

+ func (daemon *DockerDaemon) RunImage(image dockerTypes.ImageSummary, command string) error

+ func (daemon *DockerDaemon) Service(id string) (*swarm.Service, error)

+ func (daemon *DockerDaemon) ServiceLogs(id string, since string, withTimestamps bool) (io.ReadCloser, error)

+ func (daemon *DockerDaemon) ServiceRemove(id string) error

+ func (daemon *DockerDaemon) ServiceScale(id string, replicas uint64) error

+ func (daemon *DockerDaemon) ServiceTasks(services ...string) ([]swarm.Task, error)

+ func (daemon *DockerDaemon) ServiceUpdate(id string) error

+ func (daemon *DockerDaemon) Services() ([]swarm.Service, error)

+ func (daemon *DockerDaemon) StackConfigs(stack string) ([]swarm.Config, error)

+ func (daemon *DockerDaemon) StackNetworks(stack string) ([]types.NetworkResource, error)

+ func (daemon *DockerDaemon) StackRemove(stack string) error

+ func (daemon *DockerDaemon) StackSecrets(stack string) ([]swarm.Secret, error)

+ func (daemon *DockerDaemon) StackServices(stack string) ([]swarm.Service, error)

+ func (daemon *DockerDaemon) StackTasks(stack string) ([]swarm.Task, error)

+ func (daemon *DockerDaemon) Stacks() ([]Stack, error)

+ func (daemon *DockerDaemon) StatsChannel(container *Container) (*StatsChannel, error)

+ func (daemon *DockerDaemon) StopContainer(id string) error

+ func (daemon *DockerDaemon) Task(id string) (swarm.Task, error)

+ func (daemon *DockerDaemon) Top(ctx context.Context, id string) (container.ContainerTopOKBody, error)

+ func (daemon *DockerDaemon) Version() (*dockerTypes.Version, error)

+ func (daemon *DockerDaemon) VolumeInspect(ctx context.Context, volumeID string) (dockerTypes.Volume, error)

+ func (daemon *DockerDaemon) VolumeList(ctx context.Context) ([]*dockerTypes.Volume, error)

+ func (daemon *DockerDaemon) VolumePrune(ctx context.Context) (int, error)

+ func (daemon *DockerDaemon) VolumeRemove(ctx context.Context, volumeID string, force bool) error

+ func (daemon *DockerDaemon) VolumeRemoveAll(ctx context.Context) (int, error)

+ type Env struct

+ DockerAPIVersion string

+ DockerCertPath string

+ DockerHost string

+ DockerTLSVerify bool

+ func NewEnv() Env

+ type EventCallback func(ctx context.Context, event events.Message) error

+ type EventLog struct

+ func NewEventLog() *EventLog

+ func (el *EventLog) Capacity() int

+ func (el *EventLog) Count() int

+ func (el *EventLog) Events() []events.Message

+ func (el *EventLog) Init(capacity int)

+ func (el *EventLog) Peek() *events.Message

+ func (el *EventLog) Push(message *events.Message)

+ type ImageAPI interface

+ History func(id string) ([]image.HistoryResponseItem, error)

+ ImageByID func(id string) (types.ImageSummary, error)

+ Images func() ([]types.ImageSummary, error)

+ RemoveDanglingImages func() (int, error)

+ RemoveUnusedImages func() (int, error)

+ Rmi func(id string, force bool) ([]types.ImageDeleteResponseItem, error)

+ RunImage func(image types.ImageSummary, command string) error

+ type NetworkAPI interface

+ NetworkInspect func(id string) (types.NetworkResource, error)

+ Networks func() ([]types.NetworkResource, error)

+ type PruneReport struct

+ ContainerReport types.ContainersPruneReport

+ ImagesReport types.ImagesPruneReport

+ NetworksReport types.NetworksPruneReport

+ VolumesReport types.VolumesPruneReport

+ func (p *PruneReport) TotalSpaceReclaimed() uint64

+ type Resolver interface

+ Resolve func(ctx context.Context, t interface{}, id string) (string, error)

+ type SortMode uint16

+ const NoSort

+ const NoSortImages

+ const NoSortNetworks

+ const NoSortNode

+ const NoSortService

+ const NoSortStack

+ const NoSortTask

+ const SortByContainerID

+ const SortByImage

+ const SortByName

+ const SortByNodeCPU

+ const SortByNodeMem

+ const SortByNodeName

+ const SortByNodeRole

+ const SortByNodeStatus

+ const SortByServiceImage

+ const SortByServiceName

+ const SortByStackName

+ const SortByStatus

+ const SortByTaskDesiredState

+ const SortByTaskImage

+ const SortByTaskService

+ const SortByTaskState

+ const SortImagesByCreationDate

+ const SortImagesByID

+ const SortImagesByRepo

+ const SortImagesBySize

+ const SortNetworksByContainerCount

+ const SortNetworksByDriver

+ const SortNetworksByID

+ const SortNetworksByName

+ const SortNetworksByServiceCount

+ const SortNetworksBySubnet

+ type SourceType string

+ type Stack struct

+ Configs int

+ Name string

+ Networks int

+ Orchestrator string

+ Secrets int

+ Services int

+ type Stats struct

+ BlockRead float64

+ BlockWrite float64

+ CID string

+ CPUPercentage float64

+ Command string

+ Error error

+ Memory float64

+ MemoryLimit float64

+ MemoryPercentage float64

+ NetworkRx float64

+ NetworkTx float64

+ PidsCurrent uint64

+ ProcessList *container.ContainerTopOKBody

+ Stats *types.StatsJSON

+ type StatsChannel struct

+ Container *Container

+ func (s *StatsChannel) Start(ctx context.Context) <-chan *Stats

+ type SwarmAPI interface

+ Node func(id string) (*swarm.Node, error)

+ NodeChangeAvailability func(nodeID string, availability swarm.NodeAvailability) error

+ NodeTasks func(nodeID string) ([]swarm.Task, error)

+ Nodes func() ([]swarm.Node, error)

+ ResolveNode func(id string) (string, error)

+ ResolveService func(id string) (string, error)

+ Service func(id string) (*swarm.Service, error)

+ ServiceLogs func(id string, since string, withTimeStamps bool) (io.ReadCloser, error)

+ ServiceRemove func(id string) error

+ ServiceScale func(id string, replicas uint64) error

+ ServiceTasks func(services ...string) ([]swarm.Task, error)

+ ServiceUpdate func(id string) error

+ Services func() ([]swarm.Service, error)

+ StackConfigs func(stack string) ([]swarm.Config, error)

+ StackNetworks func(stack string) ([]types.NetworkResource, error)

+ StackRemove func(id string) error

+ StackSecrets func(stack string) ([]swarm.Secret, error)

+ StackTasks func(stack string) ([]swarm.Task, error)

+ Stacks func() ([]Stack, error)

+ Task func(id string) (swarm.Task, error)

+ type VolumesAPI interface

+ VolumeInspect func(ctx context.Context, volumeID string) (dockerTypes.Volume, error)

+ VolumeList func(ctx context.Context) ([]*dockerTypes.Volume, error)

+ VolumePrune func(ctx context.Context) (int, error)

+ VolumeRemove func(ctx context.Context, volumeID string, force bool) error

+ VolumeRemoveAll func(ctx context.Context) (int, error)

v0.3.0-beta

Dec 18, 2015

v0.2.0-beta

Dec 15, 2015

v0.1.0-beta

Dec 8, 2015