cue

Documentation

Index

• Constants
• func Eval(templatePath string, value map[string]interface{}) (*unstructured.Unstructured, error)
• func GetDefault(val cue.Value) interface{}
• func GetParameters(templatePath string) ([]types.Parameter, error)
• func RetrieveComments(value cue.Value) (string, string, string)

Constants

const (
	// UsagePrefix defines the usage display for KubeVela CLI
	UsagePrefix = "+usage="
	// ShortPrefix defines the short argument for KubeVela CLI
	ShortPrefix = "+short="
	// AliasPrefix is an alias of the name of a parameter element, in order to making it more friendly to Cli users
	AliasPrefix = "+alias="
)

const BaseTemplate = `

context: {
  name: string
  config?: [...{
    name: string
    value: string
  }]
}
`

BaseTemplate include base info provided by KubeVela for CUE template

const OutputFieldName = "output"

OutputFieldName is the name of the struct contains the CR data

Functions

func Eval

func Eval(templatePath string, value map[string]interface{}) (*unstructured.Unstructured, error)

Eval evaluates the spec with the parameter values

func GetDefault

func GetDefault(val cue.Value) interface{}

GetDefault evaluate default Go value from CUE

func GetParameters

func GetParameters(templatePath string) ([]types.Parameter, error)

GetParameters get parameter from cue template

func RetrieveComments

func RetrieveComments(value cue.Value) (string, string, string)

RetrieveComments will retrieve Usage, Short and Alias from CUE Value