packager

Documentation

Index

• Constants
• func BaseInvocationImage(cli command.Cli) string
• func Extract(name string, ops ...func(*types.App) error) (*types.App, error)
• func ExtractCNABParametersValues(mapping CNABParametersMapping, env []string) map[string]string
• func Init(name string, composeFile string, description string, maintainers []string, ...) (string, error)
• func Merge(app *types.App, target io.Writer) error
• func Pack(appname string, target io.Writer) error
• func PackInvocationImageContext(cli command.Cli, app *types.App, target io.Writer) error
• func Split(app *types.App, outputDir string) error
• func ToCNAB(app *types.App, invocationImageName string) (*bundle.Bundle, error)
• func Unpack(appname, targetDir string) error
• type CNABParametersMapping
  • func ExtractCNABParameterMapping(parameters parameters.Parameters) CNABParametersMapping

Constants

const (
	// DefaultCNABBaseImageName is the name of the default base invocation image.
	DefaultCNABBaseImageName = "docker/cnab-app-base"
)

Functions

func BaseInvocationImage

func BaseInvocationImage(cli command.Cli) string

BaseInvocationImage returns the name and tag of the CNAB base invocation image

func Extract

func Extract(name string, ops ...func(*types.App) error) (*types.App, error)

Extract extracts the app content if argument is an archive, or does nothing if a dir. It returns source file, effective app name, and cleanup function If appname is empty, it looks into cwd, and all subdirs for a single matching .dockerapp If nothing is found, it looks for an image and loads it

func ExtractCNABParametersValues

func ExtractCNABParametersValues(mapping CNABParametersMapping, env []string) map[string]string

ExtractCNABParametersValues extracts the parameter values from the given CNAB environment

func Init

func Init(name string, composeFile string, description string, maintainers []string, singleFile bool) (string, error)

Init is the entrypoint initialization function. It generates a new application definition based on the provided parameters and returns the path to the created application definition.

func Merge

func Merge(app *types.App, target io.Writer) error

Merge converts an app-package to the single-file merged version

func Pack

func Pack(appname string, target io.Writer) error

Pack packs the app as a single file

func PackInvocationImageContext

func PackInvocationImageContext(cli command.Cli, app *types.App, target io.Writer) error

PackInvocationImageContext creates a Docker build context for building a CNAB invocation image

func Split

func Split(app *types.App, outputDir string) error

Split converts an app package to the split version

func ToCNAB

func ToCNAB(app *types.App, invocationImageName string) (*bundle.Bundle, error)

ToCNAB creates a CNAB bundle from an app package

func Unpack

func Unpack(appname, targetDir string) error

Unpack extracts a packed app

Types

type CNABParametersMapping

type CNABParametersMapping struct {
	CNABEnvToParameter map[string]string
	ParameterToCNABEnv map[string]string
}

CNABParametersMapping describes the desired mapping between parameters and CNAB environment variables

func ExtractCNABParameterMapping

func ExtractCNABParameterMapping(parameters parameters.Parameters) CNABParametersMapping

ExtractCNABParameterMapping extracts the CNABParametersMapping from application parameters