tini

README

Tini Cloud Native Buildpack

The Tini CNB provides the Tini executable. The buildpack installs tini onto the $PATH which makes it available for subsequent buildpacks and/or the final container image.

Integration

The Tini CNB provides tini as a dependency. Downstream buildpacks can require the tini dependency by generating a Build Plan TOML file that looks like the following:

[[requires]]

  # The name of the Tini dependency is "tini". This value is
  # considered part of the public API for the buildpack and will not change
  # without a plan for deprecation.
  name = "tini"

  # Note: The version field is unsupported at this time

  # The Tini buildpack supports some non-required metadata options.
  [requires.metadata]

    # Setting the build flag to true will ensure that the Tini
    # dependency is available on the $PATH for subsequent buildpacks during
    # their build phase. If you are writing a buildpack that needs to run Tini
    # during its build process, this flag should be set to true.
    build = true

    # Setting the launch flag to true will ensure that the Tini
    # dependency is available on the $PATH for the running application. If you are
    # writing an application that needs to run Tini at runtime, this flag should
    # be set to true.
    launch = true

Usage

To package this buildpack for consumption:

$ ./scripts/package.sh

Documentation

Index

• Constants
• func Build(entries EntryResolver, dependencies DependencyManager, clock chronos.Clock, ...) packit.BuildFunc
• func Detect() packit.DetectFunc
• type DependencyManager
• type EntryResolver
• type SBOMGenerator

Constants

const (
	Tini               = "tini"
	DependencyCacheKey = "dependency-sha"
)

Functions

func Build

func Build(
	entries EntryResolver,
	dependencies DependencyManager,
	clock chronos.Clock,
	logger scribe.Emitter,
	sbomGenerator SBOMGenerator,
) packit.BuildFunc

func Detect

func Detect() packit.DetectFunc

Types

type DependencyManager

type DependencyManager interface {
	Resolve(path, id, version, stack string) (postal.Dependency, error)
	Deliver(dependency postal.Dependency, cnbPath, layerPath, platformPath string) error
	GenerateBillOfMaterials(dependencies ...postal.Dependency) []packit.BOMEntry
}

type EntryResolver

type EntryResolver interface {
	Resolve(name string, entries []packit.BuildpackPlanEntry, priorities []interface{}) (packit.BuildpackPlanEntry, []packit.BuildpackPlanEntry)
	MergeLayerTypes(name string, entries []packit.BuildpackPlanEntry) (launch, build bool)
}

type SBOMGenerator

type SBOMGenerator interface {
	GenerateFromDependency(dependency postal.Dependency, dir string) (sbom.SBOM, error)
}