container

Documentation

Index

• type Container
• type DockerContainer
  • func New(nsprefix string) (*DockerContainer, error)
  • func (c *DockerContainer) Build(path string) (tag string, err error)
  • func (c *DockerContainer) Cleanup() error
  • func (c *DockerContainer) CreateNetwork(namespace string) (string, error)
  • func (c *DockerContainer) DeleteNetwork(namespace string) error
  • func (c *DockerContainer) DeleteVolume(name string) error
  • func (c *DockerContainer) SharedNetworkID() string
  • func (c *DockerContainer) StartService(options ServiceOptions) (string, error)
  • func (c *DockerContainer) StopService(namespace string) error
• type Mount
• type Network
• type Port
• type ServiceOptions
• type Status

Types

type Container

type Container interface {
	Build(path string) (tag string, err error)
	CreateNetwork(namespace string) (id string, err error)
	DeleteNetwork(namespace string) error
	SharedNetworkID() string
	StartService(options ServiceOptions) (serviceID string, err error)
	StopService(namespace string) (err error)
	DeleteVolume(name string) error
}

Container describes the API of container package.

type DockerContainer

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

DockerContainer provides high level interactions with Docker API for MESG.

func New

func New(nsprefix string) (*DockerContainer, error)

New creates a new Container with given options.

func (*DockerContainer) Build

func (c *DockerContainer) Build(path string) (tag string, err error)

Build builds a docker image.

func (*DockerContainer) Cleanup

func (c *DockerContainer) Cleanup() error

Cleanup cleans all configuration like shared network of running services.

func (*DockerContainer) CreateNetwork

func (c *DockerContainer) CreateNetwork(namespace string) (string, error)

CreateNetwork creates a Docker Network with a namespace. Retruns network id and error.

func (*DockerContainer) DeleteNetwork

func (c *DockerContainer) DeleteNetwork(namespace string) error

DeleteNetwork deletes a Docker Network associated with a namespace.

func (*DockerContainer) DeleteVolume

func (c *DockerContainer) DeleteVolume(name string) error

DeleteVolume deletes a Docker Volume by name.

func (*DockerContainer) SharedNetworkID

func (c *DockerContainer) SharedNetworkID() string

SharedNetworkID returns the ID of the shared network.

func (*DockerContainer) StartService

func (c *DockerContainer) StartService(options ServiceOptions) (string, error)

StartService starts a docker service.

func (*DockerContainer) StopService

func (c *DockerContainer) StopService(namespace string) error

StopService stops a docker service.

type Mount

type Mount struct {
	Source string
	Target string
	Bind   bool
}

Mount is a simplify version of mount.Mount.

type Network

type Network struct {
	// ID of the docker network.
	ID string

	// Alias is an optional attribute to name this service in the
	// network and be able to access to it using this name.
	Alias string
}

Network keeps the network info for service.

type Port

type Port struct {
	Target    uint32
	Published uint32
}

Port is a simplify version of swarm.PortConfig.

type ServiceOptions

type ServiceOptions struct {
	Image           string
	Namespace       string
	Ports           []Port
	Mounts          []Mount
	Env             []string
	Args            []string
	Command         string
	Networks        []Network
	Labels          map[string]string
	StopGracePeriod *time.Duration
}

ServiceOptions is a simplify version of swarm.ServiceSpec.

type Status

type Status uint

Status of the service.

const (
	UNKNOWN Status = iota
	STOPPED
	STARTING
	RUNNING
)

Possible status for services.