configuration

Documentation

Index

• type AppReference
  • func NewAppReference(reference string) (*AppReference, error)
• type Autopilot
• type Chapter
• type Check
• type Config
• type ConfigData
• type ExecutionPlan
  • func (e *ExecutionPlan) String() string
• type Header
• type Item
  • func (i *Item) String() string
• type Manual
• type Metadata
• type Repository
• type Requirement

Types

type AppReference

type AppReference struct {
	Repository string
	Name       string
	Version    string
}

func NewAppReference

func NewAppReference(reference string) (*AppReference, error)

type Autopilot

type Autopilot struct {
	Name string
	Run  string
	Env  map[string]string
}

type Chapter

type Chapter struct {
	Id    string
	Title string
	Text  string
}

type Check

type Check struct {
	Id    string
	Title string
}

type Config

type Config interface {
	// Migrates the configuration file to the next version
	Migrate() ([]byte, error)
	// Parse the config to the internal data structure
	Parse() (*ExecutionPlan, error)
}

type ConfigData

type ConfigData struct {
	Metadata Metadata `yaml:"metadata" json:"metadata"`
	Header   Header   `yaml:"header" json:"header"`
}

type ExecutionPlan

type ExecutionPlan struct {
	Metadata     Metadata
	Header       Header
	DefaultVars  map[string]string
	Env          map[string]string
	Items        []Item
	Finalize     Item
	Repositories []Repository
}

func (*ExecutionPlan) String

func (e *ExecutionPlan) String() string

type Header

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

type Item

type Item struct {
	AppReferences []*AppReference
	Chapter
	Requirement
	Check
	Env     map[string]string
	AppPath string
	Config  map[string]string
	Autopilot
	Manual
	ValidationErr string
}

func (*Item) String

func (i *Item) String() string

type Manual

type Manual struct {
	Status string
	Reason string
}

type Metadata

type Metadata struct {
	Version string `yaml:"version" json:"version"`
}

type Repository

type Repository struct {
	Name   string
	Type   string
	Config map[string]interface{}
}

type Requirement

type Requirement struct {
	Id    string
	Title string
	Text  string
}