# Functions
New creates an engine with a default function map, using a modified Sprig func map.
NewVariableMap creates variable map necessary for template rendering it uses a builder pattern to create the desired map of variables for a map of default values `renderer.NewVariableMap().WithDefaults()` as a builder pattern, when chaining latter methods in the chain take precedence `renderer.NewVariableMap().WithDefaults().WithResource(pkg.Resources)` will have default values overwritten with resource data.
ToYaml takes any value, and returns its YAML representation as a string.
YamlToObject parses a list of runtime.Objects from the provided yaml If the type is not known in the scheme, it tries to parse it as Unstructured We used to use 'apimachiner/pkg/util/yaml' for splitting the input into multiple yamls, however under the covers it uses bufio.NewScanner with token defaults with no option to modify.
# Variables
CommonAnnotationPaths is a list of locations for annotations to add in all resources.
CommonLabelPaths is a list of locations in an object type where labels should be added.
TemplateAnnotationPaths is a list of locations specific to objects where annotations should be added in templates.
# Structs
DefaultEnhancer is implementation of Enhancer that applies the defined conventions by directly editing runtime.Objects (Unstructured).
Engine is the control struct for parsing and templating Kubernetes resources in an ordered fashion.
Metadata contains Metadata along with specific fields associated with current plan being executed like current plan, phase, step or task names.
No description provided by the author
# Interfaces
Enhancer takes your kubernetes template and kudo related Metadata and applies them to all resources in form of labels and annotations it also takes care of setting an owner of all the resources to the provided object.
# Type aliases
VariableMap is the map of variables which are used in templates like map["OperatorName"].