Uploaded image for project: 'Clair'
  1. Clair
  2. CLAIRDEV-99

Indexer Additional Data API

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • indexer, updater
    • None
    • Indexer Addt'l Data
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do

      Between discussions about the Java indexer and the Red Hat indexers, it's becoming clear that we need an indexer-side API for providing additional data to indexer processes. The need for this sort of data can't be papered over in the long term. Despite successfully pushing back on Red Hat Product Security's plans to introduce an additional metadata file, the existing ones will need to be used for the foreseeable future. The java issue had us run some numbers and realize that it wouldn't be unworkable to scrape maven repositories to generate jar lookup data. For a single mechanism to be useful in both cases, it must be more complicated than the previous plan for storing indexer data centrally.


      Requirements:

      1. Must support arbitrary data shapes – assume the data cannot be fully normalized
      2. Must support key lookups
      3. Must be able to be incrementally updated

      Wants:

      1. Some amount of the data will be repeated (Maven (group, artifact) pairs, Red Hat product names) – being able to intern some values would be a space savings.
      2. Some sort of query ability (jsonpath?)

      Antirequirements:

      1. Use of PostgreSQL-only features (for sqlite, emulation via user functions may be OK)
      2. Querying implemented wholly process-side
      3. Only "snapshot"-style updates to data

      This should be done in a few broad steps:

      1. Design and implement the Indexer AdditionalData database API
      2. Design and implement an IndexerUpdater API.
      3. Implement the API to provide the AdditionalData API to "scanner" implementations.
      4. Implement needed IndexerUpdater implementations.
      5. Update necessary "scanners" to use the new API.

              Unassigned Unassigned
              hdonnay Henry Donnay
              Votes:
              2 Vote for this issue
              Watchers:
              7 Start watching this issue

                Created:
                Updated: