deployment

Documentation

Index

• Constants
• type Manager
• type Mode
• type Opt
  • func WithCtrPath(ctrPath string) Opt
  • func WithMetaPath(metaPath string) Opt
  • func WithMode(mode string) Opt

Constants

const (
	// DeploymentManagerServiceLocalID local ID for the deployment manager service.
	DeploymentManagerServiceLocalID = "container-management.service.local.v1.service-deployment-manager"
)

Types

type Manager

type Manager interface {

	// Deploy initially deploys or updates containers described in configured local path
	Deploy(ctx context.Context) error

	// Dispose stops running deployments
	Dispose(ctx context.Context) error
}

Manager represents the container deployment manager abstraction

type Mode

type Mode string

Mode indicates available deployment modes

const (
	// InitialDeployMode means that the deployment service will deploy new containers only on initial start of container management
	InitialDeployMode Mode = "init"
	// UpdateMode means that the deployment service will deploy new containers and/or update existing containers on each start of container management
	UpdateMode Mode = "update"
)

type Opt

type Opt func(options *opts) error

Opt provides deployment manager options

func WithCtrPath

func WithCtrPath(ctrPath string) Opt

WithCtrPath sets the path to container descriptors

func WithMetaPath

func WithMetaPath(metaPath string) Opt

WithMetaPath configures the directory to be used for storage by the service

func WithMode

func WithMode(mode string) Opt

WithMode sets the mode of deployment service