dist

Documentation

Overview

Package dist is responsible for cataloging all data types in relation to distributing Cloud Native Buildpack components.

Index

• Constants
• func AddToLayersMD(layerMD ModuleLayers, descriptor Descriptor, diffID string)
• func GetLabel(labeled Labeled, label string, obj interface{}) (ok bool, err error)
• func LayerDiffID(layerTarPath string) (v1.Hash, error)
• func SetLabel(labelable Labelable, label string, data interface{}) error
• type BuildpackDescriptor
  • func (b *BuildpackDescriptor) API() *api.Version
  • func (b *BuildpackDescriptor) EnsureStackSupport(stackID string, providedMixins []string, validateRunStageMixins bool) error
  • func (b *BuildpackDescriptor) EscapedID() string
  • func (b *BuildpackDescriptor) Info() ModuleInfo
  • func (b *BuildpackDescriptor) Kind() string
  • func (b *BuildpackDescriptor) Order() Order
  • func (b *BuildpackDescriptor) Stacks() []Stack
• type BuildpackURI
• type Descriptor
• type ExtensionDescriptor
  • func (e *ExtensionDescriptor) API() *api.Version
  • func (e *ExtensionDescriptor) EnsureStackSupport(_ string, _ []string, _ bool) error
  • func (e *ExtensionDescriptor) EscapedID() string
  • func (e *ExtensionDescriptor) Info() ModuleInfo
  • func (e *ExtensionDescriptor) Kind() string
  • func (e *ExtensionDescriptor) Order() Order
  • func (e *ExtensionDescriptor) Stacks() []Stack
• type ImageOrURI
  • func (c *ImageOrURI) DisplayString() string
• type ImageRef
• type Labelable
• type Labeled
• type License
• type ModuleInfo
  • func (b ModuleInfo) FullName() string
  • func (b ModuleInfo) FullNameWithVersion() (string, error)
  • func (b ModuleInfo) Match(o ModuleInfo) bool
  • func (b ModuleInfo) String() string
• type ModuleLayerInfo
• type ModuleLayers
  • func (b ModuleLayers) Get(id, version string) (ModuleLayerInfo, bool)
• type ModuleRef
• type Order
• type OrderEntry
• type Platform
• type Stack

Constants

const (
	BuildpackLayersLabel   = "io.buildpacks.buildpack.layers"
	ExtensionLayersLabel   = "io.buildpacks.extension.layers"
	ExtensionMetadataLabel = "io.buildpacks.extension.metadata"
)

const AssumedBuildpackAPIVersion = "0.1"

const BuildpacksDir = "/cnb/buildpacks"

const ExtensionsDir = "/cnb/extensions"

Functions

func AddToLayersMD

func AddToLayersMD(layerMD ModuleLayers, descriptor Descriptor, diffID string)

func GetLabel

func GetLabel(labeled Labeled, label string, obj interface{}) (ok bool, err error)

func LayerDiffID

func LayerDiffID(layerTarPath string) (v1.Hash, error)

func SetLabel

func SetLabel(labelable Labelable, label string, data interface{}) error

Types

type BuildpackDescriptor

type BuildpackDescriptor struct {
	WithAPI    *api.Version `toml:"api"`
	WithInfo   ModuleInfo   `toml:"buildpack"`
	WithStacks []Stack      `toml:"stacks"`
	WithOrder  Order        `toml:"order"`
}

func (*BuildpackDescriptor) API

func (b *BuildpackDescriptor) API() *api.Version

func (*BuildpackDescriptor) EnsureStackSupport

func (b *BuildpackDescriptor) EnsureStackSupport(stackID string, providedMixins []string, validateRunStageMixins bool) error

func (*BuildpackDescriptor) EscapedID

func (b *BuildpackDescriptor) EscapedID() string

func (*BuildpackDescriptor) Info

func (b *BuildpackDescriptor) Info() ModuleInfo

func (*BuildpackDescriptor) Kind

func (b *BuildpackDescriptor) Kind() string

func (*BuildpackDescriptor) Order

func (b *BuildpackDescriptor) Order() Order

func (*BuildpackDescriptor) Stacks

