kanister

Documentation

Index

• Constants
• func Register(f Func) error
• func RegisterVersion(f Func, v string) error
• func RegisteredFunctions() map[string]struct{}
• type Func
  • func KanisterFuncForName(funcName, version string) Func
• type Phase
  • func GetDeferPhase(bp crv1alpha1.Blueprint, action, version string, tp param.TemplateParams) (*Phase, error)
  • func GetPhases(bp crv1alpha1.Blueprint, action, version string, tp param.TemplateParams) ([]*Phase, error)
  • func (p *Phase) Exec(ctx context.Context, bp crv1alpha1.Blueprint, action string, ...) (map[string]interface{}, error)
  • func (p *Phase) Name() string
  • func (p *Phase) Objects() map[string]crv1alpha1.ObjectReference
  • func (p *Phase) Progress() (crv1alpha1.PhaseProgress, error)
  • func (p *Phase) Validate(args map[string]any) error

Constants

const (
	DefaultVersion = "v0.0.0"
)

Functions

func Register

func Register(f Func) error

Register allows Funcs to be referenced by User Defined YAMLs

func RegisterVersion

func RegisterVersion(f Func, v string) error

RegisterVersion allows a Kanister Function to be registered with the given version

func RegisteredFunctions

func RegisteredFunctions() map[string]struct{}

Types

type Func

type Func interface {
	Name() string
	RequiredArgs() []string
	Arguments() []string
	Exec(context.Context, param.TemplateParams, map[string]interface{}) (map[string]interface{}, error)
	ExecutionProgress() (crv1alpha1.PhaseProgress, error)
	Validate(map[string]any) error
}

Func allows custom actions to be executed.

func KanisterFuncForName

func KanisterFuncForName(funcName, version string) Func

type Phase

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

Phase is an atomic unit of execution.

func GetDeferPhase

func GetDeferPhase(bp crv1alpha1.Blueprint, action, version string, tp param.TemplateParams) (*Phase, error)

func GetPhases

func GetPhases(bp crv1alpha1.Blueprint, action, version string, tp param.TemplateParams) ([]*Phase, error)

GetPhases renders the returns a list of Phases with pre-rendered arguments.

func (*Phase) Exec

func (p *Phase) Exec(ctx context.Context, bp crv1alpha1.Blueprint, action string, tp param.TemplateParams) (map[string]interface{}, error)

Exec renders the argument templates in this Phase's Func and executes with those arguments.

func (*Phase) Name

func (p *Phase) Name() string

Name returns the name of this phase.

func (*Phase) Objects

func (p *Phase) Objects() map[string]crv1alpha1.ObjectReference

Objects returns the phase object references

func (*Phase) Progress

func (p *Phase) Progress() (crv1alpha1.PhaseProgress, error)

Progress return execution progress of the phase.

func (*Phase) Validate

func (p *Phase) Validate(args map[string]any) error

Validate gets the provided arguments from a blueprint and calls Validate method of function to valdiate a function.