Categories:
Agents server environment variables
List of environment variables handled by the agents-server
Introduction
The agents-server depends on these environment variables to be set. None of them are modifiable by the OBs.
| Property | Type | Description |
|---|---|---|
| AGENT_PACKAGE_NAME | string | Package names containing the agents to be deployed. They must be separated by ,. |
| AURA_AGENT_DEPLOYMENT_NAME | string | Deployment name, which is used to obtain the agents to be deployed at API level. |
| AURA_CONFIG_API_API_KEY | number | APIKey for the aura-configuration-api. This key is used to authenticate requests to the aura-configuration-api. |
| AURA_CONFIG_API_BASE_URL | string | Base URL for the aura-configuration-api used to make requests to this component. |
| AURA_LOGGING_CONFIG_PATH | string | Path to the logging configuration file. This file is used to configure the logging settings for the server. |
| AURA_LOGGING_MODULE_NAME | string | Name of the logging module. This name is used to identify the logging module in the logging configuration. |
| AURA_LOGGING_NAME | string | Name of the logging instance. This name is used to identify the logging instance in the logging configuration. |
| AURA_REDIS_DATABASE | number | Redis database number to be used by the server. This number is used to connect to the Redis database. |
| AURA_REDIS_HOSTS | string | Redis hosts to be used by the server. This is a comma-separated list of Redis host names or IP addresses. |
| AURA_REDIS_MODE | string | Mode of the Redis connection. |
| AURA_REDIS_PASSWORD | number | Ppassword for the Redis connection. This password is used to authenticate the connection to the Redis database. |
| AURA_REDIS_POOL_SIZE | number | Size of the Redis connection pool. This number is used to limit the number of connections to the Redis database. |
| AURA_REDIS_PREFIX_SUBSCRIBERS | string | Prefix for the Redis subscribers. This prefix is used to identify the subscribers in the Redis database. |
| AURA_REDIS_CHANNELS_SUBSCRIBERS | string | Channels (separated by ‘,’) for the Redis subscribers. Redis prefix is added to these channels at the beginning. |
| AURA_REDIS_P_CHANNELS_SUBSCRIBERS | string | Pattern channels (separated by ‘,’) for the Redis subscribers. Redis prefix is added to these pattern channels at the beginning. |
| AURA_DAPR_PUBSUB_NAME | string | DAPR pubsub component name. It is used to identify DAPR component to be used. |
| AURA_DAPR_PREFIX_SUBSCRIBERS | string | Prefix for the DAPR pubsub subscribers. This prefix is used to identify the subscribers in the configured database. |
| AURA_DAPR_TOPICS_SUBSCRIBERS | string | Topics (separated by ‘,’) for the DAPR pubsub subscribers. DAPR prefix is added to these topics at the beginning. |
| AURA_MODEL_GW_BASE_URL | string | Base URL for the aura-model-gateway. This URL is used to make requests to the aura-model-gateway. |
| AURA_MONGODB_SSL | boolean | It indicates whether to use SSL for the MongoDB connection or not. This is a boolean value that can be set to true or false. |
| AURA_MONGODB_URI | string | URI for the MongoDB connection. This URI is used to connect to the MongoDB database. |
| AURA_MONGODB_USERNAME | string | Username for the MongoDB connection. This username is used to authenticate the connection to the MongoDB database. |
| AURA_MONGODB_PASSWORD | string | Password for the MongoDB connection. This password is used to authenticate the connection to the MongoDB database. |
-
The environment variables related to Redis are used to connect to the Redis database. This database is used to refresh the agent’s configuration, because every time the configuration of an agent is changed, it publishes this change in the corresponding channel so we can detect this change in order to refresh it.
-
The environment variables related to DAPR are used to connect to the DAPR components. These components are used to refresh the agent’s configuration, because every time the configuration of an agent is changed, it publishes this change in a corresponding topic, so we can detect this change in order to refresh it.
-
In order to use DAPR, it is necessary to have the DAPR pubsub component configured in the DAPR configuration file, besides the DAPR environment variables.