spiff

Documentation

Index

• func LandscaperSpiffFuncs(blueprint *blueprints.Blueprint, functions spiffing.Functions, ...) error
• type TemplateError
  • func TemplateErrorBuilder(err error) *TemplateError
  • func (e *TemplateError) Build() *TemplateError
  • func (e *TemplateError) Error() string
  • func (e *TemplateError) WithInput(input map[string]interface{}, inputFormatter *template.TemplateInputFormatter) *TemplateError
• type Templater
  • func New(state template.GenericStateHandler, ...) *Templater
  • func (t *Templater) TemplateDeployExecutions(tmplExec lsv1alpha1.TemplateExecutor, blueprint *blueprints.Blueprint, ...) (*template.DeployExecutorOutput, error)
  • func (t *Templater) TemplateExportExecutions(tmplExec lsv1alpha1.TemplateExecutor, blueprint *blueprints.Blueprint, ...) (*template.ExportExecutorOutput, error)
  • func (t *Templater) TemplateImportExecutions(tmplExec lsv1alpha1.TemplateExecutor, blueprint *blueprints.Blueprint, ...) (*template.ImportExecutorOutput, error)
  • func (t *Templater) TemplateSubinstallationExecutions(tmplExec lsv1alpha1.TemplateExecutor, blueprint *blueprints.Blueprint, ...) (*template.SubinstallationExecutorOutput, error)
  • func (t Templater) Type() lsv1alpha1.TemplateType
  • func (t *Templater) WithInputFormatter(inputFormatter *template.TemplateInputFormatter) *Templater

Functions

func LandscaperSpiffFuncs

func LandscaperSpiffFuncs(blueprint *blueprints.Blueprint, functions spiffing.Functions, componentVersion model.ComponentVersion, componentVersions *model.ComponentVersionList, targetResolver targetresolver.TargetResolver) error

Types

type TemplateError

type TemplateError struct {
	// contains filtered or unexported fields
}

TemplateError wraps a spiff templating error and adds more human-readable information.

func TemplateErrorBuilder

func TemplateErrorBuilder(err error) *TemplateError

TemplateErrorBuilder creates a new TemplateError.

func (*TemplateError) Build

func (e *TemplateError) Build() *TemplateError

Build builds the error message.

func (*TemplateError) Error

func (e *TemplateError) Error() string

Error returns the error message.

func (*TemplateError) WithInput

func (e *TemplateError) WithInput(input map[string]interface{}, inputFormatter *template.TemplateInputFormatter) *TemplateError

WithInput adds the template input with a formatter to the error.

type Templater

type Templater struct {
	// contains filtered or unexported fields
}

Templater describes the spiff template implementation for execution templater.

func New

func New(state template.GenericStateHandler, targetResolver targetresolver.TargetResolver) *Templater

New creates a new spiff execution templater.

func (*Templater) TemplateDeployExecutions

func (t *Templater) TemplateDeployExecutions(tmplExec lsv1alpha1.TemplateExecutor,
	blueprint *blueprints.Blueprint,
	descriptor model.ComponentVersion,
	cdList *model.ComponentVersionList,
	values map[string]interface{}) (*template.DeployExecutorOutput, error)

func (*Templater) TemplateExportExecutions

func (t *Templater) TemplateExportExecutions(tmplExec lsv1alpha1.TemplateExecutor,
	blueprint *blueprints.Blueprint,
	descriptor model.ComponentVersion,
	cdList *model.ComponentVersionList,
	values map[string]interface{}) (*template.ExportExecutorOutput, error)

func (*Templater) TemplateImportExecutions

func (t *Templater) TemplateImportExecutions(tmplExec lsv1alpha1.TemplateExecutor,
	blueprint *blueprints.Blueprint,
	descriptor model.ComponentVersion,
	cdList *model.ComponentVersionList,
	values map[string]interface{}) (*template.ImportExecutorOutput, error)

func (*Templater) TemplateSubinstallationExecutions

func (t *Templater) TemplateSubinstallationExecutions(tmplExec lsv1alpha1.TemplateExecutor,
	blueprint *blueprints.Blueprint,
	cd model.ComponentVersion,
	cdList *model.ComponentVersionList,
	values map[string]interface{}) (*template.SubinstallationExecutorOutput, error)

func (Templater) Type

func (t Templater) Type() lsv1alpha1.TemplateType

func (*Templater) WithInputFormatter

func (t *Templater) WithInputFormatter(inputFormatter *template.TemplateInputFormatter) *Templater

WithInputFormatter ads a custom input formatter to this templater used for error messages.