layers

Documentation

Index

• Constants
• type DependencyLayer
  • func (l DependencyLayer) ArtifactName() string
  • func (l DependencyLayer) Contribute(contributor DependencyLayerContributor, flags ...Flag) error
• type DependencyLayerContributor
• type DownloadLayer
  • func (l DownloadLayer) Artifact() (string, error)
• type Flag
• type HelperLayer
  • func (l HelperLayer) Contribute(contributor HelperLayerContributor, flags ...Flag) error
• type HelperLayerContributor
• type Layer
  • func (l Layer) AppendBuildEnv(name string, format string, args ...interface{}) error
  • func (l Layer) AppendLaunchEnv(name string, format string, args ...interface{}) error
  • func (l Layer) AppendPathBuildEnv(name string, format string, args ...interface{}) error
  • func (l Layer) AppendPathLaunchEnv(name string, format string, args ...interface{}) error
  • func (l Layer) AppendPathSharedEnv(name string, format string, args ...interface{}) error
  • func (l Layer) AppendSharedEnv(name string, format string, args ...interface{}) error
  • func (l Layer) Contribute(expected logger.Identifiable, contributor LayerContributor, flags ...Flag) error
  • func (l Layer) MetadataMatches(expected interface{}) (bool, error)
  • func (l Layer) OverrideBuildEnv(name string, format string, args ...interface{}) error
  • func (l Layer) OverrideLaunchEnv(name string, format string, args ...interface{}) error
  • func (l Layer) OverrideSharedEnv(name string, format string, args ...interface{}) error
  • func (l Layer) Touch()
  • func (l Layer) WriteProfile(file string, format string, args ...interface{}) error
• type LayerContributor
• type Layers
  • func NewLayers(layers layers.Layers, buildpackCache layers.Layers, ...) Layers
  • func (l Layers) DependencyLayer(dependency buildpack.Dependency) DependencyLayer
  • func (l Layers) DownloadLayer(dependency buildpack.Dependency) DownloadLayer
  • func (l Layers) HelperLayer(id string, name string) HelperLayer
  • func (l Layers) Layer(name string) Layer
  • func (l Layers) MultiDependencyLayer(name string, dependencies []buildpack.Dependency) MultiDependencyLayer
  • func (l Layers) WriteApplicationMetadata(metadata Metadata) error
  • func (l Layers) WritePersistentMetadata(metadata interface{}) error
• type Metadata
• type MultiDependencyLayer
  • func (l MultiDependencyLayer) Contribute(contributors map[string]MultiDependencyLayerContributor, flags ...Flag) error
• type MultiDependencyLayerContributor
• type Process
• type Processes
• type Slice
• type Slices
• type TouchedLayers
  • func NewTouchedLayers(root string, logger *logger.Log) TouchedLayers
  • func (t TouchedLayers) Add(metadata string)
  • func (t TouchedLayers) Cleanup() error

Constants

const (
	// Build indicates that a layer should be used for builds
	Build = layers.Build

	// Cache indicates that a layer should be cached
	Cache = layers.Cache

	// Launch indicates that a layer should be used for launch
	Launch = layers.Launch
)

Types

type DependencyLayer

type DependencyLayer struct {
	Layer

	// Dependency is the dependency provided by this layer.
	Dependency buildpack.Dependency
	// contains filtered or unexported fields
}

DependencyLayer is an extension to Layer that is unique to a dependency.

func (DependencyLayer) ArtifactName

func (l DependencyLayer) ArtifactName() string

ArtifactName returns the name portion of the download path for the dependency.

func (DependencyLayer) Contribute

func (l DependencyLayer) Contribute(contributor DependencyLayerContributor, flags ...Flag) error

Contribute facilitates custom contribution of an artifact to a layer. If the artifact has already been contributed, the contribution is validated and the contributor is not called. If the contribution is out of date, the layer is completely removed before contribution occurs.

type DependencyLayerContributor

type DependencyLayerContributor func(artifact string, layer DependencyLayer) error

DependencyLayerContributor defines a callback function that is called when a dependency needs to be contributed.

