Documentation
¶
Overview ¶
Package runtime runs the actions of a bundle's installations, as a CNAB runtime: it builds the claim, hands the operation to the driver that runs the invocation image, and returns the claim, its result and its outputs. It knows nothing about orchestrators: the target names one, and the installer applies it.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNotImplemented = errors.New("not implemented")
ErrNotImplemented is returned for what is planned but not built yet.
Functions ¶
Types ¶
type FailedError ¶
type FailedError struct {
Action string
Installation string
// Cause is how the installer ended; its output says why.
Cause string
}
FailedError is an action the installer ran, and that failed.
func (*FailedError) Error ¶
func (failed *FailedError) Error() string
type Request ¶
type Request struct {
Bundle cnab.ExtendedBundle
// Stack is the stack the installation belongs to. The installation is
// named <stack>/<bundle>.
Stack string
Action string
// Target receives the deployment; Installer says where the invocation
// image runs.
Target target.Target
Installer target.Installer
// Parameters holds the values given for the bundle's parameters, as
// text. They are converted to the type their definition says.
Parameters map[string]string
// Credentials holds the resolved values of the bundle's credentials.
Credentials valuesource.Set
// Relocation maps the bundle's images to where they are, when the
// bundle was pulled from a registry: the invocation image runs from
// there, and the installer gets the map.
Relocation relocation.ImageRelocationMap
// Source is where the bundle came from, a bundle.json or a location:
// its images are read from there when the target loads them. It is the
// claim's bundleReference.
Source string
// Custom is what the runtime records in the claim besides CNAB's own.
Custom any
// Progress receives the events of the action, about its installation:
// the loading of its images, and what its installer does.
Progress progress.Sink
}
Request is one action on one installation.
Click to show internal directories.
Click to hide internal directories.