System Variables

System variables are accessible in both job templates and volume templates. These variables are automatically provided by knot and can be used to dynamically reference information about spaces, templates, users, servers, and more.

To use a system variable, simply specify it in the format ${{ .<group>.<name> }}. For example: ${{ .space.name }}


Available System Variables

GroupNameDescription
spacespace.idThe UUID of the space
space.nameThe name of the space
space.first_bootFlags if this is the first boot of the space
templatetemplate.idThe UUID of the template used to create the space
template.nameThe name of the template used to create the space
useruser.idThe UUID of the user running the space
user.timezoneThe timezone of the user
user.usernameThe username of the user running the space
user.emailThe user’s email address
user.service_passwordService password for the user
serverserver.urlThe URL of the knot server
server.agent_endpointThe endpoint agents should use to connect to the server
server.wildcard_domainThe wildcard domain without the leading *
server.zoneThe server zone string
server.timezoneThe server timezone
nomadnomad.dcThe Nomad datacenter the server is running in (from the NOMAD_DC environment variable)
nomad.regionThe Nomad region the server is running in (from the NOMAD_REGION environment variable)

What’s Next