imagemanager

Documentation

Index

• Constants
• Variables
• func DockerImageStatus(ctx context.Context, client docker.ImageAPIClient, images []DockerImage) ([]entitystore.Entity, error)
• func NewController(config *ControllerConfig, store entitystore.EntityStore, ...) controller.Controller
• type BaseImage
• type BaseImageBuilder
  • func NewBaseImageBuilder(es entitystore.EntityStore) (*BaseImageBuilder, error)
• type ControllerConfig
• type DockerImage
• type Handlers
  • func NewHandlers(imageBuilder *ImageBuilder, baseImageBuilder *BaseImageBuilder, ...) *Handlers
  • func (h *Handlers) ConfigureHandlers(api middleware.RoutableAPI)
• type Image
  • func (i *Image) GetDockerURL() string
• type ImageBuilder
  • func NewImageBuilder(es entitystore.EntityStore, registryHost, registryAuth string) (*ImageBuilder, error)
• type RuntimeDependencies
• type SystemDependencies
• type SystemPackage

Constants

const (
	// StatusINITIALIZED captures enum value "INITIALIZED"
	StatusINITIALIZED entitystore.Status = "INITIALIZED"
	// StatusCREATING captures enum value "CREATING"
	StatusCREATING entitystore.Status = "CREATING"
	// StatusUPDATING capture enum value "UPDATING"
	StatusUPDATING entitystore.Status = "UPDATING"
	// StatusREADY captures enum value "READY"
	StatusREADY entitystore.Status = "READY"
	// StatusERROR captures enum value "ERROR"
	StatusERROR entitystore.Status = "ERROR"
	// StatusDELETED captures enum value "DELETED"
	StatusDELETED entitystore.Status = "DELETED"
)

Variables

var ImageManagerFlags = struct {
	Config       string `long:"config" description:"Path to Config file" default:"./config.dev.json"`
	DbFile       string `long:"db-file" description:"Backend DB URL/Path" default:"./db.bolt"`
	DbBackend    string `long:"db-backend" description:"Backend DB Name" default:"boltdb"`
	DbUser       string `long:"db-username" description:"Backend DB Username" default:"dispatch"`
	DbPassword   string `long:"db-password" description:"Backend DB Password" default:"dispatch"`
	DbDatabase   string `long:"db-database" description:"Backend DB Name" default:"dispatch"`
	ResyncPeriod int    `long:"resync-period" description:"The time period (in seconds) to sync with image repository" default:"10"`
	Tracer       string `long:"tracer" description:"Open Tracing Tracer endpoint" default:""`
}{}

ImageManagerFlags are configuration flags for the image manager

Functions

func DockerImageStatus

func DockerImageStatus(ctx context.Context, client docker.ImageAPIClient, images []DockerImage) ([]entitystore.Entity, error)

DockerImageStatus gathers the status of multiple docker images

func NewController

func NewController(config *ControllerConfig, store entitystore.EntityStore, baseImageBuilder *BaseImageBuilder, imageBuilder *ImageBuilder) controller.Controller

NewController creates a new image manager controller

Types

type BaseImage

type BaseImage struct {
	entitystore.BaseEntity
	DockerURL string `json:"dockerUrl"`
	Language  string `json:"language"`
}

BaseImage defines a base image type

type BaseImageBuilder

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

BaseImageBuilder manages base images, which are referenced docker images

func NewBaseImageBuilder

func NewBaseImageBuilder(es entitystore.EntityStore) (*BaseImageBuilder, error)

NewBaseImageBuilder is the constructor for the BaseImageBuilder

type ControllerConfig

type ControllerConfig struct {
	ResyncPeriod time.Duration
}

ControllerConfig defines the image manager controller configuration

type DockerImage

type DockerImage interface {
	entitystore.Entity
	GetDockerURL() string
}

DockerImage defines the docker image interface

type Handlers

type Handlers struct {
	Store   entitystore.EntityStore
	Watcher controller.Watcher
	// contains filtered or unexported fields
}

Handlers encapsulates the image manager handlers

func NewHandlers

func NewHandlers(imageBuilder *ImageBuilder, baseImageBuilder *BaseImageBuilder, watcher controller.Watcher, store entitystore.EntityStore) *Handlers

NewHandlers is the constructor for the Handlers type

func (*Handlers) ConfigureHandlers

func (h *Handlers) ConfigureHandlers(api middleware.RoutableAPI)

ConfigureHandlers registers the image manager handlers to the API

type Image

type Image struct {
	entitystore.BaseEntity
	DockerURL           string              `json:"dockerUrl"`
	Language            string              `json:"language"`
	BaseImageName       string              `json:"baseImageName"`
	RuntimeDependencies RuntimeDependencies `json:"runtimeDependencies"`
	SystemDependencies  SystemDependencies  `json:"systemDependencies"`
}

Image defines an image type

func (*Image) GetDockerURL

func (i *Image) GetDockerURL() string

GetDockerURL returns the docker URL for the image

type ImageBuilder

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

ImageBuilder manages building images

func NewImageBuilder

func NewImageBuilder(es entitystore.EntityStore, registryHost, registryAuth string) (*ImageBuilder, error)

NewImageBuilder is the constructor for the ImageBuilder

type RuntimeDependencies

type RuntimeDependencies struct {
	Manifest string `json:"manifest"`
}

RuntimeDependencies defines a runtime dependency type

type SystemDependencies

type SystemDependencies struct {
	Packages []SystemPackage `json:"packages"`
}

SystemDependencies defines a system dependency type

type SystemPackage

type SystemPackage struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

SystemPackage defines a system package type