mirror of https://github.com/docker/docs.git
100 lines
2.9 KiB
Go
100 lines
2.9 KiB
Go
package cluster
|
|
|
|
import (
|
|
"io"
|
|
|
|
dockerfilters "github.com/docker/docker/pkg/parsers/filters"
|
|
"github.com/samalba/dockerclient"
|
|
)
|
|
|
|
// Cluster is exported
|
|
type Cluster interface {
|
|
// Create a container
|
|
CreateContainer(config *ContainerConfig, name string) (*Container, error)
|
|
|
|
// Remove a container
|
|
RemoveContainer(container *Container, force, volumes bool) error
|
|
|
|
// Return all images
|
|
Images(all bool, filters dockerfilters.Args) []*Image
|
|
|
|
// Return one image matching `IDOrName`
|
|
Image(IDOrName string) *Image
|
|
|
|
// Remove images from the cluster
|
|
RemoveImages(name string, force bool) ([]*dockerclient.ImageDelete, error)
|
|
|
|
// Return all containers
|
|
Containers() Containers
|
|
|
|
// Return container the matching `IDOrName`
|
|
// TODO: remove this method from the interface as we can use
|
|
// cluster.Containers().Get(IDOrName)
|
|
Container(IDOrName string) *Container
|
|
|
|
// Return all networks
|
|
Networks() Networks
|
|
|
|
// Create a network
|
|
CreateNetwork(request *dockerclient.NetworkCreate) (*dockerclient.NetworkCreateResponse, error)
|
|
|
|
// Remove a network from the cluster
|
|
RemoveNetwork(network *Network) error
|
|
|
|
// Create a volume
|
|
CreateVolume(request *dockerclient.VolumeCreateRequest) (*Volume, error)
|
|
|
|
// Return all volumes
|
|
Volumes() []*Volume
|
|
|
|
// Return one volume from the cluster
|
|
Volume(name string) *Volume
|
|
|
|
// Remove volumes from the cluster
|
|
RemoveVolumes(name string) (bool, error)
|
|
|
|
// Pull images
|
|
// `callback` can be called multiple time
|
|
// `where` is where it is being pulled
|
|
// `status` is the current status, like "", "in progress" or "downloaded
|
|
Pull(name string, authConfig *dockerclient.AuthConfig, callback func(where, status string, err error))
|
|
|
|
// Import image
|
|
// `callback` can be called multiple time
|
|
// `where` is where it is being imported
|
|
// `status` is the current status, like "", "in progress" or "imported"
|
|
Import(source string, repository string, tag string, imageReader io.Reader, callback func(where, status string, err error))
|
|
|
|
// Load images
|
|
// `callback` can be called multiple time
|
|
// `what` is what is being loaded
|
|
// `status` is the current status, like "", "in progress" or "loaded"
|
|
Load(imageReader io.Reader, callback func(what, status string, err error))
|
|
|
|
// Return some info about the cluster, like nb or containers / images
|
|
// It is pretty open, so the implementation decides what to return.
|
|
Info() [][]string
|
|
|
|
// Return the total memory of the cluster
|
|
TotalMemory() int64
|
|
|
|
// Return the number of CPUs in the cluster
|
|
TotalCpus() int64
|
|
|
|
// Register an event handler for cluster-wide events.
|
|
RegisterEventHandler(h EventHandler) error
|
|
|
|
// FIXME: remove this method
|
|
// Return a random engine
|
|
RANDOMENGINE() (*Engine, error)
|
|
|
|
// RenameContainer rename a container
|
|
RenameContainer(container *Container, newName string) error
|
|
|
|
// BuildImage build an image
|
|
BuildImage(*dockerclient.BuildImage, io.Writer) error
|
|
|
|
// TagImage tag an image
|
|
TagImage(IDOrName string, repo string, tag string, force bool) error
|
|
}
|