container

README

Container module

A Zbus service to start, stop and inspect containers. The service provides the interface defined here

Dependency

The module depends on the flister module to mount the container rootfs

Example usage

package main

import (
	"github.com/threefoldtech/zbus"
	"github.com/threefoldtech/zos/pkg"
	"github.com/threefoldtech/zos/pkg/stubs"
)

func main() {
	client, err := zbus.NewRedisClient("tcp://localhost:6379")
	if err != nil {
		panic(client)
	}

	containerd := stubs.NewContainerModuleStub(client)
	namespace := "example"

	// make sure u have a network namespace ready using ip
	// sudo ip netns add mynetns

	info := pkg.Container{
		Name: "test",
		FList: "https://hub.grid.tf/thabet/redis.flist",
		Env: []string{},
		Network: pkg.NetworkInfo{Namespace: "mynetns"},
		Mounts: nil,
		Entrypoint: "redis-server",
	}

	id, err := containerd.Run(namespace, info)

	if err != nil {
		panic(err)
	}

	// DO WORK WITH CONTAINER ...

	if err = containerd.Delete(namespace, id); err != nil {
		panic(err)
	}

}

Documentation

Index

• Variables
• func WithCPUCount(cru uint) oci.SpecOpts
• func WithMemoryLimit(limit uint64) oci.SpecOpts
• type Module
  • func New(client zbus.Client, root string, containerd string) *Module
  • func (c *Module) Delete(ns string, id pkg.ContainerID) error
  • func (c *Module) Inspect(ns string, id pkg.ContainerID) (result pkg.Container, err error)
  • func (c *Module) List(ns string) ([]pkg.ContainerID, error)
  • func (c *Module) ListNS() ([]string, error)
  • func (c *Module) Run(ns string, data pkg.Container) (id pkg.ContainerID, err error)
  • func (c *Module) Watch(ctx context.Context)

Variables

var (
	// ErrEmptyRootFS is returned when RootFS field is empty when trying to create a container
	ErrEmptyRootFS = errors.New("RootFS of the container creation data cannot be empty")
)

Functions

func WithCPUCount

func WithCPUCount(cru uint) oci.SpecOpts

WithCPUCount configure the CPU cgroup to limit the amount of CPU used by the container

func WithMemoryLimit

func WithMemoryLimit(limit uint64) oci.SpecOpts

WithMemoryLimit sets the `Linux.LinuxResources.Memory.Limit` section to the `limit` specified if the `Linux` section is not `nil`. Additionally sets the `Windows.WindowsResources.Memory.Limit` section if the `Windows` section is not `nil`.

Types

type Module

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

Module implements pkg.Module interface

func New

func New(client zbus.Client, root string, containerd string) *Module

New return an new pkg.ContainerModule

func (*Module) Delete

func (c *Module) Delete(ns string, id pkg.ContainerID) error

Delete stops and remove a container

func (*Module) Inspect

func (c *Module) Inspect(ns string, id pkg.ContainerID) (result pkg.Container, err error)

Inspect returns the detail about a running container

func (*Module) List

func (c *Module) List(ns string) ([]pkg.ContainerID, error)

List all the existing container IDs from a certain namespace ns

func (*Module) ListNS

func (c *Module) ListNS() ([]string, error)

ListNS list the name of all the container namespaces

func (*Module) Run

func (c *Module) Run(ns string, data pkg.Container) (id pkg.ContainerID, err error)

Run creates and starts a container

func (*Module) Watch

func (c *Module) Watch(ctx context.Context)

Watch start watching for events coming from containerd. Blocks forever. caller need to run this in a go routine

different events types are handled differently. Now, only TaskExit event is handled.