liberty

Documentation

Index

• Constants
• type Base
  • func NewBase(buildpackPath string, serverName string, ...) Base
  • func (b Base) Contribute(layer libcnb.Layer) (libcnb.Layer, error)
  • func (b Base) ContributeConfigTemplates(layer libcnb.Layer) error
  • func (b Base) ContributeExternalConfiguration(layer libcnb.Layer) error
  • func (b Base) ContributeUserFeatures(layer libcnb.Layer) error
  • func (Base) Name() string
• type Build
  • func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)
• type Detect
  • func (d Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)
• type Distribution
  • func NewDistribution(dependency libpak.BuildpackDependency, cache libpak.DependencyCache, ...) Distribution
  • func (d Distribution) Contribute(layer libcnb.Layer) (libcnb.Layer, error)
  • func (d Distribution) Name() string
• type Feature
• type FeatureDescriptor
  • func ReadFeatureDescriptor(configRoot string, logger bard.Logger) (*FeatureDescriptor, error)
  • func (d *FeatureDescriptor) ResolveFeatures() error
• type FeatureInstaller
  • func NewFeatureInstaller(runtimeRootPath, serverName, templatePath string, features []*Feature) FeatureInstaller
  • func (i FeatureInstaller) Enable() error
  • func (i FeatureInstaller) Install() error

Constants

const (
	PlanEntryLiberty               = "liberty"
	PlanEntryJRE                   = "jre"
	PlanEntryJDK                   = "jdk"
	PlanEntryJVMApplicationPackage = "jvm-application-package"
	PlanEntryJavaAppServer         = "java-app-server"
	PlanEntrySyft                  = "syft"
)

Types

type Base

type Base struct {
	BuildpackPath                   string
	ConfigurationResolver           libpak.ConfigurationResolver
	DependencyCache                 libpak.DependencyCache
	ExternalConfigurationDependency *libpak.BuildpackDependency
	LayerContributor                libpak.LayerContributor
	Logger                          bard.Logger
	ServerName                      string
}

func NewBase

func NewBase(
	buildpackPath string,
	serverName string,
	externalConfigurationDependency *libpak.BuildpackDependency,
	configurationResolver libpak.ConfigurationResolver,
	cache libpak.DependencyCache,
) Base

func (Base) Contribute

func (b Base) Contribute(layer libcnb.Layer) (libcnb.Layer, error)

func (Base) ContributeConfigTemplates

func (b Base) ContributeConfigTemplates(layer libcnb.Layer) error

func (Base) ContributeExternalConfiguration

func (b Base) ContributeExternalConfiguration(layer libcnb.Layer) error

func (Base) ContributeUserFeatures

func (b Base) ContributeUserFeatures(layer libcnb.Layer) error

func (Base) Name

func (Base) Name() string

type Build

type Build struct {
	Executor    effect.Executor
	Logger      bard.Logger
	SBOMScanner sbom.SBOMScanner
}

func (Build) Build

func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)

type Detect

type Detect struct {
	Logger bard.Logger
}

func (Detect) Detect

func (d Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)

type Distribution

type Distribution struct {
	ApplicationPath  string
	Executor         effect.Executor
	Features         []string
	IFixes           []string
	LayerContributor libpak.DependencyLayerContributor
	Logger           bard.Logger
	ServerName       string
}

func NewDistribution

func NewDistribution(
	dependency libpak.BuildpackDependency,
	cache libpak.DependencyCache,
	serverName string,
	applicationPath string,
	features []string,
	ifixes []string,
	executor effect.Executor,
) Distribution

func (Distribution) Contribute

func (d Distribution) Contribute(layer libcnb.Layer) (libcnb.Layer, error)

func (Distribution) Name

func (d Distribution) Name() string

type Feature

type Feature struct {
	Name         string   `toml:"name"`
	Version      string   `toml:"version"`
	URI          string   `toml:"uri"`
	Dependencies []string `toml:"dependencies"`
	ResolvedPath string   `toml:"-"`
	ManifestPath string   `toml:"-"`
}

type FeatureDescriptor

type FeatureDescriptor struct {
	Path     string
	Features []*Feature
	Logger   bard.Logger
}

func ReadFeatureDescriptor

func ReadFeatureDescriptor(configRoot string, logger bard.Logger) (*FeatureDescriptor, error)

func (*FeatureDescriptor) ResolveFeatures

func (d *FeatureDescriptor) ResolveFeatures() error

type FeatureInstaller

type FeatureInstaller struct {
	RuntimeRootPath string
	ServerName      string
	TemplatePath    string
	Features        []*Feature
}

func NewFeatureInstaller

func NewFeatureInstaller(runtimeRootPath, serverName, templatePath string, features []*Feature) FeatureInstaller

func (FeatureInstaller) Enable

func (i FeatureInstaller) Enable() error

Enable the user features.

func (FeatureInstaller) Install

func (i FeatureInstaller) Install() error

Install the user features into the Liberty server.