container

Documentation

Index

• type BuildResponse
• type Container
• type DockerContainer
  • func New(nsprefix string, options ...Option) (*DockerContainer, error)
  • func (c *DockerContainer) Build(path string) (tag string, err error)
  • func (c *DockerContainer) CreateNetwork(namespace string) (id string, err error)
  • func (c *DockerContainer) DeleteNetwork(namespace string) error
  • func (c *DockerContainer) DeleteVolume(name string) error
  • func (c *DockerContainer) FindContainer(namespace string) (types.ContainerJSON, error)
  • func (c *DockerContainer) FindNetwork(namespace string) (types.NetworkResource, error)
  • func (c *DockerContainer) FindService(namespace string) (swarm.Service, error)
  • func (c *DockerContainer) ListServices(labels ...string) ([]swarm.Service, error)
  • func (c *DockerContainer) ListTasks(namespace string) ([]swarm.Task, error)
  • func (c *DockerContainer) Namespace(s string) string
  • func (c *DockerContainer) SharedNetworkID() (networkID string, err error)
  • func (c *DockerContainer) StartService(options ServiceOptions) (serviceID string, err error)
  • func (c *DockerContainer) Status(namespace string) (StatusType, error)
  • func (c *DockerContainer) StopService(namespace string) error
  • func (c *DockerContainer) TasksError(namespace string) ([]string, error)
• type Mount
• type Network
• type Option
  • func ClientOption(client docker.CommonAPIClient) Option
  • func TimeoutOption(d time.Duration) Option
• type Port
• type ServiceOptions
• type StatusType

Types

type BuildResponse

type BuildResponse struct {
	Stream string `json:"stream"`
	Error  string `json:"error"`
}

BuildResponse is the object that is returned by the docker api in json

type Container

type Container interface {
	Build(path string) (tag string, err error)
	CreateNetwork(namespace string) (id string, err error)
	DeleteNetwork(namespace string) error
	FindContainer(namespace string) (types.ContainerJSON, error)
	FindNetwork(namespace string) (types.NetworkResource, error)
	FindService(namespace string) (swarm.Service, error)
	ListServices(labels ...string) ([]swarm.Service, error)
	ListTasks(namespace string) ([]swarm.Task, error)
	Namespace(namespace string) string
	SharedNetworkID() (networkID string, err error)
	StartService(options ServiceOptions) (serviceID string, err error)
	Status(namespace string) (StatusType, error)
	StopService(namespace string) (err error)
	TasksError(namespace string) ([]string, 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, options ...Option) (*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) CreateNetwork

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

CreateNetwork creates a Docker Network with a namespace.

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) FindContainer

func (c *DockerContainer) FindContainer(namespace string) (types.ContainerJSON, error)

FindContainer returns a docker container.

func (*DockerContainer) FindNetwork

func (c *DockerContainer) FindNetwork(namespace string) (types.NetworkResource, error)

FindNetwork finds a Docker Network by a namespace. If no network is found, an error is returned.

func (*DockerContainer) FindService

func (c *DockerContainer) FindService(namespace string) (swarm.Service, error)

FindService returns the Docker Service or an error if not found.

func (*DockerContainer) ListServices

func (c *DockerContainer) ListServices(labels ...string) ([]swarm.Service, error)

ListServices returns existing docker services matching a specific label name.

func (*DockerContainer) ListTasks

func (c *DockerContainer) ListTasks(namespace string) ([]swarm.Task, error)

ListTasks returns all the docker tasks.

func (*DockerContainer) Namespace

func (c *DockerContainer) Namespace(s string) string

Namespace creates a namespace from a list of string.

func (*DockerContainer) SharedNetworkID

func (c *DockerContainer) SharedNetworkID() (networkID string, err error)

SharedNetworkID returns the ID of the shared network.

func (*DockerContainer) StartService

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

StartService starts a docker service.

func (*DockerContainer) Status

func (c *DockerContainer) Status(namespace string) (StatusType, error)

Status returns the status of the container based on the docker container and docker service. if any error occurs during the status check, status will be shown as UNKNOWN. otherwise the following rules will be applied to determine a status:

• RUNNING: when the container is running in docker regardless of the status of the service.
• STARTING: when the service is running but the container is not yet started.
• STOPPED: when the container and the service is not running in docker.

func (*DockerContainer) StopService

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

StopService stops a docker service.

func (*DockerContainer) TasksError

func (c *DockerContainer) TasksError(namespace string) ([]string, error)

TasksError returns the error of matching tasks.

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 Option

type Option func(*DockerContainer)

Option is a configuration func for Container.

func ClientOption

func ClientOption(client docker.CommonAPIClient) Option

ClientOption receives a client which will be used to interact with Docker API.

func TimeoutOption

func TimeoutOption(d time.Duration) Option

TimeoutOption receives d which will be set as a timeout value for Docker API calls.

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 // TODO: should be transform to  map[string]string and use the func mapToEnv
	Args            []string
	Command         string
	Networks        []Network
	Labels          map[string]string
	StopGracePeriod *time.Duration
}

ServiceOptions is a simplify version of swarm.ServiceSpec.

type StatusType

type StatusType uint

StatusType of the service.

const (
	UNKNOWN StatusType = iota
	STOPPED
	STARTING
	RUNNING
)

Possible status for services.