groot

Documentation

Index

• Constants
• type BaseImage
• type BaseImagePuller
• type BaseImageSpec
• type Cleaner
  • func IamCleaner(locksmith Locksmith, sm StoreMeasurer, gc GarbageCollector) *Cleaner
  • func (c *Cleaner) Clean(logger lager.Logger, threshold uint64, keepImages []string) (bool, error)
• type CreateSpec
• type Creator
  • func IamCreator(imageCloner ImageCloner, baseImagePuller BaseImagePuller, locksmith Locksmith, ...) *Creator
  • func (c *Creator) Create(logger lager.Logger, spec CreateSpec) (Image, error)
• type Deleter
  • func IamDeleter(imageCloner ImageCloner, dependencyManager DependencyManager) *Deleter
  • func (d *Deleter) Delete(logger lager.Logger, id string) error
• type DependencyManager
• type DiskUsage
• type GarbageCollector
• type IDMappingSpec
• type Image
• type ImageCloner
• type ImageSpec
• type Locksmith
• type Metricser
  • func IamMetricser(imageCloner ImageCloner) *Metricser
  • func (m *Metricser) Metrics(logger lager.Logger, id string) (VolumeMetrics, error)
• type RootFSConfigurer
• type StoreMeasurer
• type VolumeMetrics

Constants

const GLOBAL_LOCK_KEY = "global-groot-lock"

const ImageReferenceFormat = "image:%s"

Types

type BaseImage

type BaseImage struct {
	VolumePath string
	BaseImage  specsv1.Image
	ChainIDs   []string
}

type BaseImagePuller

type BaseImagePuller interface {
	Pull(logger lager.Logger, spec BaseImageSpec) (BaseImage, error)
}

type BaseImageSpec

type BaseImageSpec struct {
	DiskLimit                 int64
	ExcludeBaseImageFromQuota bool
	BaseImageSrc              *url.URL
	UIDMappings               []IDMappingSpec
	GIDMappings               []IDMappingSpec
}

type Cleaner

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

func IamCleaner

func IamCleaner(locksmith Locksmith, sm StoreMeasurer, gc GarbageCollector) *Cleaner

func (*Cleaner) Clean

func (c *Cleaner) Clean(logger lager.Logger, threshold uint64, keepImages []string) (bool, error)

type CreateSpec

type CreateSpec struct {
	ID                        string
	BaseImage                 string
	DiskLimit                 int64
	ExcludeBaseImageFromQuota bool
	UIDMappings               []IDMappingSpec
	GIDMappings               []IDMappingSpec
}

type Creator

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

func IamCreator

func IamCreator(imageCloner ImageCloner, baseImagePuller BaseImagePuller, locksmith Locksmith, rootFSConfigurer RootFSConfigurer, dependencyManager DependencyManager) *Creator

func (*Creator) Create

func (c *Creator) Create(logger lager.Logger, spec CreateSpec) (Image, error)

type Deleter

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

func IamDeleter

func IamDeleter(imageCloner ImageCloner, dependencyManager DependencyManager) *Deleter

func (*Deleter) Delete

func (d *Deleter) Delete(logger lager.Logger, id string) error

type DependencyManager

type DependencyManager interface {
	Register(id string, chainIDs []string) error
	Deregister(id string) error
}

type DiskUsage

type DiskUsage struct {
	TotalBytesUsed     int64 `json:"total_bytes_used"`
	ExclusiveBytesUsed int64 `json:"exclusive_bytes_used"`
}

type GarbageCollector

type GarbageCollector interface {
	Collect(logger lager.Logger, keepBaseImages []string) error
}

type IDMappingSpec

type IDMappingSpec struct {
	HostID      int
	NamespaceID int
	Size        int
}

type Image

type Image struct {
	Path       string
	RootFSPath string
}

type ImageCloner

type ImageCloner interface {
	Exists(id string) (bool, error)
	Create(logger lager.Logger, spec ImageSpec) (Image, error)
	Destroy(logger lager.Logger, id string) error
	Metrics(logger lager.Logger, id string) (VolumeMetrics, error)
}

type ImageSpec

type ImageSpec struct {
	ID                        string
	DiskLimit                 int64
	ExcludeBaseImageFromQuota bool
	VolumePath                string
	BaseImage                 specsv1.Image
}

type Locksmith

type Locksmith interface {
	Lock(key string) (*os.File, error)
	Unlock(lockFile *os.File) error
}

type Metricser

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

func IamMetricser

func IamMetricser(imageCloner ImageCloner) *Metricser

func (*Metricser) Metrics

func (m *Metricser) Metrics(logger lager.Logger, id string) (VolumeMetrics, error)

type RootFSConfigurer

type RootFSConfigurer interface {
	Configure(rootFSPath string, baseImage specsv1.Image) error
}

type StoreMeasurer

type StoreMeasurer interface {
	MeasureStore(logger lager.Logger) (uint64, error)
}

type VolumeMetrics

type VolumeMetrics struct {
	DiskUsage DiskUsage `json:"disk_usage"`
}