Template Functions

The dynamic configuration management functionality available throughout the Replicated YAML.

Template functions are marked by the double curly bracket + “repl” escape sequence. They allow for user input to be dynamically inserted into application configuration values. The sequence should be {{repl, not {{ repl.

Template functions that refer to your containers are always addressed in pairs with “component name” and “image name”. You should use the full image name as it appears in your container definition.

Go Templates

Replicated uses Go’s template engine to execute the following functions. In addition to the functions listed here, all of the Go template runtime is available. Note that Go template functions must still be escaped with “repl” escape sequence as demonstrated below.

{{repl if pipeline}} T1 {{repl else}} T0 {{repl end}}

List Of Template Functions For The Native Scheduler

ConfigOption

func ConfigOption(optionName string) string

Returns the value of the config option as a string. The config screen and associated options are described here.

properties:
  app_url: http://{{repl ConfigOption "hostname" }}

ConfigOptionData

(only supports type: file)

func ConfigOptionData(fileName string) string

Returns the contents of the file uploaded for a configuration option as a string.

config_files:
- filename: /opt/certs/server.key
  contents: {{repl ConfigOptionData "ssl_key"}}

ConfigOptionEquals

func ConfigOptionEquals(optionName string, expectedValue string) bool

Returns true if the configuration option value is equal to the supplied value.

ports:
   - private_port: "80"
     public_port: "80"
     port_type: tcp
     when: '{{repl ConfigOptionEquals "http_enabled" "1" }}'

ConfigOptionNotEquals

func ConfigOptionNotEquals(optionName string, expectedValue string) bool

Returns true if the configuration option value is not equal to the supplied value.

ports:
   - private_port: "443"
     public_port: "443"
     port_type: tcp
     when: '{{repl ConfigOptionNotEquals "http_enabled" "1" }}'

NodePrivateIPAddress

func NodePrivateIPAddress(componentName string, imageName string) string

Returns Private IP Address of a given Component as a string.

env_vars:
- name: REDIS_HOST_PRIVATE
  value: '{{repl NodePrivateIPAddress "DB" "redis" }}'

Replaces HostPrivateIpAddress which is deprecated.

NodePrivateIPAddressFirst

func NodePrivateIPAddressFirst(componentName string, imageName string) string

Returns the first node’s Private IP Address of a given Component as a string.

NodePrivateIPAddressAll

func NodePrivateIPAddressAll(componentName string, imageName string) []string

Returns node private IP addresses for all instances of a given Component as an array of strings. Replaces HostPrivateIpAddressAll which is deprecated.

Note: ContainerExposedPortAll, NodePrivateIPAddressAll, NodePublicIPAddressAll are guaranteed to return in the same order

NodePublicIPAddress

func NodePublicIPAddress(componentName string, imageName string) string

Returns Public IP Address of a given Component as a string.

env_vars:
- name: REDIS_HOST_PUBLIC
  value: '{{repl NodePublicIPAddress "DB" "redis" }}'

Replaces HostPublicIpAddress which is deprecated.

NodePublicIPAddressFirst

func NodePublicIPAddressFirst(componentName string, imageName string) string

Returns first node’s public IP addresses for a given Component as a string.

NodePublicIPAddressAll

func NodePublicIPAddressAll(componentName string, imageName string) []string

Returns node public IP addresses for all instances of a given Component as an array of strings. Replaces HostPublicIpAddressAll which is deprecated.

Note: ContainerExposedPortAll, NodePrivateIPAddressAll, Node PublicIPAddressAll are guaranteed to return in the same order

ContainerExposedPort

func ContainerExposedPort(componentName string, imageName string, internalPort string) string

Returns the node’s public port mapped to the supplied exposed container port as a string.

env_vars:
- name: REDIS_PORT
  value: '{{repl ContainerExposedPort "DB" "redis" "6379" }}'

ContainerExposedPortFirst

func ContainerExposedPortFirst(componentName string, imageName string, internalPort string) string

Returns the first node’s public port mapped to the supplied exposed container port as a string.

env_vars:
- name: REDIS_PORT
  value: '{{repl ContainerExposedPortFirst "DB" "redis" "6379" }}'

ContainerExposedPortAll

func ContainerExposedPortAll(componentName string, imageName string, internalPort string) string

Returns the node public port mapped to the supplied exposed container port for all instances of a given Component as an array of strings.

Note: ContainerExposedPortAll, NodePrivateIPAddressAll, NodePublicIPAddressAll are guaranteed to return in the same order

LicenseFieldValue

func LicenseFieldValue(customLicenseFieldName string) string

Returns the value for the Custom License Field as a string.

config_files:
  - filename: /opt/app/config.yml
    contents: |
      max_users: '{{repl LicenseFieldValue "maximum_users" }}'

LicenseProperty

func LicenseProperty(propertyName string) string

Returns a property from the License as a string. Valid propertyNames are “assignee”, “channel.name”, “expiration.date”, “expiration.policy”, and “license.id”.

config_files:
  - filename: /opt/app/config.yml
    contents: |
      expiration.date: {{repl LicenseProperty "expiration.date"}}

AppID

func AppID() string

Returns the app id.

env_vars:
- name: APP_ID
  value: '{{repl AppID }}'

AppVersion

func AppVersion() int

Returns the app version sequence.

env_vars:
- name: APP_VERSION
  value: '{{repl AppVersion }}'

AppVersionFirst

func AppVersionFirst() int

Returns the version sequence of the first version installed.

env_vars:
- name: APP_VERSION_FIRST
  value: '{{repl AppVersionFirst }}'

AppVersionCurrent

func AppVersionCurrent() int

Returns the current app version sequence.

env_vars:
- name: APP_VERSION_CURRENT
  value: '{{repl AppVersionCurrent }}'

RunOffline

func RunOffline() bool

Returns whether or not we are running in airgap mode. This is available in the Kubernetes and Swarm implementations, but will always return false.

env_vars:
- name: IS_AIRGAP
  value: '{{repl RunOffline }}'

AppSetting

func AppSetting(key string) string

Returns a setting from the current app release.

Possible Options: version.label release.notes release.date install.date release.channel

env_vars:
- name: VERSION
  value: '{{repl AppSetting "version.label"}}'
- name: RELEASE_NOTES
  value: '{{repl AppSetting "release.notes"}}'
- name: INSTALL_DATE
  value: '{{repl AppSetting "install.date"}}'
- name: RELEASE_DATE
  value: '{{repl AppSetting "release.date"}}'
- name: RELEASE_CHANNEL
  value: '{{repl AppSetting "release.channel"}}'

ConsoleSetting

func ConsoleSetting(consoleSettingName string) string

Returns customer defined console settings for the TLS data or proxy settings. Values are returned as a string.

Option Returned Value
tls.key.name TLS key filename
tls.key.data TLS key contents
tls.cert.name TLS cert filename
tls.cert.data TLS cert contents
tls.authority.cert TLS certificate authority contents
tls.hostname Hostname used to secure Replicated TLS traffic
tls.source Source of the TLS cert, either “self-signed”, “key-cert” or “server-path”
http.proxy Proxy http address (e.g. http://10.128.0.4:3128)
http.proxy.enabled Proxy is enabled when value is 1, not enabled when it is 0
config:
- name: console_info
  title: Console Info
  items:
  - name: key_filename
    type: text
    readonly: true
    value: '{{repl ConsoleSetting "tls.key.name"}}'

ConsoleSettingEquals

func ConsoleSettingEquals(name string, value string) bool

Returns a bool indicating if the value is the currently applied value for ConsoleSetting with name.

ConsoleSettingNotEquals

func ConsoleSettingNotEquals(name string, value string) bool

Returns a bool indicating if the value is not the currently applied value for ConsoleSetting with name.

ThisHostInterfaceAddress

Deprecated, please use ThisNodePublicIPAddress, ThisNodePrivateIPAddress or ThisNodeDockerAddress instead.

func ThisHostInterfaceAddress(interfaceName string) string

Returns the valid IPv4 address associated with the given network interface of the host on which the current container instance is deployed as a string. For a clustered application this value will be different for each host.

env_vars:
- name: CASSANDRA_BROADCAST_ADDRESS_INTERNAL
  value: '{{repl ThisHostInterfaceAddress "docker0" }}'

ThisNodePublicIPAddress

func ThisNodePublicIPAddress() string

Returns the public IP address of the host on which the current container instance is deployed as a string. For a clustered application this value will be different for each host.

env_vars:
- name: CASSANDRA_ADDRESS_PUBLIC
  value: '{{repl ThisNodePublicIPAddress }}'

Replaces ThisHostPublicIpAddress which is deprecated.

ThisNodePrivateIPAddress

func ThisNodePrivateIPAddress() string

Returns the private IP address of the host on which the current container instance is deployed as a string. This address is either what was entered manually when host was provisioned or detected from eth0 interface by default. For a clustered application this value will be different for each host.

env_vars:
- name: CASSANDRA_BROADCAST_ADDRESS_INTERNAL
  value: '{{repl ThisNodePrivateIPAddress }}'

Replaces ThisHostPrivateIpAddress which is depreciated.

ThisNodeDockerAddress

func ThisNodeDockerAddress() string

Returns the docker0 address on the host on which the current container instance is deployed. For a clustered application this value will be different for each host.

LdapCopyAuthFrom

func LdapCopyAuthFrom(keyName string) interface{}

Possible Options:

Key Type
Hostname string
Port string
SearchUsername string
SearchPassword string
BaseDN string
UserSearchDNFirst string
UserSearchDNAll string
RestrictedGroupCNFirst []string
RestrictedGroupCNAll []string
FieldUsername string
LoginUsername string
AdvancedSearchBool boolean
UserQuery string
RestrictedGroupQuery string
env_vars:
- name: LDAP_HOSTNAME
  value: '{{repl LdapCopyAuthFrom "Hostname"}}'

Now

func Now() string

Returns the current timestamp as an RFC3339 formatted string.

env_vars:
- name: START_TIME
  value: '{{repl Now }}'

NowFmt

func NowFmt(format string) string

Returns the current timestamp as a formatted string. See Go’s time formatting guidelines [here](https://golang.org/pkg/time/#pkg-constants.

env_vars:
- name: START_DATE
  value: '{{repl Now "20060102" }}'

TrimSpace

func TrimSpace(s string) string

Trim returns a string with all leading and trailing spaces removed.

env_vars:
- name: VALUE
  value: '{{repl ConfigOption "str_value" | TrimSpace }}'

Trim

func Trim(s string, args ...string) string

Trim returns a string with all leading and trailing string contained in the optional args removed (default space).

env_vars:
- name: VALUE
  value: '{{repl ConfigOption "str_value" | Trim " " "." }}'

Split

func Split(s string, sep string) []string

Split slices s into all substrings separated by sep and returns an array of the substrings between those separators.

env_vars:
- name: BROKEN_APART_A_B_C
  value: '{{repl Split "A,B,C" "," }}'

Combining Split and index: Assuming the github_url param is set to https://github.mycorp.internal:3131, the following would set GITHUB_HOSTNAME to github.mycorp.internal.

env_vars:
- name: GITHUB_HOSTNAME
  value: '{{repl index (Split (index (Split (ConfigOption "github_url") "/") 2) ":") 0}}'

ToLower

func ToLower(stringToAlter string) string

Returns the string, in lowercase.

env_vars:
- name: COMPANY_NAME
  value: '{{repl ConfigOption "company_name" | ToLower }}'

ToUpper

func ToUpper(stringToAlter string) string

Returns the string, in uppercase.

env_vars:
- name: COMPANY_NAME
  value: '{{repl ConfigOption "company_name" | ToUpper }}'

HumanSize

func HumanSize(size interface{}) string

HumanSize returns a human-readable approximation of a size in bytes capped at 4 valid numbers (eg. “2.746 MB”, “796 KB”). The size must be a integer or floating point number.

env_vars:
- name: MIN_SIZE_HUMAN
  value: '{{repl ConfigOption "min_size_bytes" | HumanSize }}'

UrlEncode

func UrlEncode(stringToEncode string) string

Returns the string, url encoded.

env_vars:
- name: SMTP_CONNECTION_URL
  value: '{{repl ConfigOption "smtp_email" | UrlEncode }}:{{repl ConfigOption "smtp_password" | UrlEncode }}@smtp.example.com:587'

Base64Encode

func Base64Encode(stringToEncode string) string

Returns a Base64 encoded string.

env_vars:
- name: NAME_64_VALUE
  value: '{{repl ConfigOption "name" | Base64Encode }}'

Base64Decode

func Base64Decode(stringToDecode string) string

Returns decoded string from a Base64 stored value.

env_vars:
- name: NAME_PLAIN_TEXT
  value: '{{repl ConfigOption "base_64_encoded_name" | Base64Decode }}'

ParseBool

func ParseBool(str string) bool

ParseBool returns the boolean value represented by the string.

env_vars:
- name: VALUE
  value: '{{repl ConfigOption "str_value" | ParseBool }}'

ParseFloat

func ParseFloat(str string) float64

ParseFloat returns the float value represented by the string.

env_vars:
- name: VALUE
  value: '{{repl ConfigOption "str_value" | ParseFloat }}'

ParseInt

func ParseInt(str string, args ...int) int64

ParseInt returns the integer value represented by the string with optional base (default 10).

env_vars:
- name: VALUE
  value: '{{repl ConfigOption "str_value" | ParseInt }}'

ParseUint

func ParseUint(str string, args ...int) uint64

ParseUint returns the unsigned integer value represented by the string with optional base (default 10).

env_vars:
- name: VALUE
  value: '{{repl ConfigOption "str_value" | ParseUint }}'

Add

func Add(x interface{}, y interface{}) interface{}

Adds x and y.

If at least one of the operands is a floating point number, the result will be a floating point number.

If both operands are integers, the result will be an integer.

env_vars:
- name: MAX_USERS_PLUS_ONE
  value: '{{repl Add (LicenseFieldValue "maximum_users") 1}}'

Sub

func Sub(x interface{}, y interface{}) interface{}

Subtracts y from x.

If at least one of the operands is a floating point number, the result will be a floating point number.

If both operands are integers, the result will be an integer.

env_vars:
- name: MAX_USERS_MINUS_ONE
  value: '{{repl Sub (LicenseFieldValue "maximum_users") 1}}'

Mult

func Mult(x interface{}, y interface{}) interface{}

Multiplies x and y.

If at least one of the operands is a floating point number, the result will be a floating point number.

If both operands are integers, the result will be an integer.

env_vars:
- name: DOUBLE_NUM_ADDRESSES
  value: '{{repl Mult (NodePrivateIPAddressAll "DB" "redis" | len) 2}}'

Div

func Div(x interface{}, y interface{}) interface{}

Divides x by y.

If at least one of the operands is a floating point number, the result will be a floating point number.

If both operands are integers, the result will be an integer and will be rounded down.

env_vars:
- name: HALF_MAX_USERS
  value: '{{repl Div (LicenseFieldValue "maximum_users") 2.0}}'

Notes

When referencing another container in a template object, you must make sure the referenced container is started first. Please see the Events and Orchestration section for more information on orchestrating container startup.

Sprig

Sprig 2.19.0 template functions can be used with the repl prefix.

env_vars:
- name: HELLO
  value: '{{repl "hello!" | upper | repeat 5 }}'