Bird eye view of how the smarthub-server component works:
- reads configuration of systems, services, result mappings etc on startup from a configured datasource.
- periodically (every 2 seconds) check for new invocations
- executes invocation
- transfers invocation result (which is basically the rest api call response) according to the mapping rules
- saves the transformed data as SmartSourceTable, SmartSourceRow and SmartSourceColumn instances. As of now this is done via JPA/JDBC into the ToolSuite database.
Configuration sources
The application can read configuration can be read from various sources:
- classpath: if the configuration files are on the classpath (packaged with the application)
- filesystem: if the configuration files are on the FS
- git repository: if the configuration files are stored in a git repository.
However, smarthub-server access git raw content via a HTTP API (REST) which is not standard.
Hence, currently only BitBucket and Azure DevOps Git Repositories are supported.
config.properties
The main config file of the application, this is stored with the application sources and packaged with application. Stores configuration of the config source, default values and git repository access.
Expressions denoted with ${...} can refer to both environment variables or java system properites.
In the below configuration the environment name is passed from the GOCOMPLIANT_ENVIRONMENT env variable. The configuration (root) source is in the import.json file of the azure git repository that has branches corresponding to each environment. The access credentials for the Azure Git repo as passed in as AZ_USERNAME and AZ_PERSONAL_ACCESS_TOKEN env vars. The properties of ExternalSystem.defaults.* are default values which are applied in case the corresponding property of an ExternalSystem entity is not set.
environment.stage=${GOCOMPLIANT_ENVIRONMENT}
dataInitializer.importSource=git:///import.json
ExternalSystem.defaults.maxParallelCalls=1
ExternalSystem.defaults.maxRetryAttempts=2
ExternalSystem.defaults.readTimeout=20
ExternalSystem.defaults.retryWaitSeconds=60
azure.git.url=https://dev.azure.com/goco/product/_apis/git/repositories/smarthub-config/items
azure.git.branch=${GOCOMPLIANT_ENVIRONMENT}
azure.username=${AZ_USERNAME}
azure.personalAccessToken=${AZ_PERSONAL_ACCESS_TOKEN}
SmartHub configuration root
Databases configuration
Database connection urls, usernames and passwords are read from the below environments variables:
- SmartHub database: to store service configurations, invocations and intermittent responses
- SMARTHUB_JDBC_URL
- SMARTHUB_JDBC_USERNAME
- SMARTHUB_JDBC_PASSWORD
- ToolSuite database: to store the processed results
- TOOLSUITE_JDBC_URL
- TOOLSUITE_JDBC_USERNAME
- TOOLSUITE_JDBC_PASSWORD