docker

Documentation

Index

• func Exec(ctx context.Context, container string, options ExecOptions, command string, ...) error
• func ExecInteractive(ctx context.Context, container string, options ExecOptions, command string, ...) error
• func Info(ctx context.Context) (string, *semver.Version, error)
• func PortForward(ctx context.Context, container string, source, target int) error
• func Pull(ctx context.Context, image, platform string, options PullOptions) error
• func Run(ctx context.Context, image string, options RunOptions, args ...string) error
• func RunInteractive(ctx context.Context, image string, options RunOptions, args ...string) error
• type ExecOptions
• type PullOptions
• type RunOptions

Functions

func Exec

func Exec(ctx context.Context, container string, options ExecOptions, command string, args ...string) error

func ExecInteractive

func ExecInteractive(ctx context.Context, container string, options ExecOptions, command string, args ...string) error

func Info

func Info(ctx context.Context) (string, *semver.Version, error)

func PortForward

func PortForward(ctx context.Context, container string, source, target int) error

func Pull

func Pull(ctx context.Context, image, platform string, options PullOptions) error

func Run

func Run(ctx context.Context, image string, options RunOptions, args ...string) error

func RunInteractive

func RunInteractive(ctx context.Context, image string, options RunOptions, args ...string) error

Types

type ExecOptions

type ExecOptions struct {
	Privileged bool

	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer

	TTY         bool
	Interactive bool

	Dir  string
	User string

	Env map[string]string
}

type PullOptions

type PullOptions struct {
	Stdout io.Writer
	Stderr io.Writer
}

type RunOptions

type RunOptions struct {
	Name string

	Platform string

	Temporary  bool
	Privileged bool

	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer

	Attach      bool
	TTY         bool
	Interactive bool

	Dir  string
	User string

	Env     map[string]string
	Ports   []engine.ContainerPort
	Volumes []engine.ContainerMount
}