swarm

package

v1.2.9 Latest Latest Go to latest Published: Jun 1, 2018 License: Apache-2.0, CC-BY-SA-4.0 Imports: 22 Imported by: 60

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/swarm

Links

Open Source Insights

Documentation ¶

Index ¶

func NewCluster(scheduler *scheduler.Scheduler, TLSConfig *tls.Config, ...) (cluster.Cluster, error)
type Cluster

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewCluster ¶

func NewCluster(scheduler *scheduler.Scheduler, TLSConfig *tls.Config, discovery discovery.Backend, options cluster.DriverOpts, engineOptions *cluster.EngineOpts) (cluster.Cluster, error)

NewCluster is exported.

Types ¶

type Cluster ¶

type Cluster struct {
	sync.RWMutex

	cluster.ClusterEventHandlers

	TLSConfig *tls.Config
	// contains filtered or unexported fields
}

Cluster is exported.

func (*Cluster) BuildImage ¶ added in v0.4.0

func (c *Cluster) BuildImage(buildContext io.Reader, buildImage *types.ImageBuildOptions, callback func(msg cluster.JSONMessageWrapper)) error

BuildImage builds an image

func (*Cluster) Container ¶

func (c *Cluster) Container(IDOrName string) *cluster.Container

Container returns the container with IDOrName in the cluster

func (*Cluster) Containers ¶

func (c *Cluster) Containers() cluster.Containers

Containers returns all the containers in the cluster.

func (*Cluster) CreateContainer ¶

func (c *Cluster) CreateContainer(config *cluster.ContainerConfig, name string, authConfig *types.AuthConfig) (*cluster.Container, error)

CreateContainer aka schedule a brand new container into the cluster.

func (*Cluster) CreateNetwork ¶ added in v1.0.0

func (c *Cluster) CreateNetwork(name string, request *types.NetworkCreate) (response *types.NetworkCreateResponse, err error)

CreateNetwork creates a network in the cluster.

func (*Cluster) CreateVolume ¶ added in v1.0.0

func (c *Cluster) CreateVolume(request *volume.VolumesCreateBody) (*types.Volume, error)

CreateVolume creates a volume in the cluster.

func (*Cluster) Image ¶

func (c *Cluster) Image(IDOrName string) *cluster.Image

Image returns an image with IDOrName in the cluster

func (*Cluster) Images ¶

func (c *Cluster) Images() cluster.Images

Images returns all the images in the cluster.

func (*Cluster) Import ¶ added in v0.3.0

func (c *Cluster) Import(source string, ref string, tag string, imageReader io.Reader, callback func(msg cluster.JSONMessageWrapper))

Import imports image.

func (*Cluster) Info ¶

func (c *Cluster) Info() [][2]string

Info returns some info about the cluster, like nb or containers / images.

func (*Cluster) Load ¶ added in v0.3.0

func (c *Cluster) Load(imageReader io.Reader, callback func(msg cluster.JSONMessageWrapper))

Load loads image.

func (*Cluster) Networks ¶ added in v1.0.0

func (c *Cluster) Networks() cluster.Networks

Networks returns all the networks in the cluster.

func (*Cluster) NewAPIEventHandler ¶ added in v1.2.9

func (c *Cluster) NewAPIEventHandler() *cluster.APIEventHandler

NewAPIEventHandler creates a new API events handler

func (*Cluster) Pull ¶

func (c *Cluster) Pull(name string, authConfig *types.AuthConfig, callback func(msg cluster.JSONMessageWrapper))

Pull is exported.

func (*Cluster) RANDOMENGINE ¶ added in v0.3.0

func (c *Cluster) RANDOMENGINE() (*cluster.Engine, error)

RANDOMENGINE returns a random engine.

func (*Cluster) RefreshEngine ¶ added in v1.2.9

func (c *Cluster) RefreshEngine(hostname string) error

RefreshEngine refreshes all containers in a specific engine.

func (*Cluster) RefreshEngines ¶ added in v1.2.9

func (c *Cluster) RefreshEngines() error

RefreshEngines refreshes all containers in the cluster.

func (*Cluster) RemoveContainer ¶

func (c *Cluster) RemoveContainer(container *cluster.Container, force, volumes bool) error

RemoveContainer aka Remove a container from the cluster.

func (*Cluster) RemoveImages ¶ added in v0.3.0

func (c *Cluster) RemoveImages(name string, force bool) ([]types.ImageDeleteResponseItem, error)

RemoveImages removes all the images that match `name` from the cluster.

func (*Cluster) RemoveNetwork ¶ added in v1.0.0

func (c *Cluster) RemoveNetwork(network *cluster.Network) error

RemoveNetwork removes a network from the cluster.

func (*Cluster) RemoveVolumes ¶ added in v1.0.0

func (c *Cluster) RemoveVolumes(name string) (bool, error)

RemoveVolumes removes all the volumes that match `name` from the cluster.

func (*Cluster) RenameContainer ¶ added in v0.3.0

func (c *Cluster) RenameContainer(container *cluster.Container, newName string) error

RenameContainer renames a container

func (*Cluster) StartContainer ¶ added in v1.2.9

func (c *Cluster) StartContainer(container *cluster.Container) error

StartContainer starts a container.

func (*Cluster) TagImage ¶ added in v1.0.0

func (c *Cluster) TagImage(IDOrName string, ref string, force bool) error

TagImage tags an image.

func (*Cluster) TotalCpus ¶ added in v0.3.0

func (c *Cluster) TotalCpus() int64

TotalCpus returns the total CPUs of the cluster.

func (*Cluster) TotalMemory ¶ added in v0.3.0

func (c *Cluster) TotalMemory() int64

TotalMemory returns the total memory of the cluster.

func (*Cluster) Volumes ¶ added in v1.0.0

func (c *Cluster) Volumes() cluster.Volumes

Volumes returns all the volumes in the cluster.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL