Deployment Environment Variables

Introduction

SOAJS provides a list of computed environment variables that is used when creating catalog recipes.

These variables are computed at runtime and provide information related to the environment, platform, and components.

All computed environment variables listed below are global and can be used in any catalog recipe of any type.

The tables below group the variables based on usage, however, no environment variable is exclusive to a certain type.

SOAJS - Service

Variable Name	Description	Source	Default
NODE_ENV	Node Environment	static
SOAJS_ENV	SOAJS Environment	Computed
SOAJS_PROFILE	Path where the profile will be generated by the deployer and read by the service	Static
SOAJS_SRV_AUTOREGISTERHOST	Option to allow service to auto register itself	Static
SOAJS_SRV_MEMORY	Node max_old_space_size memory limit	Computed
SOAJS_SRV_MAIN	Main file to run the service	Computed	Default "."
SOAJS_SRV_PORT	Main service port	Computed
SOAJS_SRV_PORT_MAINTENANCE	Service maintenance port	Computed
SOAJS_GC_NAME	GC service name	Computed
SOAJS_GC_VERSION	GC service version	Computed
SOAJS_GIT_OWNER	Owner of the service's git repository	Computed
SOAJS_GIT_BRANCH	Git repository branch	Computed	master
SOAJS_GIT_COMMIT	Git repository commit	Computed
SOAJS_GIT_REPO	Git repository name	Computed
SOAJS_GIT_TOKEN	Git account token in case of private repositories	Computed
SOAJS_GIT_PROVIDER	Git account provider	Computed	github
SOAJS_GIT_DOMAIN	Git provider domain	Computed	github.com
SOAJS_DEPLOY_ACC	Flag that indicates the deployer should use the local SOAJS package found in the image	User input	false
SOAJS_DEPLOY_HA	Deployment platform, swarm or kubernetes	Computed
SOAJS_HA_NAME	Task/Pod name per container	Computed
SOAJS_MONGO_NB	Number of mongo instances	Computed
SOAJS_MONGO_PREFIX	Mongo database prefix	Computed
SOAJS_MONGO_RSNAME	Mongo Replica set name	Computed
SOAJS_MONGO_AUTH_DB	Mongo Authentication database name	Computed
SOAJS_MONGO_SSL	Flag to turn on/off secure mongo connection	Computed
SOAJS_MONGO_IP_N	IP/domain of N'th mongo instance	Computed
SOAJS_MONGO_PORT_N	Port of N'th mongo instance	Computed
SOAJS_CONFIG_REPO_PROVIDER	Provider of the config repository that can be used with the deployer	User input
SOAJS_CONFIG_REPO_OWNER	Config repository owner	User input
SOAJS_CONFIG_REPO_BRANCH	Config repository branch	User input
SOAJS_CONFIG_REPO_NAME	Config repository name	User input
SOAJS_CONFIG_REPO_TOKEN	Config repository token in case of private repository	User input
SOAJS_CONFIG_REPO_COMMIT	Git repository commit	Computed
SOAJS_CONFIG_REPO_PATH	Optional Path value instructing the location of the configuration files	User Input

SOAJS - Daemon

Variable Name	Description	Source	Default
All environment variables of soajs - service except for SOAJS_GC_NAME and SOAJS_GC_VERSION
SOAJS_DAEMON_GRP_CONF	Daemon group configuration name	Computed

Nginx

