container

Documentation

Overview

Package container allows for running a process in a container.

Index

• Constants
• Variables
• func EmbedImage(image string) error
• func Spec(opts SpecOpts) *specs.Spec
• type Container
  • func (c *Container) Run() (int, error)
  • func (c *Container) UnpackRootfs(rootfsDir string, asset func(string) ([]byte, error)) error
• type SpecOpts

Constants

const (
	// DefaultApparmorProfile is the default apparmor profile for the containers.
	DefaultApparmorProfile = "docker-default"
)

const (
	// DefaultTarballPath holds the default path for the embedded tarball.
	DefaultTarballPath = "image.tar"
)

Variables

var DefaultSeccompProfile = &specs.LinuxSeccomp{}

DefaultSeccompProfile defines the whitelist for the default seccomp profile.

Functions

func EmbedImage

func EmbedImage(image string) error

EmbedImage pulls a docker image locally. Creates a tarball of it's contents and then embeds the tarball as binary data into an output bindata.go file.

func Spec

func Spec(opts SpecOpts) *specs.Spec

Spec returns a default oci spec with some options being passed.

Types

type Container

type Container struct {
	ID               string
	Spec             *specs.Spec
	PIDFile          string
	ConsoleSocket    string
	Root             string
	Detach           bool
	UseSystemdCgroup bool
	NoPivotRoot      bool
	NoNewKeyring     bool
	Rootless         bool
	HostNetwork      bool
	ShareIPC         bool
}

Container defines the behavior and settings for a container object.

func (*Container) Run

func (c *Container) Run() (int, error)

Run starts the container. It returns the exit status or -1 and an error. Signals sent to the current process will be forwarded to container.

func (*Container) UnpackRootfs

func (c *Container) UnpackRootfs(rootfsDir string, asset func(string) ([]byte, error)) error

UnpackRootfs unpacks the embedded tarball to the rootfs.

type SpecOpts

type SpecOpts struct {
	Rootless bool
	Readonly bool
	Terminal bool
	Args     []string
	Env      []string
	Mounts   []specs.Mount
	Hooks    *specs.Hooks
}

SpecOpts defines the options available for a spec.