Variables

Warning

To effectively apply custom variable changes, recreate the environment is needed

This page covers how variables are managed on Qaack.

There are two kind of variables:

  • Predefined variables

  • Custom variables

Prefefined variables

These variables are automatically added by Qaack and their purpose is provide more details of the system (like exposed URL, service, environment and repository details).

Look at this table to more details <>

Custom defined variables

These variables are defined by the user.

Variables have a visibility settings, allowing the user to enable it on runtime and/or build time.

There are several layers of variables:

  1. Config file

  2. Repository

  3. Group

The lower the layer its, the higher precedence it has. ( This is, config file variable overrides group variables)

Variable visibility

Variables can be available only under certain circunstances. The options are:

  • Always

  • Only on build time

Always

This means the variable is always available

Build time

This means the variable is available only when building the environment

Predefined variables

IS_QCK

Value: true

QCK_SERVICE_ID
QCK_SERVICE_NAME
QCK_SERVICE_[NAME]_URL

URL of the given service

QCK_SERVICE_[NAME]_DOMAIN

URL of the given service without protocol.

QCK_SERVICE_DEFAULT

Set to true if the current service is the default one. To false in other case

QCK_ENVIRONMENT_URL

Full environment url, with protocol

QCK_ENVIRONMENT_DOMAIN

Environment url without protocol

QCK_ENVIRONMENT_BASE_DOMAIN

Base domain of the Qaack instance

QCK_ENVIRONMENT_URL_[ALIAS]

Similar to QCK_ENVIRONMENT_URL but for a alias

QCK_ENVIRONMENT_DOMAIN_[ALIAS]

Similar to QCK_ENVIRONMENT_DOMAIN but for a alias

QCK_ENVIRONMENT_ID
QCK_ENVIRONMENT_REF
QCK_ENVIRONMENT_REF_NAME
QCK_ENVIRONMENT_REF_TYPE
QCK_ENVIRONMENT_CREATED_AT_UNIX
QCK_ENVIRONMENT_CREATED_AT
QCK_ENVIRONMENT_TTL

Only defined if there if the environment has expiration time.

QCK_ENVIRONMENT_EXPIRATION_TIME_UNIX

Only defined if there if the environment has expiration time.

QCK_ENVIRONMENT_EXPIRATION_TIME

Only defined if there if the environment has expiration time.

QCK_REPOSITORY_NAME
QCK_REPOSITORY_TYPE
QCK_REPOSITORY_ORIGIN

This variable is set only in generic repositories

QCK_GROUP_ID
QCK_GROUP_NAME