Variable Name	Description	Source	Default
SOAJS_ENV	SOAJS environment, not required by nginx itself but needed for logging and analytics	Computed
SOAJS_GIT_DASHBOARD_BRANCH	Branch of soajs.dashboard.ui repository, only applicable for nginx deployed in dashboard environment	Static
SOAJS_NX_DOMAIN	Master domain, required to generate self-signed certificates	Computed
SOAJS_NX_API_DOMAIN	API domain for environment	Computed
SOAJS_NX_SITE_DOMAIN	Site domain for environment	Computed
SOAJS_NX_CONTROLLER_NB	Number of controller instances, required to build upstream	Computed
SOAJS_NX_CONTROLLER_IP_N	IP/Domain of N'th controller instance	Computed
SOAJS_NX_CONTROLLER_PORT	Controller port, based on the value set in registry	Computed
SOAJS_NX_API_HTTPS	Flag to trigger HTTPS for API domain	User input
SOAJS_NX_API_HTTP_REDIRECT	Flag to redirect HTTP calls to HTTPS for API calls	User input
SOAJS_NX_SITE_HTTPS	Flag to trigger HTTPS for site domain	User input
SOAJS_NX_SITE_HTTP_REDIRECT	Flag to redirect HTTP calls to HTTPS for site calls	User input
SOAJS_NX_CUSTOM_SSL	Flag to disable self-signed certificates and use user-provided certificates instead	User input
SOAJS_NX_SSL_CERTS_LOCATION	Location where the certificates volume will be mounted inside a container	User input	/etc/soajs/ssl/
SOAJS_NX_SSL_SECRET	Name of the kubernetes secret that will be mounted as a volume to nginx containers	User input
SOAJS_DEPLOY_HA	Deployment platform, used for analytics, swarm or kubernetes	Computed
SOAJS_EXTKEY	Public External Key used by Dashboard UI in Nginx container to communicate with login API of Dashboard Service	Computed
SOAJS_HA_NAME	Task/Pod name of the current container, required for analytics	Computed
SOAJS_CONFIG_REPO_PROVIDER	Provider of the config repo that can be used with the deployer	User input
SOAJS_CONFIG_REPO_OWNER	Config repository owner	User input
SOAJS_CONFIG_REPO_BRANCH	Config repository branch	User input
SOAJS_CONFIG_REPO_NAME	Config repository name	User input
SOAJS_CONFIG_REPO_TOKEN	Config repository token in case of private repository	User input
SOAJS_CONFIG_REPO_COMMIT	Git repository commit	Computed
SOAJS_CONFIG_REPO_PATH	Optional Path value instructing the location of the configuration files	User Input
SOAJS_GIT_OWNER	Owner of the UI git repository	User input
SOAJS_GIT_BRANCH	UI repository branch	User input	master
SOAJS_GIT_REPO	UI repository name	User input
SOAJS_GIT_TOKEN	Service repository token for private git accounts	User input
SOAJS_GIT_PROVIDER	Git account provider	User input	github
SOAJS_GIT_DOMAIN	Git provider domain	User input	github.com
SOAJS_GIT_PATH	Git ui path location	User Input	/
SOAJS_GIT_COMMIT	Git repository commit	Computed
SOAJS_GIT_PORTAL_BRANCH	Branch of soajs.portal.ui repository, only applicable for nginx deployed in portal environment	Static	master
SOAJS_NX_REAL_IP	Flag that indicates that the nginx container should extract the real client IP address in AWS deployments	Static	true

Mongo and Elasticsearch

No computed environment variables exist for mongo and/or Elasticsearch deployments. The user is expected to add SOAJS_CONFIG_REPO_* environment variables if he wants to use a configuration repo when deploying.

Variable Name	Description	Source
SOAJS_CONFIG_REPO_PROVIDER	Provider of the config repo that can be used with the deployer	User input
SOAJS_CONFIG_REPO_OWNER	Config repository owner	User input
SOAJS_CONFIG_REPO_BRANCH	Config repository branch	User input
SOAJS_CONFIG_REPO_NAME	Config repository name	User input
SOAJS_CONFIG_REPO_TOKEN	Config repository token in case of private repository	User input
SOAJS_CONFIG_REPO_COMMIT	Git repository commit	Computed
SOAJS_CONFIG_REPO_PATH	Optional Path value instructing the location of the configuration files	User Input

Nodejs

Variable Name	Description	Source	Default
SOAJS_GIT_OWNER	Owner of the ui git repository	User input
SOAJS_GIT_BRANCH	UI repository branch	User input	master
SOAJS_GIT_REPO	UI repository name	User input
SOAJS_GIT_TOKEN	Service repository token for private git accounts	User input
SOAJS_GIT_PROVIDER	Git account provider	User input	github
SOAJS_GIT_DOMAIN	Git provider domain	User input	github.com
SOAJS_SRV_MAIN	Main file to run the nodejs service	User input	"."
SOAJS_SRV_MEMORY	Nodejs param for max_old_space_size	User input