gardener

Documentation

Index

• type Containerizer
• type DesiredContainerSpec
• type Gardener
  • func (g *Gardener) BulkInfo(handles []string) (map[string]garden.ContainerInfoEntry, error)
  • func (g *Gardener) BulkMetrics(handles []string) (map[string]garden.ContainerMetricsEntry, error)
  • func (g *Gardener) Capacity() (garden.Capacity, error)
  • func (g *Gardener) Containers(garden.Properties) ([]garden.Container, error)
  • func (g *Gardener) Create(spec garden.ContainerSpec) (garden.Container, error)
  • func (g *Gardener) Destroy(handle string) error
  • func (g *Gardener) GraceTime(garden.Container) time.Duration
  • func (g *Gardener) Lookup(handle string) (garden.Container, error)
  • func (g *Gardener) Ping() error
  • func (g *Gardener) Stop()
• type Networker
• type Starter
• type UidGenerator
• type UidGeneratorFunc
  • func (fn UidGeneratorFunc) Generate() string

Types

type Containerizer

type Containerizer interface {
	Create(spec DesiredContainerSpec) error
	Run(handle string, spec garden.ProcessSpec, io garden.ProcessIO) (garden.Process, error)
	Destroy(handle string) error
}

type DesiredContainerSpec

type DesiredContainerSpec struct {
	Handle string

	// Path to the Root Filesystem for the container
	RootFSPath string

	// Path to a Network Namespace to enter
	NetworkPath string
}

type Gardener

type Gardener struct {
	// Containerizer runs and manages linux containers
	Containerizer Containerizer

	// UidGenerator generates unique ids for containers
	UidGenerator UidGenerator

	// Starter runs any needed start-up tasks (e.g. setting up cgroups)
	Starter

	// Networker creates a network for containers
	Networker Networker
}

Gardener orchestrates other components to implement the Garden API

func (*Gardener) BulkInfo

func (g *Gardener) BulkInfo(handles []string) (map[string]garden.ContainerInfoEntry, error)

func (*Gardener) BulkMetrics

func (g *Gardener) BulkMetrics(handles []string) (map[string]garden.ContainerMetricsEntry, error)

func (*Gardener) Capacity

func (g *Gardener) Capacity() (garden.Capacity, error)

func (*Gardener) Containers

func (g *Gardener) Containers(garden.Properties) ([]garden.Container, error)

func (*Gardener) Create

func (g *Gardener) Create(spec garden.ContainerSpec) (garden.Container, error)

func (*Gardener) Destroy

func (g *Gardener) Destroy(handle string) error

func (*Gardener) GraceTime

func (g *Gardener) GraceTime(garden.Container) time.Duration

func (*Gardener) Lookup

func (g *Gardener) Lookup(handle string) (garden.Container, error)

func (*Gardener) Ping

func (g *Gardener) Ping() error

func (*Gardener) Stop

func (g *Gardener) Stop()

type Networker

type Networker interface {
	Network(network string) (string, error)
}

type Starter

type Starter interface {
	Start() error
}

type UidGenerator

type UidGenerator interface {
	Generate() string
}

type UidGeneratorFunc

type UidGeneratorFunc func() string

func (UidGeneratorFunc) Generate

func (fn UidGeneratorFunc) Generate() string