Skip to main content

Configuration

Configuration in Config DB can refer to two things:

  • The configuration YAML file required by Config DB to scrape external configuration files
  • The external configurations scraped by Config DB (referred to as scraped configuration)

In order to run Config DB you need to first have a configuration file. Below is the structure of the configuration file.

Configuration file

FieldDescriptionSchemeRequired
logLevelSpecify the level of logging.stringfalse
scheduleSpecify the interval to scrape configuration files in cron format. Defaults to every 60 minutes.stringfalse
fullSet to true to extract changes from scraped configurations. Defaults to false.boolfalse
awsSpecifies the list of AWS configurations to scrape.[]AWSfalse
fileSpecifies the list of local file paths to scrape.[]Filefalse
kubernetesSpecifies the list of Kubernetes configurations to scrape.[]Kubernetesfalse
kubernetesFileSpecifies the list of Kubernetes configurations from a file to scrape.[]KubernetesFilefalse
azureDevopsSpecifies the list of Azure DevOps configurations to scrape.[]AzureDevopsfalse
sqlSpecifies the list of SQL configurations to scrape.[]SQLfalse
# Example configuration file

schedule: @every 5m
file:
- type: $.make
id: $.reg_no
paths:
- fixtures/data/car_changes.json