docker

Documentation

Index

• Constants
• Variables
• func BuildImage(tag, path, dockerfile string) error
• func GetAuthConfig() (map[string]types.AuthConfig, error)
• func IsDockerRunning() (bool, error)
• func PullImage(image string) error
• func Run(opts ...RunOpt) error
• type AuthHelper
• type OutputKey
• type RunCommand
• type RunConfig
• type RunOpt
  • func RunWithCommand(cmd []string) RunOpt
  • func RunWithEntrypoint(entrypoint []string) RunOpt
  • func RunWithImage(image string) RunOpt
  • func RunWithMounts(mounts []mount.Mount) RunOpt
  • func RunWithShell(shell []string) RunOpt
  • func RunWithWorkingDir(dir string) RunOpt

Constants

const (
	StatusOutput OutputKey  = "status"
	StreamOutput OutputKey  = "stream"
	Gcloud       AuthHelper = "gcloud"
)

Variables

var (
	ErrCannotRedeclare = errors.New("cannot be declared more than once")
)

Functions

func BuildImage

func BuildImage(tag, path, dockerfile string) error

func GetAuthConfig

func GetAuthConfig() (map[string]types.AuthConfig, error)

func IsDockerRunning

func IsDockerRunning() (bool, error)

func PullImage

func PullImage(image string) error

func Run

func Run(opts ...RunOpt) error

Types

type AuthHelper

type AuthHelper = string

type OutputKey

type OutputKey string

type RunCommand

type RunCommand interface {
	GetCommand() ([]string, error)
}

type RunConfig

type RunConfig struct {
	Config        *container.Config
	HostConfig    *container.HostConfig
	NetworkConfig *network.NetworkingConfig
	Platform      *specs.Platform
	Name          string
}

type RunOpt

type RunOpt func(*RunConfig) error

func RunWithCommand

func RunWithCommand(cmd []string) RunOpt

func RunWithEntrypoint

func RunWithEntrypoint(entrypoint []string) RunOpt

func RunWithImage

func RunWithImage(image string) RunOpt

func RunWithMounts

func RunWithMounts(mounts []mount.Mount) RunOpt

func RunWithShell

func RunWithShell(shell []string) RunOpt

func RunWithWorkingDir

func RunWithWorkingDir(dir string) RunOpt