engine

Documentation

Index

• Constants
• Variables
• type AppDeploymentConfig
• type ApplicationConfig
• type ChartConfig
• type ChartEngine
  • func NewChartEngine(appConfig ApplicationConfig, extraContributors []Contributor) (ChartEngine, error)
• type Contributor
  • func NewAppModelContributor(appConfig ApplicationConfig) (Contributor, error)
• type Exporter
  • func NewDirectoryExporter() Exporter

Constants

const (
	DefaultApplicationPort     = 8888
	DefaultWorkingDirectory    = "/home/application/current"
	DefaultRoutableProcessName = "web"
	DefaultNumberOfUnits       = 1
)

Variables

var (
	ErrEmptyProcfile         = errors.New("Procfile should contain at least one process name with a command")
	ErrContainerPortNotFound = errors.New("routable process should have a container port")
	ErrServicePortNotFound   = errors.New("routable process should have a service port")
)

Types

type AppDeploymentConfig

type AppDeploymentConfig struct {
	Image           string
	Version         string
	RoutingSettings models.RoutingSettings
}

type ApplicationConfig

type ApplicationConfig struct {
	ProcfileName      string
	ShipaYamlFileName string
	ApplicationPort   int
	WorkingDirectory  string
	AppDeployments    []AppDeploymentConfig
}

type ChartConfig

type ChartConfig struct {
	ChartVersion string
	AppName      string
	AppVersion   string
}

type ChartEngine

type ChartEngine interface {
	Run(values *models.Values) (*models.ApplicationChart, error)
}

func NewChartEngine

func NewChartEngine(appConfig ApplicationConfig, extraContributors []Contributor) (ChartEngine, error)

type Contributor

type Contributor interface {
	ApplyChanges(values *models.Values) error
}

func NewAppModelContributor

func NewAppModelContributor(appConfig ApplicationConfig) (Contributor, error)

type Exporter

type Exporter interface {
	Export(directory string, options ChartConfig, chart models.ApplicationChart) error
}

func NewDirectoryExporter

func NewDirectoryExporter() Exporter