container

Documentation

Index

• Constants
• func CreateContainer(ctx context.Context, params CreateRequest) (string, error)
• func CreateExec(ctx context.Context, containerID string, cmd []string) (string, error)
• func PullImage(ctx context.Context, image string) error
• func RemoveContainer(ctx context.Context, id string) error
• func RunExec(ctx context.Context, containerID string, cmd []string) (string, error)
• func StartContainer(ctx context.Context, id string) error
• func StartExec(ctx context.Context, execID string) (string, error)
• func TerminateByID(ctx context.Context, id string) error
• type Container
  • func List(ctx context.Context, labels map[string]string) ([]*Container, error)
  • func Run(ctx context.Context, req CreateRequest) (*Container, error)
  • func (c *Container) Terminate(ctx context.Context) error
• type CreateRequest
• type DockerExecResponse

Constants

const (
	// LabelManagedBy is the label used to identify containers managed by dbctl
	LabelManagedBy = "managed_by"
	// LabelDBctl is the value of the managed_by label
	LabelDBctl = "dbctl"
)

const (
	// LabelType is the label used to identify the type of database
	LabelType = "dbctl_type"
	// LabelCustom is the label used to identify a database
	LabelCustom = "dbctl_custom"
)

Functions

func CreateContainer

func CreateContainer(ctx context.Context, params CreateRequest) (string, error)

CreateContainer creates a container

func CreateExec

func CreateExec(ctx context.Context, containerID string, cmd []string) (string, error)

func PullImage

func PullImage(ctx context.Context, image string) error

PullImage pulls a docker image

func RemoveContainer

func RemoveContainer(ctx context.Context, id string) error

RemoveContainer removes a container by id

func RunExec

func RunExec(ctx context.Context, containerID string, cmd []string) (string, error)

func StartContainer

func StartContainer(ctx context.Context, id string) error

StartContainer starts a container by id

func StartExec

func StartExec(ctx context.Context, execID string) (string, error)

func TerminateByID

func TerminateByID(ctx context.Context, id string) error

TerminateByID stops and removes a container by id

Types

type Container

type Container struct {
	ID     string
	Name   string
	Labels map[string]string
}

func List

func List(ctx context.Context, labels map[string]string) ([]*Container, error)

List lists all containers with the given labels managed by dbctl

func Run

func Run(ctx context.Context, req CreateRequest) (*Container, error)

Run creates and starts a container

func (*Container) Terminate

func (c *Container) Terminate(ctx context.Context) error

Terminate stops and removes a container

type CreateRequest

type CreateRequest struct {
	Name         string
	Image        string
	ExposedPorts []string // allow specifying protocol info
	Cmd          []string
	Env          map[string]string
	Labels       map[string]string
}

type DockerExecResponse

type DockerExecResponse struct {
	ID string `json:"Id"`
}