type DownloadLayer

type DownloadLayer struct {
	Layer
	// contains filtered or unexported fields
}

DownloadLayer is an extension to Layer that is unique to a dependency download.

func (DownloadLayer) Artifact

func (l DownloadLayer) Artifact() (string, error)

Artifact returns the path to an artifact cached in the layer. If the artifact has already been downloaded, the cache will be validated and used directly. If the artifact is out of date, the layer is left untouched and the contributor is responsible for cleaning the layer if necessary.

type Flag

type Flag = layers.Flag

type HelperLayer

type HelperLayer struct {
	Layer

	// ID is the id of the buildpack provided helper.
	ID string
	// contains filtered or unexported fields
}

HelperLayer is an extension to Layer that is unique to a buildpack provided helper.

func (HelperLayer) Contribute

func (l HelperLayer) Contribute(contributor HelperLayerContributor, flags ...Flag) error

Contribute facilitates custom contribution of a buildpack provided helper to a layer. If the artifact has already been contributed, the contribution is validated and the contributor is not called. If the contribution is out of date, the layer is completely removed before contribution occurs.

type HelperLayerContributor

type HelperLayerContributor func(artifact string, layer HelperLayer) error

HelperLayerContributor defines a callback function that is called when a buildpack provided helper needs to be contributed.

type Layer

type Layer struct {
	layers.Layer

	// Log is used to write debug and info to the console.
	Logger *logger.Log
	// contains filtered or unexported fields
}

LaunchLayer is an extension to libbuildpack.LaunchLayer that allows additional functionality to be added

func (Layer) AppendBuildEnv

func (l Layer) AppendBuildEnv(name string, format string, args ...interface{}) error

AppendBuildEnv appends the value of this environment variable to any previous declarations of the value without any delimitation. If delimitation is important during concatenation, callers are required to add it.

func (Layer) AppendLaunchEnv

func (l Layer) AppendLaunchEnv(name string, format string, args ...interface{}) error

AppendLaunchEnv appends the value of this environment variable to any previous declarations of the value without any delimitation. If delimitation is important during concatenation, callers are required to add it.

func (Layer) AppendPathBuildEnv

func (l Layer) AppendPathBuildEnv(name string, format string, args ...interface{}) error

AppendPathBuildEnv appends the value of this environment variable to any previous declarations of the value using the OS path delimiter.

func (Layer) AppendPathLaunchEnv

func (l Layer) AppendPathLaunchEnv(name string, format string, args ...interface{}) error

AppendPathLaunchEnv appends the value of this environment variable to any previous declarations of the value using the OS path delimiter.

func (Layer) AppendPathSharedEnv

func (l Layer) AppendPathSharedEnv(name string, format string, args ...interface{}) error

AppendPathSharedEnv appends the value of this environment variable to any previous declarations of the value using the OS path delimiter.

func (Layer) AppendSharedEnv

func (l Layer) AppendSharedEnv(name string, format string, args ...interface{}) error

AppendSharedEnv appends the value of this environment variable to any previous declarations of the value without any delimitation. If delimitation is important during concatenation, callers are required to add it.

func (Layer) Contribute

func (l Layer) Contribute(expected logger.Identifiable, contributor LayerContributor, flags ...Flag) error

Contribute facilitates custom contribution of a layer. If the layer has already been contributed, the contribution is validated and the contributor is not called. If the contribution is out of date, the layer is // completely removed before contribution occurs.

func (Layer) MetadataMatches

func (l Layer) MetadataMatches(expected interface{}) (bool, error)

MetadataMatches compares the expected metadata for the actual metadata of this layer.

func (Layer) OverrideBuildEnv

func (l Layer) OverrideBuildEnv(name string, format string, args ...interface{}) error

OverrideBuildEnv overrides any existing value for an environment variable with this value.

func (Layer) OverrideLaunchEnv

func (l Layer) OverrideLaunchEnv(name string, format string, args ...interface{}) error

OverrideLaunchEnv overrides any existing value for an environment variable with this value.

func (Layer) OverrideSharedEnv

