builder

Documentation

Index

• Constants
• func ValidateConfig(c Config) error
• type BuildpackCollection
• type BuildpackConfig
• type Config
  • func ReadConfig(path string) (config Config, warnings []string, err error)
• type DetectionOrder
• type DetectionOrderEntry
• type LifecycleConfig
• type StackConfig

Constants

const (
	OrderDetectionMaxDepth = -1
	OrderDetectionNone     = 0
)

Functions

func ValidateConfig

func ValidateConfig(c Config) error

ValidateConfig validates the config

Types

type BuildpackCollection

type BuildpackCollection []BuildpackConfig

BuildpackCollection is a list of BuildpackConfigs

type BuildpackConfig

type BuildpackConfig struct {
	dist.BuildpackInfo
	dist.ImageOrURI
}

BuildpackConfig details the configuration of a Buildpack

type Config

type Config struct {
	Description string              `toml:"description"`
	Buildpacks  BuildpackCollection `toml:"buildpacks"`
	Order       dist.Order          `toml:"order"`
	Stack       StackConfig         `toml:"stack"`
	Lifecycle   LifecycleConfig     `toml:"lifecycle"`
}

Config is a builder configuration file

func ReadConfig

func ReadConfig(path string) (config Config, warnings []string, err error)

ReadConfig reads a builder configuration from the file path provided and returns the configuration along with any warnings encountered while parsing

type DetectionOrder

type DetectionOrder []DetectionOrderEntry

type DetectionOrderEntry

type DetectionOrderEntry struct {
	dist.BuildpackRef   `yaml:",inline"`
	Cyclical            bool           `json:"cyclic,omitempty" yaml:"cyclic,omitempty" toml:"cyclic,omitempty"`
	GroupDetectionOrder DetectionOrder `json:"buildpacks,omitempty" yaml:"buildpacks,omitempty" toml:"buildpacks,omitempty"`
}

type LifecycleConfig

type LifecycleConfig struct {
	URI     string `toml:"uri"`
	Version string `toml:"version"`
}

LifecycleConfig details the configuration of the Lifecycle

type StackConfig

type StackConfig struct {
	ID              string   `toml:"id"`
	BuildImage      string   `toml:"build-image"`
	RunImage        string   `toml:"run-image"`
	RunImageMirrors []string `toml:"run-image-mirrors,omitempty"`
}

StackConfig details the configuration of a Stack