Microservice Client

Environment variables to setting the communication between the microservices.

General config

Name	Description	Required	Type
MICRO_SERVICE_TYPE	Type of microservice client (e.g., KAFKA or SOCKET). Options: KAFKA, SOCKET	true	enum
MICROSERVICE_RESPONSE_WAIT_TIME	Time in milliseconds to wait for a microservice response.	false	number Default:10000

Config using KAFKA type

Name	Description	Required	Type
KAFKA_BROKER_URL	URL of the Kafka broker. Notes: It can be a string-array of url separated by commas, e.g., 'url1,url2,url3'. Example: http://example1.com,http://example2.com,http://example3.com	Required if: MICRO_SERVICE_TYPE = "KAFKA"	string
KAFKAJS_NO_PARTITIONER_WARNING	Disable KafkaJS partitioned warning. Set to 1 to disable the warning.	false	number
CONSUME_CONCURRENT	Number of Kafka partitions consumed concurrently.	false	number Default:100

Config using KAFKA type with SSL

Name	Description	Required	Type
KAFKA_SSL	Flag if connection to Kafka is by SSL. ⚠️ It will be implemented in the future, for now needs to define the 'DEPLOY_ENV' variable	false	boolean Default:false
KAFKA_PEM_PATH	File system path to the CA certificate PEM file for SSL connection to Kafka. Example: /path/to/ca.pem	Required if: MICRO_SERVICE_TYPE = "KAFKA"and KAFKA_SSL = "true"	string
KAFKA_CERT_PATH	File system path to the client certificate PEM file for SSL connection to Kafka. Example: /path/to/cert.pem	Required if: MICRO_SERVICE_TYPE = "KAFKA"and KAFKA_SSL = "true"	string
KAFKA_KEY_PATH	File system path to the client private key PEM file for SSL connection to Kafka. Example: /path/to/key.pem	Required if: MICRO_SERVICE_TYPE = "KAFKA"and KAFKA_SSL = "true"	string

Port config using SOCKET type

Name	Description	Required	Type
DELIVERY_PORT	Port number for DELIVERY microservice.	false	number Default:3001
DEPLOY_PORT	Port number for DEPLOY microservice.	false	number Default:3002
DISCOVERY_PORT	Port number for DISCOVERY microservice.	false	number Default:3003
OFFERING_PORT	Port number for OFFERING microservice.	false	number Default:3004
PROJECT_PORT	Port number for PROJECT microservice.	false	number Default:3005
UPLOAD_PORT	Port number for UPLOAD microservice.	false	number Default:3006
GETMAP_PORT	Port number for GETMAP microservice.	false	number Default:3007

Host config using SOCKET type

Name	Description	Required	Type
DELIVERY_HOST	Host address for DELIVERY microservice.	false	string Default:localhost
DEPLOY_HOST	Host address for DEPLOY microservice.	false	string Default:localhost
DISCOVERY_HOST	Host address for DISCOVERY microservice.	false	string Default:localhost
OFFERING_HOST	Host address for OFFERING microservice.	false	string Default:localhost
PROJECT_HOST	Host address for PROJECT microservice.	false	string Default:localhost
UPLOAD_HOST	Host address for UPLOAD microservice.	false	string Default:localhost
GETMAP_HOST	Host address for GETMAP microservice.	false	string Default:localhost