docker

Documentation

Index

• Variables
• func CheckDockerConfig() error
• func CopyFileToVolume(ctx context.Context, volumeName string, sourcePath string, destPath string) error
• func CopyFromContainer(ctx context.Context, containerName string, sourcePath string, destPath string) error
• func CreateVolume(ctx context.Context, volumeName string) error
• func GetImageConfig(image string) (map[string]interface{}, error)
• func GetImageDigest(image string) (string, error)
• func GetImageLabel(image, label string) (string, error)
• func MkdirInVolume(ctx context.Context, volumeName string, directory string) error
• func RemoveVolume(ctx context.Context, volumeName string) error
• func RunDockerCommand(ctx context.Context, workingDir string, command ...string) error
• func RunDockerCommandBuffered(ctx context.Context, workingDir string, command ...string) (string, error)
• func RunDockerCommandRetry(ctx context.Context, workingDir string, retries int, command ...string) error
• func RunDockerComposeCommand(ctx context.Context, workingDir string, command ...string) error
• type CtxIsLogCmd
• type DependsOn
• type DockerComposeConfig
  • func CreateDockerCompose(s *types.Stack) *DockerComposeConfig
• type HealthCheck
• type LoggingConfig
• type Service
• type ServiceDefinition

Variables

var StandardLogOptions = &LoggingConfig{
	Driver: "json-file",
	Options: map[string]string{
		"max-size": "10m",
		"max-file": "1",
	},
}

Functions

func CheckDockerConfig

func CheckDockerConfig() error

CheckDockerConfig is a function to check docker and docker-compose configuration on the host

func CopyFileToVolume

func CopyFileToVolume(ctx context.Context, volumeName string, sourcePath string, destPath string) error

func CopyFromContainer

func CopyFromContainer(ctx context.Context, containerName string, sourcePath string, destPath string) error

func CreateVolume

func CreateVolume(ctx context.Context, volumeName string) error

func GetImageConfig

func GetImageConfig(image string) (map[string]interface{}, error)

func GetImageDigest

func GetImageDigest(image string) (string, error)

func GetImageLabel

func GetImageLabel(image, label string) (string, error)

func MkdirInVolume

func MkdirInVolume(ctx context.Context, volumeName string, directory string) error

func RemoveVolume

func RemoveVolume(ctx context.Context, volumeName string) error

func RunDockerCommand

func RunDockerCommand(ctx context.Context, workingDir string, command ...string) error

func RunDockerCommandBuffered

func RunDockerCommandBuffered(ctx context.Context, workingDir string, command ...string) (string, error)

func RunDockerCommandRetry

func RunDockerCommandRetry(ctx context.Context, workingDir string, retries int, command ...string) error

func RunDockerComposeCommand

func RunDockerComposeCommand(ctx context.Context, workingDir string, command ...string) error

Types

type CtxIsLogCmd

type CtxIsLogCmd struct{}

type DependsOn

type DependsOn map[string]map[string]string

type DockerComposeConfig

type DockerComposeConfig struct {
	Version  string              `yaml:"version,omitempty"`
	Services map[string]*Service `yaml:"services,omitempty"`
	Volumes  map[string]struct{} `yaml:"volumes,omitempty"`
}

func CreateDockerCompose

func CreateDockerCompose(s *types.Stack) *DockerComposeConfig

type HealthCheck

type HealthCheck struct {
	Test     []string `yaml:"test,omitempty"`
	Interval string   `yaml:"interval,omitempty"`
	Timeout  string   `yaml:"timeout,omitempty"`
	Retries  int      `yaml:"retries,omitempty"`
}

type LoggingConfig

type LoggingConfig struct {
	Driver  string            `yaml:"driver,omitempty"`
	Options map[string]string `yaml:"options,omitempty"`
}

type Service

type Service struct {
	ContainerName string                       `yaml:"container_name,omitempty"`
	Image         string                       `yaml:"image,omitempty"`
	Build         string                       `yaml:"build,omitempty"`
	User          string                       `yaml:"user,omitempty"`
	Command       string                       `yaml:"command,omitempty"`
	Environment   map[string]interface{}       `yaml:"environment,omitempty"`
	Volumes       []string                     `yaml:"volumes,omitempty"`
	Ports         []string                     `yaml:"ports,omitempty"`
	DependsOn     map[string]map[string]string `yaml:"depends_on,omitempty"`
	HealthCheck   *HealthCheck                 `yaml:"healthcheck,omitempty"`
	Logging       *LoggingConfig               `yaml:"logging,omitempty"`
	WorkingDir    string                       `yaml:"working_dir,omitempty"`
	EntryPoint    []string                     `yaml:"entrypoint,omitempty"`
	EnvFile       string                       `yaml:"env_file,omitempty"`
	Expose        []int                        `yaml:"expose,omitempty"`
}

type ServiceDefinition

type ServiceDefinition struct {
	ServiceName string
	Service     *Service
	VolumeNames []string
}