ctr

Documentation

Index

• Variables
• type Container
  • func (c *Container) Attach(stdin, tty bool) (string, error)
  • func (c *Container) Commit() (*storage.Image, error)
  • func (c *Container) Create() error
  • func (c *Container) Exec(cmd []string, tty bool, stdin bool) (string, error)
  • func (c *Container) Export(path string) error
  • func (c *Container) Kill(signal uint) error
  • func (c *Container) Mount() (string, error)
  • func (c *Container) Start() error
  • func (c *Container) Status() error
  • func (c *Container) Stop() error

Variables

var (
	// ErrNotImplemented indicates that functionality is not yet implemented
	ErrNotImplemented = fmt.Errorf("NOT IMPLEMENTED")
)

Types

type Container

type Container struct {
}

Container is a single OCI container

func (*Container) Attach

func (c *Container) Attach(stdin, tty bool) (string, error)

Attach attaches to a container Returns fully qualified URL of streaming server for the container

func (*Container) Commit

func (c *Container) Commit() (*storage.Image, error)

Commit commits the changes between a container and its image, creating a new image If the container was not created from an image (for example, WithRootFSFromPath will create a container from a directory on the system), a new base image will be created from the contents of the container's filesystem

func (*Container) Create

func (c *Container) Create() error

Create creates a container in the OCI runtime

func (*Container) Exec

func (c *Container) Exec(cmd []string, tty bool, stdin bool) (string, error)

Exec starts a new process inside the container Returns fully qualified URL of streaming server for executed process

func (*Container) Export

func (c *Container) Export(path string) error

Export exports a container's root filesystem as a tar archive The archive will be saved as a file at the given path

func (*Container) Kill

func (c *Container) Kill(signal uint) error

Kill sends a signal to a container

func (*Container) Mount

func (c *Container) Mount() (string, error)

Mount mounts a container's filesystem on the host The path where the container has been mounted is returned

func (*Container) Start

func (c *Container) Start() error

Start starts a container

func (*Container) Status

func (c *Container) Status() error

Status gets a container's status TODO this should return relevant information about container state

func (*Container) Stop

func (c *Container) Stop() error

Stop stops a container