Variable Overview
Wayfinder offers a templating language that supports a range of Wayfinder-specific system variables. These can be used when defining custom policies and manifests. Each system variable resolves into the relevant value for its context.
Syntax
Wayfinder's templating language syntax is based on the Go templating language.
Discovering
Wayfinder offers an easy approach within its CLI and Web Interface to discover which system variables are available for you to use when defining custom package policies and manifests.
Use the wf describe vars --include-nested
command to get a list of all available system variables along with a description of each.
Web Interface:
- Expand Admin, and then navigate to Variables.
Resolving
Wayfinder provides a transparency mechanism that allows platform engineers to resolve variable values before deploying packages to child clusters.
This transparency mechanism minimises the risk of unexpected outcomes during deployment.
Use the wf resolve {{ .Path.To.Value }} --package PACKAGE --cluster CLUSTER
command to see what value the variable will resolve to for the given package and cluster.
Web Interface:
- Expand Admin, and then navigate to Variables.
- Click on the Show button.
- Select the workspace, cluster, and package for which to show the resolved values.
What comes next?
- See how to Describe Variables.
Related Reading
- See how to use variables in package templates.