func (l Layer) OverrideSharedEnv(name string, format string, args ...interface{}) error

OverrideSharedEnv overrides any existing value for an environment variable with this value.

func (Layer) Touch

func (l Layer) Touch()

Touch touches a layer, indicating that it was used and should not be removed.

func (Layer) WriteProfile

func (l Layer) WriteProfile(file string, format string, args ...interface{}) error

WriteProfile writes a file to profile.d with this value.

type LayerContributor

type LayerContributor func(layer Layer) error

LayerContributor defines a callback function that is called when a layer needs to be contributed.

type Layers

type Layers struct {
	layers.Layers

	// DependencyBuildPlans contains all contributed dependencies.
	DependencyBuildPlans buildplan.BuildPlan

	// TouchedLayers registers the layers that have been touched during this execution.
	TouchedLayers TouchedLayers
	// contains filtered or unexported fields
}

Layers is an extension allows additional functionality to be added.

func NewLayers

func NewLayers(layers layers.Layers, buildpackCache layers.Layers, buildpack buildpack.Buildpack, logger *logger.Log) Layers

NewLayers creates a new instance of Layers.

func (Layers) DependencyLayer

func (l Layers) DependencyLayer(dependency buildpack.Dependency) DependencyLayer

DependencyLayer returns a DependencyLayer unique to a dependency.

func (Layers) DownloadLayer

func (l Layers) DownloadLayer(dependency buildpack.Dependency) DownloadLayer

DownloadLayer returns a DownloadLayer unique to a dependency.

func (Layers) HelperLayer

func (l Layers) HelperLayer(id string, name string) HelperLayer

HelperLayer returns a HelperLayer unique to a buildpack provided dependency.

func (Layers) Layer

func (l Layers) Layer(name string) Layer

Layer creates a Layer with a specified name.

func (Layers) MultiDependencyLayer

func (l Layers) MultiDependencyLayer(name string, dependencies []buildpack.Dependency) MultiDependencyLayer

MultiDependencyLayer returns a DependencyLayer unique to a collection of dependencies.

func (Layers) WriteApplicationMetadata

func (l Layers) WriteApplicationMetadata(metadata Metadata) error

WriteApplicationMetadata writes application metadata to the filesystem.

func (Layers) WritePersistentMetadata

func (l Layers) WritePersistentMetadata(metadata interface{}) error

WritePersistentMetadata writes persistent metadata to the filesystem.

type Metadata

type Metadata = layers.Metadata

type MultiDependencyLayer

type MultiDependencyLayer struct {
	Layer

	// Dependencies are the dependencies provided by this layer.
	Dependencies []buildpack.Dependency
	// contains filtered or unexported fields
}

func (MultiDependencyLayer) Contribute

func (l MultiDependencyLayer) Contribute(contributors map[string]MultiDependencyLayerContributor, flags ...Flag) error

Contribute facilitates custom contribution of an artifacts to a layer. If the artifacts have already been contributed, the contribution is validated and the contributor is not called. If the contribution is out of date, the layer is completely removed before contribution occurs.

type MultiDependencyLayerContributor

type MultiDependencyLayerContributor func(artifact string, layer MultiDependencyLayer) error

MultiDependencyLayerContributor defines a callback function that is called when a dependency needs to be contributed.

type Process

type Process = layers.Process

type Processes

type Processes = layers.Processes

type Slice

type Slice = layers.Slice

type Slices

type Slices = layers.Slices

type TouchedLayers

type TouchedLayers struct {
	// Root is the root location of all layers to inspect for unused layers.
	Root string
	// contains filtered or unexported fields
}

TouchedLayers contains information about the layers that have been touched as part of this execution.

func NewTouchedLayers

func NewTouchedLayers(root string, logger *logger.Log) TouchedLayers

NewTouchedLayers creates a new instance that monitors a given root.

func (TouchedLayers) Add

func (t TouchedLayers) Add(metadata string)

Add registers that a given layer has been touched

func (TouchedLayers) Cleanup

func (t TouchedLayers) Cleanup() error

Cleanup removes all layers that have not been touched as part of this execution.