docker

Documentation

Index

• type Client
  • func NewDockerClient(config *configuration.Configuration) *Client
  • func (c *Client) CheckContainerStatus(containerID string) (myContainer.Status, error)
  • func (c *Client) GetDockerEngineTotalResources() (int, int, int)
  • func (c *Client) RemoveContainer(containerID string) error
  • func (c *Client) RunContainer(contConfig caravelaTypes.ContainerConfig) (*caravelaTypes.ContainerStatus, error)
  • func (c *Client) Start() <-chan *events.Event

Types

type Client

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

Client interfaces with docker Golang's SDK/Client.

func NewDockerClient

func NewDockerClient(config *configuration.Configuration) *Client

NewDockerClient creates a new docker client to interact with the local Docker Engine.

func (*Client) CheckContainerStatus

func (c *Client) CheckContainerStatus(containerID string) (myContainer.Status, error)

CheckContainerStatus checks the container status (running, stopped, etc)

func (*Client) GetDockerEngineTotalResources

func (c *Client) GetDockerEngineTotalResources() (int, int, int)

Get CPUs and Memory dedicated to Docker engine (Decided by the user in Docker configuration).

func (*Client) RemoveContainer

func (c *Client) RemoveContainer(containerID string) error

RemoveContainer removes a container from the Docker engine (to avoid filling space in the node).

func (*Client) RunContainer

func (c *Client) RunContainer(contConfig caravelaTypes.ContainerConfig) (*caravelaTypes.ContainerStatus, error)

RunContainer launches a container from an image in the local Docker Engine.

func (*Client) Start

func (c *Client) Start() <-chan *events.Event