builder

Documentation

Index

• Constants
• type Blob
• type Builder
  • func GetBuilder(img imgutil.Image) (*Builder, error)
  • func New(baseImage imgutil.Image, name string) (*Builder, error)
  • func (b *Builder) AddBuildpack(bp dist.Buildpack)
  • func (b *Builder) Description() string
  • func (b *Builder) GetBuildpacks() []BuildpackMetadata
  • func (b *Builder) GetCreatedBy() CreatorMetadata
  • func (b *Builder) GetLifecycleDescriptor() LifecycleDescriptor
  • func (b *Builder) GetOrder() dist.Order
  • func (b *Builder) GetStackInfo() StackMetadata
  • func (b *Builder) Name() string
  • func (b *Builder) Save(logger logging.Logger) error
  • func (b *Builder) SetDescription(description string)
  • func (b *Builder) SetEnv(env map[string]string)
  • func (b *Builder) SetLifecycle(lifecycle Lifecycle) error
  • func (b *Builder) SetOrder(order dist.Order)
  • func (b *Builder) SetStackInfo(stackConfig StackConfig)
• type BuildpackConfig
• type BuildpackLayerInfo
• type BuildpackLayers
• type BuildpackMetadata
• type Config
  • func ReadConfig(path string) (config Config, warnings []string, err error)
• type CreatorMetadata
• type Lifecycle
  • func NewLifecycle(blob Blob) (Lifecycle, error)
• type LifecycleAPI
• type LifecycleConfig
• type LifecycleDescriptor
• type LifecycleInfo
• type LifecycleMetadata
• type Metadata
• type RunImageMetadata
• type StackConfig
• type StackMetadata
• type V1Group
• type V1Order
  • func (o V1Order) ToOrder() dist.Order
• type Version
  • func VersionMustParse(v string) *Version
  • func (v *Version) MarshalText() ([]byte, error)
  • func (v *Version) String() string
  • func (v *Version) UnmarshalText(text []byte) error

Constants

const (
	AssumedLifecycleVersion   = "0.3.0"
	AssumedPlatformAPIVersion = "0.1"

	DefaultLifecycleVersion    = "0.5.0"
	DefaultBuildpackAPIVersion = "0.2"
	DefaultPlatformAPIVersion  = "0.1"
)

const BuildpackLayersLabel = "io.buildpacks.buildpack.layers"

const OrderLabel = "io.buildpacks.buildpack.order"

Types

type Blob

type Blob interface {
	Open() (io.ReadCloser, error)
}

type Builder

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

func GetBuilder

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

GetBuilder constructs builder from builder image

func New

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

New constructs a new builder from base image

func (*Builder) AddBuildpack

func (b *Builder) AddBuildpack(bp dist.Buildpack)

func (*Builder) Description

func (b *Builder) Description() string

func (*Builder) GetBuildpacks

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

func (*Builder) GetCreatedBy

func (b *Builder) GetCreatedBy() CreatorMetadata

func (*Builder) GetLifecycleDescriptor

func (b *Builder) GetLifecycleDescriptor() LifecycleDescriptor

func (*Builder) GetOrder

func (b *Builder) GetOrder() dist.Order

func (*Builder) GetStackInfo

func (b *Builder) GetStackInfo() StackMetadata

func (*Builder) Name

func (b *Builder) Name() string

func (*Builder) Save

func (b *Builder) Save(logger logging.Logger) 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(lifecycle Lifecycle) error

func (*Builder) SetOrder

func (b *Builder) SetOrder(order dist.Order)

func (*Builder) SetStackInfo

func (b *Builder) SetStackInfo(stackConfig StackConfig)

type BuildpackConfig

type BuildpackConfig struct {
	dist.BuildpackInfo
	URI string `toml:"uri"`
}

type BuildpackLayerInfo

type BuildpackLayerInfo struct {
	LayerDiffID string     `json:"layerDiffID"`
	Order       dist.Order `json:"order,omitempty"`
}

type BuildpackLayers

type BuildpackLayers map[string]map[string]BuildpackLayerInfo

type BuildpackMetadata

type BuildpackMetadata struct {
	dist.BuildpackInfo
	Latest bool `json:"latest"` // deprecated
}

type Config

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

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 CreatorMetadata

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

type Lifecycle

type Lifecycle interface {
	Blob
	Descriptor() LifecycleDescriptor
}

func NewLifecycle

func NewLifecycle(blob Blob) (Lifecycle, error)

type LifecycleAPI

type LifecycleAPI struct {
	BuildpackVersion *api.Version `toml:"buildpack" json:"buildpack"`
	PlatformVersion  *api.Version `toml:"platform" json:"platform"`
}

type LifecycleConfig

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

type LifecycleDescriptor

type LifecycleDescriptor struct {
	Info LifecycleInfo `toml:"lifecycle"`
	API  LifecycleAPI  `toml:"api"`
}

type LifecycleInfo

type LifecycleInfo struct {
	Version *Version `toml:"version" json:"version"`
}

type LifecycleMetadata

type LifecycleMetadata struct {
	LifecycleInfo
	API LifecycleAPI `json:"api"`
}

type Metadata

type Metadata struct {
	Description string              `json:"description"`
	Buildpacks  []BuildpackMetadata `json:"buildpacks"`
	Groups      V1Order             `json:"groups"` // deprecated
	Stack       StackMetadata       `json:"stack"`
	Lifecycle   LifecycleMetadata   `json:"lifecycle"`
	CreatedBy   CreatorMetadata     `json:"createdBy"`
}

type RunImageMetadata

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

type V1Group

type V1Group struct {
	Buildpacks []dist.BuildpackRef `toml:"buildpacks" json:"buildpacks"`
}

type V1Order

type V1Order []V1Group

func (V1Order) ToOrder

func (o V1Order) ToOrder() dist.Order

type Version

type Version struct {
	semver.Version
}

Version is an extension to semver.Version to make it marshalable.

func VersionMustParse

func VersionMustParse(v string) *Version

func (*Version) MarshalText

func (v *Version) MarshalText() ([]byte, error)

MarshalText makes Version satisfy the encoding.TextMarshaler interface.

func (*Version) String

func (v *Version) String() string

func (*Version) UnmarshalText

func (v *Version) UnmarshalText(text []byte) error

UnmarshalText makes Version satisfy the encoding.TextUnmarshaler interface.