builder

Documentation

Index

• Constants
• type APISet
  • func (a APISet) AsStrings() []string
  • func (a APISet) Earliest() *api.Version
  • func (a APISet) Latest() *api.Version
• type APIVersions
• type Blob
• type Builder
  • func FromImage(img imgutil.Image) (*Builder, error)
  • func New(baseImage imgutil.Image, name string) (*Builder, error)
  • func (b *Builder) AddBuildpack(bp dist.Buildpack)
  • func (b *Builder) Buildpacks() []dist.BuildpackInfo
  • func (b *Builder) CreatedBy() CreatorMetadata
  • func (b *Builder) Description() string
  • func (b *Builder) GID() int
  • func (b *Builder) Image() imgutil.Image
  • func (b *Builder) LifecycleDescriptor() LifecycleDescriptor
  • func (b *Builder) Mixins() []string
  • func (b *Builder) Name() string
  • func (b *Builder) Order() dist.Order
  • func (b *Builder) Save(logger logging.Logger, creatorMetadata CreatorMetadata) error
  • func (b *Builder) SetDescription(description string)
  • func (b *Builder) SetEnv(env map[string]string)
  • func (b *Builder) SetLifecycle(lifecycle Lifecycle)
  • func (b *Builder) SetOrder(order dist.Order)
  • func (b *Builder) SetStack(stackConfig builder.StackConfig)
  • func (b *Builder) Stack() StackMetadata
  • func (b *Builder) UID() int
• type CreatorMetadata
• type Lifecycle
  • func NewLifecycle(blob Blob) (Lifecycle, error)
• type LifecycleAPI
• type LifecycleAPIs
• type LifecycleDescriptor
  • func CompatDescriptor(descriptor LifecycleDescriptor) LifecycleDescriptor
  • func ParseDescriptor(contents string) (LifecycleDescriptor, error)
• type LifecycleInfo
• type LifecycleMetadata
• type Metadata
• type RunImageMetadata
• type StackMetadata
• type Version
  • func VersionMustParse(v string) *Version
  • func (v *Version) Equal(other *Version) bool
  • func (v *Version) MarshalText() ([]byte, error)
  • func (v *Version) String() string
  • func (v *Version) UnmarshalText(text []byte) error

Constants

const (
	EnvUID = "CNB_USER_ID"
	EnvGID = "CNB_GROUP_ID"
)

const (
	DefaultLifecycleVersion    = "0.9.1"
	DefaultBuildpackAPIVersion = "0.2"
)

A snapshot of the latest tested lifecycle version values

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

Types

type APISet

type APISet []*api.Version

func (APISet) AsStrings

func (a APISet) AsStrings() []string

func (APISet) Earliest

func (a APISet) Earliest() *api.Version

func (APISet) Latest

func (a APISet) Latest() *api.Version

type APIVersions

type APIVersions struct {
	Deprecated APISet `toml:"deprecated" json:"deprecated"`
	Supported  APISet `toml:"supported" json:"supported"`
}

APIVersions describes the supported API versions

type Blob

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

Blob is an interface to wrap opening blobs

type Builder

type Builder struct {
	StackID string
	// contains filtered or unexported fields
}

Builder represents a pack builder, used to build images

func FromImage

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

FromImage constructs a builder from a builder image

func New

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

New constructs a new builder from a base image

func (*Builder) AddBuildpack

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

AddBuildpack adds a buildpack to the builder

func (*Builder) Buildpacks

func (b *Builder) Buildpacks() []dist.BuildpackInfo

Buildpacks returns the buildpack list

func (*Builder) CreatedBy

func (b *Builder) CreatedBy() CreatorMetadata

CreatedBy returns metadata around the creation of the builder

func (*Builder) Description

func (b *Builder) Description() string

Description returns the builder description

func (*Builder) GID

func (b *Builder) GID() int

GID returns the GID of the builder

func (*Builder) Image

func (b *Builder) Image() imgutil.Image

Image returns the base image

func (*Builder) LifecycleDescriptor

func (b *Builder) LifecycleDescriptor() LifecycleDescriptor

LifecycleDescriptor returns the LifecycleDescriptor

func (*Builder) Mixins

func (b *Builder) Mixins() []string

Mixins returns the mixins of the builder

func (*Builder) Name

func (b *Builder) Name() string

Name returns the name of the builder

func (*Builder) Order

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

Order returns the order

func (*Builder) Save

func (b *Builder) Save(logger logging.Logger, creatorMetadata CreatorMetadata) error

Save saves the builder

func (*Builder) SetDescription

func (b *Builder) SetDescription(description string)

SetDescription sets the description of the builder

func (*Builder) SetEnv

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

SetEnv sets an environment variable to a value

func (*Builder) SetLifecycle

func (b *Builder) SetLifecycle(lifecycle Lifecycle)

SetLifecycle sets the lifecycle of the builder

func (*Builder) SetOrder

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

SetOrder sets the order of the builder

func (*Builder) SetStack

func (b *Builder) SetStack(stackConfig builder.StackConfig)

SetStack sets the stack of the builder

func (*Builder) Stack

func (b *Builder) Stack() StackMetadata

Stack returns the stack metadata

func (*Builder) UID

func (b *Builder) UID() int

UID returns the UID of the builder

type CreatorMetadata

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

type Lifecycle

type Lifecycle interface {
	Blob
	Descriptor() LifecycleDescriptor
}

Lifecycle is an implementation of the CNB Lifecycle spec

func NewLifecycle

func NewLifecycle(blob Blob) (Lifecycle, error)

NewLifecycle creates a Lifecycle from a Blob

type LifecycleAPI

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

LifecycleAPI describes which API versions the lifecycle satisfies

type LifecycleAPIs

type LifecycleAPIs struct {
	Buildpack APIVersions `toml:"buildpack" json:"buildpack"`
	Platform  APIVersions `toml:"platform" json:"platform"`
}

LifecycleAPIs describes the supported API versions per specification

type LifecycleDescriptor

type LifecycleDescriptor struct {
	Info LifecycleInfo `toml:"lifecycle"`
	// Deprecated: Use `LifecycleAPIs` instead
	API  LifecycleAPI  `toml:"api"`
	APIs LifecycleAPIs `toml:"apis"`
}

LifecycleDescriptor contains information described in the lifecycle.toml

func CompatDescriptor

func CompatDescriptor(descriptor LifecycleDescriptor) LifecycleDescriptor

CompatDescriptor provides compatibility by mapping new fields to old and vice-versa

func ParseDescriptor

func ParseDescriptor(contents string) (LifecycleDescriptor, error)

ParseDescriptor parses LifecycleDescriptor from toml formatted string.

type LifecycleInfo

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

LifecycleInfo contains information about the lifecycle

type LifecycleMetadata

type LifecycleMetadata struct {
	LifecycleInfo
	// Deprecated: use APIs instead
	API  LifecycleAPI  `json:"api"`
	APIs LifecycleAPIs `json:"apis"`
}

type Metadata

type Metadata struct {
	Description string               `json:"description"`
	Buildpacks  []dist.BuildpackInfo `json:"buildpacks"`
	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 StackMetadata

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

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

VersionMustParse parses a string into a Version

func (*Version) Equal

func (v *Version) Equal(other *Version) bool

Equal compares two Versions

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

String returns the string value of the Version

func (*Version) UnmarshalText

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

UnmarshalText makes Version satisfy the encoding.TextUnmarshaler interface.