kURL Context
Replicated kURL is available only for existing customers. If you are not an existing kURL user, use Replicated Embedded Cluster instead. For more information, see Using Embedded Cluster.
kURL is a Generally Available (GA) product for existing customers. For more information about the Replicated product lifecycle phases, see Support Lifecycle Policy.
Overview
Template functions in the kURL context have access to information about applications installed with Replicated kURL. For more information about kURL, see Introduction to kURL.
The creation of the kURL Installer custom resource will reflect both install script changes made by posting YAML to the kURL API and changes made with -s flags at runtime. These functions are not available on the KOTS Admin Console config page.
KurlBool, KurlInt, KurlString, and KurlOption all take a string yamlPath as a param.
This is the path from the manifest file, and is delineated between add-on and subfield by a period ’.’.
For example, the kURL Kubernetes version can be accessed as {{repl KurlString "Kubernetes.Version" }}.
KurlBool, KurlInt, KurlString respectively return a bool, integer, and string value.
If used on a valid field but with the wrong type these will return the falsy value for their type, false, 0, and “string respectively.
The KurlOption function will convert all bool, int, and string fields to string.
All functions will return falsy values if there is nothing at the yamlPath specified, or if these functions are run in a cluster with no installer custom resource (as in, not a cluster created by kURL).
KurlBool
func KurlBool(yamlPath string) bool
Returns the value at the yamlPath if there is a valid boolean there, or false if there is not.
'{{repl KurlBool "Docker.NoCEonEE" }}'
KurlInt
func KurlInt(yamlPath string) int
Returns the value at the yamlPath if there is a valid integer there, or 0 if there is not.
'{{repl KurlInt "Rook.CephReplicaCount" }}'
KurlString
func KurlString(yamlPath string) string
Returns the value at the yamlPath if there is a valid string there, or "" if there is not.
'{{repl KurlString "Kubernetes.Version" }}'
KurlOption
func KurlOption(yamlPath string) string
Returns the value at the yamlPath if there is a valid string, int, or bool value there, or "" if there is not. Int and Bool values will be converted to string values.
'{{repl KurlOption "Rook.CephReplicaCount" }}'
KurlAll
func KurlAll() string
Returns all values in the Installer custom resource as key:value pairs, sorted by key.
'{{repl KurlAll }}'