eval

Documentation

Overview

Package eval encapsulates the manner in which components and parameters are evaluated for qbec.

Index

• func Components(components []model.Component, ctx Context) (_ []model.K8sLocalObject, finalErr error)
• func Params(file string, ctx Context) (map[string]interface{}, error)
• type Context
• type VMConfigFunc

Functions

func Components

func Components(components []model.Component, ctx Context) (_ []model.K8sLocalObject, finalErr error)

Components evaluates the specified components using the specific runtime parameters file and returns the result.

func Params

func Params(file string, ctx Context) (map[string]interface{}, error)

Params evaluates the supplied parameters file in the supplied VM and returns it as a JSON object.

Types

type Context

type Context struct {
	App             string       // the application for which the evaluation is done
	Tag             string       // the gc tag if present
	Env             string       // the environment for which the evaluation is done
	EnvPropsJSON    string       // the environment properties to expose as an external variable
	DefaultNs       string       // the default namespace to expose as an external variable
	VMConfig        VMConfigFunc // the base VM config to use for eval
	Verbose         bool         // show generated code
	Concurrency     int          // concurrent components to evaluate, default 5
	PostProcessFile string       // the file that contains post-processing code for all objects
	CleanMode       bool         // whether clean mode is enabled
}

Context is the evaluation context

type VMConfigFunc

type VMConfigFunc func(tlaVars []string) vm.Config

VMConfigFunc is a function that returns a VM configuration containing only the specified top-level variables of interest.