Validate DLE config

Goal

Validate DLE config to prevent significant error without running retrieval

TODO / How to implement

Validate config before running retrieval jobs. It will be great if the validator is available for use without depending on the Retrieval service

YAML Syntax

The content of yaml file matches the Config structure without error

DLE config logic

• server:

  • port is a number from 0 to 65535

• embeddedUI:

  • dockerImage exists or available to download
  • port is a number from 0 to 65535, no conflict with DLE port

• global:

  • engine equals "postgres"
  • if telemetry is enabled, url is valid

• poolManager:

  • mountDir exists

• databaseContainer:

  • dockerImage exists or available to download

• provision:

  • portPool: from and to are numbers. The from value must be less than to.

• retrieval:

  • if refresh is defined, timetable contains a valid crontab string
  • jobs - the jobs section must not contain physical and logical restore jobs simultaneously
  • spec.logicalDump and spec.logicalRestore: dumpLocation exists and empty
  • spec.logicalDump: check if source.type is one of "local", "remote", or "rdsIam"
  • spec.logicalDump:
    • connection contains dbname and username fields in all cases
    • connection contains host and port if the source type is remote
    • connection contains rdsIam (with non-empty awsRegion, dbInstanceIdentifier, sslRootCert)
  • spec.logicalDump: parallelJobs cannot be more than 1 if immediateRestore is enabled
  • if spec.logicalDump.immediateRestore is enabled, logicalRestore must be not presented in the jobs list
  • spec.logicalSnapshot and spec.physicalSnapshot: preprocessingScript exists
  • spec.logicalSnapshot and spec.physicalSnapshot: queryPath is empty or exists if queryPreprocessing is defined
  • spec.physicalRestore: tool is one of "customTool", "walg", "pgbackrest" and there is a corresponding field in the options section
  • spec.physicalSnapshot: timetable fields contain valid crontab strings for scheduler.snapshot and scheduler.retention

Acceptance criteria

Any DLE configuration can be checked for compliance before starting the application