func (b *BuildpackDescriptor) Stacks() []Stack

type BuildpackURI

type BuildpackURI struct {
	URI string `toml:"uri"`
}

type Descriptor

type Descriptor interface {
	API() *api.Version
	Info() ModuleInfo
	Order() Order
	Stacks() []Stack
}

type ExtensionDescriptor

type ExtensionDescriptor struct {
	WithAPI  *api.Version `toml:"api"`
	WithInfo ModuleInfo   `toml:"extension"`
}

func (*ExtensionDescriptor) API

func (e *ExtensionDescriptor) API() *api.Version

func (*ExtensionDescriptor) EnsureStackSupport

func (e *ExtensionDescriptor) EnsureStackSupport(_ string, _ []string, _ bool) error

func (*ExtensionDescriptor) EscapedID

func (e *ExtensionDescriptor) EscapedID() string

func (*ExtensionDescriptor) Info

func (e *ExtensionDescriptor) Info() ModuleInfo

func (*ExtensionDescriptor) Kind

func (e *ExtensionDescriptor) Kind() string

func (*ExtensionDescriptor) Order

func (e *ExtensionDescriptor) Order() Order

func (*ExtensionDescriptor) Stacks

func (e *ExtensionDescriptor) Stacks() []Stack

type ImageOrURI

type ImageOrURI struct {
	BuildpackURI
	ImageRef
}

func (*ImageOrURI) DisplayString

func (c *ImageOrURI) DisplayString() string

type ImageRef

type ImageRef struct {
	ImageName string `toml:"image"`
}

type Labelable

type Labelable interface {
	SetLabel(name string, value string) error
}

type Labeled

type Labeled interface {
	Label(name string) (value string, err error)
}

type License

type License struct {
	Type string `toml:"type"`
	URI  string `toml:"uri"`
}

type ModuleInfo

type ModuleInfo struct {
	ID          string    `toml:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty"`
	Name        string    `toml:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty"`
	Version     string    `toml:"version,omitempty" json:"version,omitempty" yaml:"version,omitempty"`
	Description string    `toml:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty"`
	Homepage    string    `toml:"homepage,omitempty" json:"homepage,omitempty" yaml:"homepage,omitempty"`
	Keywords    []string  `toml:"keywords,omitempty" json:"keywords,omitempty" yaml:"keywords,omitempty"`
	Licenses    []License `toml:"licenses,omitempty" json:"licenses,omitempty" yaml:"licenses,omitempty"`
}

func (ModuleInfo) FullName

func (b ModuleInfo) FullName() string

func (ModuleInfo) FullNameWithVersion

func (b ModuleInfo) FullNameWithVersion() (string, error)

func (ModuleInfo) Match

func (b ModuleInfo) Match(o ModuleInfo) bool

Match compares two buildpacks by ID and Version

func (ModuleInfo) String

func (b ModuleInfo) String() string

Satisfy stringer

type ModuleLayerInfo

type ModuleLayerInfo struct {
	API         *api.Version `json:"api"`
	Stacks      []Stack      `json:"stacks,omitempty"`
	Order       Order        `json:"order,omitempty"`
	LayerDiffID string       `json:"layerDiffID"`
	Homepage    string       `json:"homepage,omitempty"`
	Name        string       `json:"name,omitempty"`
}

type ModuleLayers

type ModuleLayers map[string]map[string]ModuleLayerInfo

func (ModuleLayers) Get

func (b ModuleLayers) Get(id, version string) (ModuleLayerInfo, bool)

type ModuleRef

type ModuleRef struct {
	ModuleInfo `yaml:"buildpackinfo,inline"`
	Optional   bool `toml:"optional,omitempty" json:"optional,omitempty" yaml:"optional,omitempty"`
}

type Order

type Order []OrderEntry

type OrderEntry

type OrderEntry struct {
	Group []ModuleRef `toml:"group" json:"group"`
}

type Platform

type Platform struct {
	OS string `toml:"os"`
}

type Stack

type Stack struct {
	ID     string   `json:"id" toml:"id"`
	Mixins []string `json:"mixins,omitempty" toml:"mixins,omitempty"`
}