Configuration

Configuration principle

• The configuration can be done at different level associated to the following :
  • workbench : the root configuration
    • goal :
      • configure local dev aspect
      • for CI configuration with workbench
    • constraint :
      • these parameter shall not modify the result, only how it is computed
    • content :
      • access to secret
      • storage / compute ressource availability
  • project : the root of configuration
    • goal :
      • adapt blueprint configuration on a use case
      • manage grant autorisation to different stackholder
  • Blueprint
    • goal:
      • Define usage rules / constraints for the referent Craft Items, Metrics and Artefact manipulated in Klarity
      • allow to define and controle the data model
    • constraint:
      • Blueprint defines which parameters MUST BE extended/defined in the project
      • Blueprint defines which parameters CAN BE extended/defined in the project
      • Blueprint defines which parameters CAN'T BE extended/defined in the project
      • Blueprint can use ressources configurated in workbench

Configuration content

• The list of Data Column

• for each columns tags and properties ==> Use element in concept, choose how to write only once

• The list of available actions ==> Use element in concept, choose how to write only once

• The list of artefact with for each

  • depending metrics (columns from Data Table + name regexp to select them)
  • code method for artefact generation

• The list of Data Table with for each

  • which Data Column
  • How are selected the sample selection (with available Operation)
  • Associated Name(s),

• The AI component external interface

  • inputs
  • outputs
  • metrics

• The list of user inputs

  • format, datasource, ...

TODO : put in schema

Configuration lifecycle

• Only one active configuration at the same time (TODO : maybe on per stage ?)

• All artefact reference the configuration used to generate the artefact

• Configurations are stored in klarity craft

• To modify a configuration we use a dedicated service with the following request

  • Check modification impact :
    • level of impact :
      • Minor : modification can be applied without direct impacts
      • Major : modification will lock craft, no other activity can be performed during configuration upgrade
      • Breaking : previous version of Craft Item (or several of them) will not be usable for new Craft Item, but history artefact shall still be accessible.
    • Analyse impact of configuration modification
      • list of impacted Craft Items (a new version will be generated with the configuration change) (minor / major / breaking)
  • Apply modification :
    • Apply the modification with or without blocking / locking /disabling Craft Item

• Configuration are versioned, and each modification can generate new versions of Craft Item.

• Roadmap :

  • MVP / V1 : manually with configuration files + tools for consistancy check, all change are breaking
  • V2 : a dedicated GUI to manage / modify theses configurations.