Configuration
Configuration values below are passed through environment variables.
CHAIN_NAME [Mandatory]
An alphanumeric string to identify the chain.
Environment Variable | Sample Values |
CHAIN_NAME |
|
CHAIN_ENDPOINT [Mandatory]
The Endpoint of the chain node to which the event feed should connect to. Protocols Supported: ws (WebSocket) and wss (WebSocket Secure)
Environment Variable | Sample Values |
CHAIN_ENDPOINT |
|
LOGGERS [Mandatory]
The configuration pertains to the loggers enabled for the event feed. This configuration is extensible to add multiple logging such as logging to a file, logging to console, logging to monitoring system based on different levels of logging. Winston is used under the hood.
Loggers Available:
console
file
Logger Levels:
info
warning
error
debug
Format: LOGGERS=type,level[,param]
Multiple loggers can be provided separated by ";"
Environment Variable | Sample Values |
LOGGERS |
|
EXCLUDES [Optional]
Sections or Methods of a specific section can be excluded provided through this configuration.
A Section can be excluded as whole
Specific methods of the section can be excluded
Format: EXCLUDES="section[=methods]"
Multiple sections to be provided separated by ";"
Multiple methods to be separated by ","
Environment Variable | Sample Values |
EXCLUDES |
|
TYPES_FILE [Optional]
Location to custom types for the chain.
Environment Variable | Sample Values |
TYPES_FILE |
|
KAFKA_BROKERS [Mandatory]
List of Kafka brokers where the event should be posted. separated by ";"
Environment Variable | Sample Values |
KAFKA_BROKERS |
|
TOPICS [Mandatory]
Topics are generated using register_event_source.sh
Topic to which events from certain sections to be posted ";"
Multiple sections with topic can be provided separated by ";"
Environment Variable | Sample Values |
TOPICS |
|
OPENWHISK_API_KEY [Mandatory]
Openwhisk authentication key.
Environment Variable | Sample Values |
OPENWHISK_API_KEY |
|
OPENWHISK_API_HOST [Mandatory]
Openwhisk API Endpoint
Environment Variable | Sample Values |
OPENWHISK_API_HOST |
|
OPENWHISK_NAMESPACE [Mandatory]
Organization space where the actions, rules, and triggers related to aurras resides.
Environment Variable | Sample Values |
OPENWHISK_NAMESPACE |
|
EVENT_RECEIVER [Mandatory]
Trigger Endpoint where the event should be posted
Environment Variable | Sample Values |
EVENT_RECEIVER |
|
EVENT_PROCESSOR [Mandatory]
Action which is responsible for parsing the events to generic specification.
Environment Variable | Sample Values |
EVENT_PROCESSOR |
|
HEALTH_API_PORT [Optional]
Configuration for Health API port primarily used for Kubernetes readiness and liveness probe. Default port is 80.
Environment Variable | Sample Values |
HEALTH_API_PORT |
|
Last updated