builder

Documentation

Index

• Constants
• type Builder
  • func GetBuilder(img imgutil.Image) (*Builder, error)
  • func New(img imgutil.Image, name string) (*Builder, error)
  • func (b *Builder) AddBuildpack(bp buildpack.Buildpack) error
  • func (b *Builder) Description() string
  • func (b *Builder) GetBuildpacks() []BuildpackMetadata
  • func (b *Builder) GetLifecycleVersion() *semver.Version
  • func (b *Builder) GetOrder() []GroupMetadata
  • func (b *Builder) GetStackInfo() StackMetadata
  • func (b *Builder) Name() string
  • func (b *Builder) Save() error
  • func (b *Builder) SetDescription(description string)
  • func (b *Builder) SetEnv(env map[string]string)
  • func (b *Builder) SetLifecycle(md lifecycle.Metadata) error
  • func (b *Builder) SetOrder(order []GroupMetadata) error
  • func (b *Builder) SetStackInfo(stackConfig StackConfig)
• type BuildpackConfig
• type BuildpackMetadata
• type Config
  • func ReadConfig(path string) (Config, error)
• type GroupBuildpack
• type GroupMetadata
• type LifecycleConfig
• type Metadata
• type OrderTOML
• type RunImageMetadata
• type StackConfig
• type StackMetadata

Constants

const MetadataLabel = "io.buildpacks.builder.metadata"

Types

type Builder

type Builder struct {
	UID, GID int
	StackID  string
	// contains filtered or unexported fields
}

func GetBuilder

func GetBuilder(img imgutil.Image) (*Builder, error)

func New

func New(img imgutil.Image, name string) (*Builder, error)

func (*Builder) AddBuildpack

func (b *Builder) AddBuildpack(bp buildpack.Buildpack) error

func (*Builder) Description

func (b *Builder) Description() string

func (*Builder) GetBuildpacks

func (b *Builder) GetBuildpacks() []BuildpackMetadata

func (*Builder) GetLifecycleVersion

func (b *Builder) GetLifecycleVersion() *semver.Version

func (*Builder) GetOrder

func (b *Builder) GetOrder() []GroupMetadata

func (*Builder) GetStackInfo

func (b *Builder) GetStackInfo() StackMetadata

func (*Builder) Name

func (b *Builder) Name() string

func (*Builder) Save

func (b *Builder) Save() error

func (*Builder) SetDescription

func (b *Builder) SetDescription(description string)

func (*Builder) SetEnv

func (b *Builder) SetEnv(env map[string]string)

func (*Builder) SetLifecycle

func (b *Builder) SetLifecycle(md lifecycle.Metadata) error

func (*Builder) SetOrder

func (b *Builder) SetOrder(order []GroupMetadata) error

func (*Builder) SetStackInfo

func (b *Builder) SetStackInfo(stackConfig StackConfig)

type BuildpackConfig

type BuildpackConfig struct {
	ID      string `toml:"id"`
	Version string `toml:"version"`
	URI     string `toml:"uri"`
	Latest  bool   `toml:"latest"`
}

type BuildpackMetadata

type BuildpackMetadata struct {
	ID      string `json:"id"`
	Version string `json:"version"`
	Latest  bool   `json:"latest"`
}

type Config

type Config struct {
	Description string            `toml:"description"`
	Buildpacks  []BuildpackConfig `toml:"buildpacks"`
	Groups      []GroupMetadata   `toml:"groups"`
	Stack       StackConfig       `toml:"stack"`
	Lifecycle   LifecycleConfig   `toml:"lifecycle"`
}

func ReadConfig

func ReadConfig(path string) (Config, error)

ReadConfig reads a builder configuration from the file path provided

type GroupBuildpack

type GroupBuildpack struct {
	ID       string `json:"id" toml:"id"`
	Version  string `json:"version" toml:"version"`
	Optional bool   `json:"optional,omitempty" toml:"optional,omitempty"`
}

type GroupMetadata

type GroupMetadata struct {
	Buildpacks []GroupBuildpack `json:"buildpacks" toml:"buildpacks"`
}

type LifecycleConfig

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

type Metadata

type Metadata struct {
	Description string              `json:"description"`
	Buildpacks  []BuildpackMetadata `json:"buildpacks"`
	Groups      []GroupMetadata     `json:"groups"`
	Stack       StackMetadata       `json:"stack"`
	Lifecycle   lifecycle.Metadata  `json:"lifecycle"`
}

type OrderTOML

type OrderTOML struct {
	Groups []GroupMetadata `toml:"groups"`
}

type RunImageMetadata

type RunImageMetadata struct {
	Image   string   `toml:"image" json:"image"`
	Mirrors []string `toml:"mirrors" json:"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"`
}

type StackMetadata

type StackMetadata struct {
	RunImage RunImageMetadata `toml:"run-image" json:"runImage"`
}