ModuleSet content persistence proposal

Owned by Ruslan Kashapov
Last updated: Jan 05, 2021 by Toine Siebelink
1 min read

Addresses: CPS-43: VSE: Introduce Module Sets (groups of modules)Closed



Points

  • Module Set contains (references) set of YANG definition files

  • Module Set belongs to dataspace

  • Module Set content is used to build the Schema Context

    • Schema Context is not persisted, it's built on demand

    • Schema Context may contain multiple modules 

    • Schema Context is served by CPS Core service and referenced in neither API nor SPI

  • YANG definition files within a single Module Set should be validated as non-conflicting before persistence

  • YANG definition files are stored as original source content

    • YANG definitions are uniquely  identified by their content (MD5 checksum)

    • Same YANG definitions could be used by multiple Module Sets

Entity relations diagram

Discussion points

  • confirming the entities relationship

  • naming: Moduleset → Schema, Module → yang_file, yang_resource etc.

  • content uniqueness identification by checksum → md5, sha-256 or other



Discussion results (Dec 1, 2020)

  • Module Set sources (yang files) to be stored on a unique content basis.
    Uniqueness of a content to be identified using MD5 checksum.


  • To rename: 
    Module Set → Schema Set
    Yang File → Yang Resource