Documentation ¶
Index ¶
- Constants
- type DependencyLayer
- type DependencyLayerContributor
- type DownloadLayer
- type Flag
- type HelperLayer
- 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) AppendSharedEnv(name string, format string, args ...interface{}) error
- func (l Layer) Contribute(expected logger.Identifiable, contributor LayerContributor, flags ...Flag) error
- func (l Layer) DefaultBuildEnv(name string, format string, args ...interface{}) error
- func (l Layer) DefaultLaunchEnv(name string, format string, args ...interface{}) error
- func (l Layer) DefaultSharedEnv(name string, format string, args ...interface{}) error
- func (l Layer) DelimiterBuildEnv(name string, delimiter string) error
- func (l Layer) DelimiterLaunchEnv(name string, delimiter string) error
- func (l Layer) DelimiterSharedEnv(name string, delimiter string) 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) PrependBuildEnv(name string, format string, args ...interface{}) error
- func (l Layer) PrependLaunchEnv(name string, format string, args ...interface{}) error
- func (l Layer) PrependPathBuildEnv(name string, format string, args ...interface{}) error
- func (l Layer) PrependPathLaunchEnv(name string, format string, args ...interface{}) error
- func (l Layer) PrependPathSharedEnv(name string, format string, args ...interface{}) error
- func (l Layer) PrependSharedEnv(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 (l Layers) DependencyLayer(dependency buildpack.Dependency) DependencyLayer
- func (l Layers) DependencyLayerWithID(id string, 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(id string, dependencies ...buildpack.Dependency) MultiDependencyLayer
- func (l Layers) WriteApplicationMetadata(metadata Metadata) error
- func (l Layers) WritePersistentMetadata(metadata interface{}) error
- type Metadata
- type MultiDependencyLayer
- type MultiDependencyLayerContributor
- type Process
- type Processes
- type Slice
- type Slices
- type TouchedLayers
Constants ¶
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 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 // Logger is used to write debug and info to the console. Logger logger.Logger // contains filtered or unexported fields }
LaunchLayer is an extension to libbuildpack.LaunchLayer that allows additional functionality to be added
func (Layer) AppendBuildEnv ¶
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 ¶
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) AppendSharedEnv ¶
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) DefaultBuildEnv ¶
DefaultBuildEnv sets a default for an environment variable with this value.
func (Layer) DefaultLaunchEnv ¶
DefaultLaunchEnv sets a default for an environment variable with this value.
func (Layer) DefaultSharedEnv ¶
DefaultSharedEnv sets a default for an environment variable with this value.
func (Layer) DelimiterBuildEnv ¶
DelimiterBuildEnv sets a delimiter for an environment variable with this value.
func (Layer) DelimiterLaunchEnv ¶
DelimiterLaunchEnv sets a delimiter for an environment variable with this value.
func (Layer) DelimiterSharedEnv ¶
DelimiterSharedEnv sets a delimiter for an environment variable with this value.
func (Layer) MetadataMatches ¶
MetadataMatches compares the expected metadata for the actual metadata of this layer.
func (Layer) OverrideBuildEnv ¶
OverrideBuildEnv overrides any existing value for an environment variable with this value.
func (Layer) OverrideLaunchEnv ¶
OverrideLaunchEnv overrides any existing value for an environment variable with this value.
func (Layer) OverrideSharedEnv ¶
OverrideSharedEnv overrides any existing value for an environment variable with this value.
func (Layer) PrependBuildEnv ¶
PrependBuildEnv prepends 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) PrependLaunchEnv ¶
PrependLaunchEnv prepends 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) PrependPathBuildEnv ¶
PrependPathBuildEnv prepends the value of this environment variable to any previous declarations of the value using the OS path delimiter.
func (Layer) PrependPathLaunchEnv ¶
PrependPathLaunchEnv prepends the value of this environment variable to any previous declarations of the value using the OS path delimiter.
func (Layer) PrependPathSharedEnv ¶
PrependPathSharedEnv prepends the value of this environment variable to any previous declarations of the value using the OS path delimiter.
func (Layer) PrependSharedEnv ¶
PrependSharedEnv prepends 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.
type LayerContributor ¶
LayerContributor defines a callback function that is called when a layer needs to be contributed.
type Layers ¶
type Layers struct { layers.Layers // Plans contains all contributed dependencies. Plans *buildpackplan.Plans // 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.Logger) 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) DependencyLayerWithID ¶
func (l Layers) DependencyLayerWithID(id string, dependency buildpack.Dependency) DependencyLayer
DependencyLayerWithID returns a DependencyLayer unique to a dependency with an explicit id.
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) MultiDependencyLayer ¶
func (l Layers) MultiDependencyLayer(id string, dependencies ...buildpack.Dependency) MultiDependencyLayer
MultiDependencyLayer returns a MultiDependencyLayer unique to a collection of dependencies.
func (Layers) WriteApplicationMetadata ¶
WriteApplicationMetadata writes application metadata to the filesystem.
func (Layers) WritePersistentMetadata ¶
WritePersistentMetadata writes persistent metadata to the filesystem.
type MultiDependencyLayer ¶
type MultiDependencyLayer struct { Layer // Dependencies are the dependencies provided by this layer. Dependencies []buildpack.Dependency // contains filtered or unexported fields }
MultiDependencyLayer is an extension to Layer that is unique to a collection of dependencies.
func (MultiDependencyLayer) Contribute ¶
func (l MultiDependencyLayer) Contribute(contributors map[string]MultiDependencyLayerContributor, flags ...Flag) error
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 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.Logger) 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.