builder

Documentation

Index

• Constants
• func ParseBuildConfigEnv(env []BuildConfigEnv, path string) (envMap map[string]string, warnings []string, err error)
• func ValidateConfig(c Config) error
• type BpIdentifier
• type BuildConfig
• type BuildConfigEnv
• type Config
  • func ReadConfig(path string) (config Config, warnings []string, err error)
• type DetectionOrder
• type DetectionOrderEntry
• type LifecycleConfig
• type ModuleCollection
• type ModuleConfig
  • func (c *ModuleConfig) DisplayString() string
• type RunConfig
• type RunImageConfig
• type StackConfig
• type Suffix

Constants

const (
	OrderDetectionMaxDepth = -1
	OrderDetectionNone     = 0
)

Functions

func ParseBuildConfigEnv

func ParseBuildConfigEnv(env []BuildConfigEnv, path string) (envMap map[string]string, warnings []string, err error)

func ValidateConfig

func ValidateConfig(c Config) error

ValidateConfig validates the config

Types

type BpIdentifier

type BpIdentifier interface {
	Id() string
}

type BuildConfig

type BuildConfig struct {
	Image string           `toml:"image"`
	Env   []BuildConfigEnv `toml:"env"`
}

BuildConfig build image configuration

type BuildConfigEnv

type BuildConfigEnv struct {
	Name   string `toml:"name"`
	Value  string `toml:"value"`
	Suffix Suffix `toml:"suffix,omitempty"`
	Delim  string `toml:"delim,omitempty"`
}

type Config

type Config struct {
	Description     string           `toml:"description"`
	Buildpacks      ModuleCollection `toml:"buildpacks"`
	Extensions      ModuleCollection `toml:"extensions"`
	Order           dist.Order       `toml:"order"`
	OrderExtensions dist.Order       `toml:"order-extensions"`
	Stack           StackConfig      `toml:"stack"`
	Lifecycle       LifecycleConfig  `toml:"lifecycle"`
	Run             RunConfig        `toml:"run"`
	Build           BuildConfig      `toml:"build"`
}

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.ModuleRef      `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 ModuleCollection

type ModuleCollection []ModuleConfig

ModuleCollection is a list of ModuleConfigs

type ModuleConfig

type ModuleConfig struct {
	dist.ModuleInfo
	dist.ImageOrURI
}

ModuleConfig details the configuration of a Buildpack or Extension

func (*ModuleConfig) DisplayString

func (c *ModuleConfig) DisplayString() string

type RunConfig

type RunConfig struct {
	Images []RunImageConfig `toml:"images"`
}

RunConfig set of run image configuration

type RunImageConfig

type RunImageConfig struct {
	Image   string   `toml:"image"`
	Mirrors []string `toml:"mirrors,omitempty"`
}

RunImageConfig run image id and mirrors

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

type Suffix

type Suffix string

const (
	NONE     Suffix = ""
	DEFAULT  Suffix = "default"
	OVERRIDE Suffix = "override"
	APPEND   Suffix = "append"
	PREPEND  Suffix = "prepend"
)