oci

Documentation

Index

• type Container
  • func NewContainer(name string, bundlePath string, logPath string, labels map[string]string, ...) (*Container, error)
  • func (c *Container) BundlePath() string
  • func (c *Container) Labels() map[string]string
  • func (c *Container) LogPath() string
  • func (c *Container) Name() string
  • func (c *Container) Sandbox() string
• type ContainerStatus
• type Runtime
  • func New(runtimePath string, containerDir string) (*Runtime, error)
  • func (r *Runtime) ContainerDir() string
  • func (r *Runtime) ContainerStatus(c *Container) *specs.State
  • func (r *Runtime) CreateContainer(c *Container) error
  • func (r *Runtime) DeleteContainer(c *Container) error
  • func (r *Runtime) Name() string
  • func (r *Runtime) Path() string
  • func (r *Runtime) StartContainer(c *Container) error
  • func (r *Runtime) StopContainer(c *Container) error
  • func (r *Runtime) UpdateStatus(c *Container) error
  • func (r *Runtime) Version() (string, error)

Types

type Container

type Container struct {
	// contains filtered or unexported fields
}

Container respresents a runtime container.

func NewContainer

func NewContainer(name string, bundlePath string, logPath string, labels map[string]string, sandbox string) (*Container, error)

NewContainer creates a container object.

func (*Container) BundlePath

func (c *Container) BundlePath() string

BundlePath returns the bundlePath of the container.

func (*Container) Labels

func (c *Container) Labels() map[string]string

Labels returns the labels of the container.

func (*Container) LogPath

func (c *Container) LogPath() string

LogPath returns the log path of the container.

func (*Container) Name

func (c *Container) Name() string

Name returns the name of the container.

func (*Container) Sandbox

func (c *Container) Sandbox() string

Sandbox returns the sandbox name of the container.

type ContainerStatus

type ContainerStatus struct {
}

ContainerStatus represents the status of a container.

type Runtime

type Runtime struct {
	// contains filtered or unexported fields
}

Runtime stores the information about a oci runtime

func New

func New(runtimePath string, containerDir string) (*Runtime, error)

New creates a new Runtime with options provided

func (*Runtime) ContainerDir

func (r *Runtime) ContainerDir() string

ContainerDir returns the path to the base directory for storing container configurations

func (*Runtime) ContainerStatus

func (r *Runtime) ContainerStatus(c *Container) *specs.State

ContainerStatus returns the state of a container.

func (*Runtime) CreateContainer

func (r *Runtime) CreateContainer(c *Container) error

CreateContainer creates a container.

func (*Runtime) DeleteContainer

func (r *Runtime) DeleteContainer(c *Container) error

DeleteContainer deletes a container.

func (*Runtime) Name

func (r *Runtime) Name() string

Name returns the name of the OCI Runtime

func (*Runtime) Path

func (r *Runtime) Path() string

Path returns the full path the OCI Runtime executable

func (*Runtime) StartContainer

func (r *Runtime) StartContainer(c *Container) error

StartContainer starts a container.

func (*Runtime) StopContainer

func (r *Runtime) StopContainer(c *Container) error

StopContainer stops a container.

func (*Runtime) UpdateStatus

func (r *Runtime) UpdateStatus(c *Container) error

updateStatus refreshes the status of the container.

func (*Runtime) Version

func (r *Runtime) Version() (string, error)

Version returns the version of the OCI Runtime