container

Documentation

Index

• func MapToEnv(data map[string]string) []string
• func Namespace(ss []string) string
• type BuildResponse
• type Container
  • func New(options ...Option) (*Container, error)
  • func (c *Container) Build(path string) (tag string, err error)
  • func (c *Container) CreateNetwork(namespace []string) (id string, err error)
  • func (c *Container) DeleteNetwork(namespace []string) error
  • func (c *Container) FindContainer(namespace []string) (types.ContainerJSON, error)
  • func (c *Container) FindNetwork(namespace []string) (types.NetworkResource, error)
  • func (c *Container) FindService(namespace []string) (swarm.Service, error)
  • func (c *Container) ListServices(label string) ([]swarm.Service, error)
  • func (c *Container) ListTasks(namespace []string) ([]swarm.Task, error)
  • func (c *Container) ServiceLogs(namespace []string) (io.ReadCloser, error)
  • func (c *Container) ServiceStatus(namespace []string) (StatusType, error)
  • func (c *Container) SharedNetworkID() (networkID string, err error)
  • func (c *Container) StartService(options ServiceOptions) (serviceID string, err error)
  • func (c *Container) Status(namespace []string) (StatusType, error)
  • func (c *Container) StopService(namespace []string) (err error)
  • func (c *Container) TasksError(namespace []string) ([]string, error)
• type Mount
• type Option
  • func ClientOption(client docker.CommonAPIClient) Option
  • func TimeoutOption(d time.Duration) Option
• type Port
• type ServiceOptions
• type StatusType

Functions

func MapToEnv

func MapToEnv(data map[string]string) []string

MapToEnv transform a map of key value to a array of env string

func Namespace

func Namespace(ss []string) string

Namespace creates a namespace from a list of string.

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 struct {
	// contains filtered or unexported fields
}

Container provides high level interactions with Docker API for MESG.

func New

func New(options ...Option) (*Container, error)

New creates a new Container with given options.

func (*Container) Build

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

Build builds a docker image.

func (*Container) CreateNetwork

func (c *Container) CreateNetwork(namespace []string) (id string, err error)

CreateNetwork creates a Docker Network with a namespace.

func (*Container) DeleteNetwork

func (c *Container) DeleteNetwork(namespace []string) error

DeleteNetwork deletes a Docker Network associated with a namespace.

func (*Container) FindContainer

func (c *Container) FindContainer(namespace []string) (types.ContainerJSON, error)

FindContainer returns a docker container.

func (*Container) FindNetwork

func (c *Container) FindNetwork(namespace []string) (types.NetworkResource, error)

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

func (*Container) FindService

func (c *Container) FindService(namespace []string) (swarm.Service, error)

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

func (*Container) ListServices

func (c *Container) ListServices(label string) ([]swarm.Service, error)

ListServices returns existing docker services matching a specific label name.

func (*Container) ListTasks

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

ListTasks returns all the docker tasks.

func (*Container) ServiceLogs

func (c *Container) ServiceLogs(namespace []string) (io.ReadCloser, error)

ServiceLogs returns the logs of a service.

func (*Container) ServiceStatus

func (c *Container) ServiceStatus(namespace []string) (StatusType, error)

ServiceStatus returns the status of the Docker Swarm Servicer.

func (*Container) SharedNetworkID

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

SharedNetworkID returns the ID of the shared network.

func (*Container) StartService

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

StartService starts a docker service.

func (*Container) Status

func (c *Container) Status(namespace []string) (StatusType, error)

Status returns the status of a docker container.

func (*Container) StopService

func (c *Container) StopService(namespace []string) (err error)

StopService stops a docker service.

func (*Container) TasksError

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

TasksError returns the error of matching tasks.

type Mount

type Mount struct {
	Source string
	Target string
}

Mount is a simplify version of mount.Mount.

type Option

type Option func(*Container)

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
	NetworksID []string
	Labels     map[string]string
}

ServiceOptions is a simplify version of swarm.ServiceSpec.

type StatusType

type StatusType uint

StatusType of the service.

const (
	STOPPED StatusType = 0
	RUNNING StatusType = 1
)

Possible status for services.