Skip to content

Commit

Permalink
doc(adr): Added component versioning ADR for policy scanning (#246)
Browse files Browse the repository at this point in the history
  • Loading branch information
Max Luong committed Oct 15, 2024
1 parent ec67d47 commit ad04bca
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/adr/components-for-policy-scanning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Component Versioning for Openstack Entities

## Context and Problem Statement

How to accomodate Openstack entities like Security Groups in the existing Entity Relationship of Heureka?

The current Entity Relationships in Heureka are defined for vulnerabilities in objects like containers, where it is intuitive to have ComponentVersion and ComponentInstances. For non-compliance (not exactly vulnerabilities) in entities like Security Group, how to adapt to existing data model?

## Decision Drivers

* Fits into existing data model
* Make use of Heureka Issue Matching through Component Version

## Considered Options

* Opt 1: Using the configuration as ComponentVersion
* Opt 2: Adding ComponentContext to ComponentInstance
* Opt 3: Do not store any configuration context data

## Decision Outcome

Chosen option: "Opt 1: Using Configuration as ComponentVersion", because neither option 2 or 3 fully utilize existing entity relationships in Heureka

### Consequences

* Good, because we can decrypt the hash to get the configuration back to do processing
* Good, because we are using the same Entity Relationship logic for "Vulnerabilities" as well, so Heureka now handles issue matching, not the scanner
* Bad, because the naming of ComponentVersion may be confusing, as we only store the hash of the configuration, not the config itself


## Pros and Cons of the Options

### Opt 1: Using the configuration as ComponentVersion
![](../images/components-for-policy-scanning-opt1.png)
We use the configuration of the Openstack entity and hash it to create a unique ComponentVersion.

* Good, because we can decrypt the hash to get the configuration back to do processing
* Good, because we are using the same Entity Relationship logic for "Vulnerabilities" as well, so Heureka now handles issue matching, not the scanner
* Bad, because the naming of ComponentVersion may be confusing, as we only store the hash of the configuration, not the config itself

### Opt 2: Adding ComponentContext to ComponentInstance
![](../images/components-for-policy-scanning-opt2.png)
We add a new entity called ComponentContext to the Entity Relationship for Component Instance

* Good, because having ComponentContext makes it easier to differentiate between Component Instances
* Bad, because there is no matching happening in Heureka, and scanner handles it without ComponentVersion
* Bad, because we are NOT using the same Entity Relationship logic for "Vulnerabilities"

### Opt 3: Do not store any configuration context data
![](../images/components-for-policy-scanning-opt3.png)
We do not store ComponentVersion or add ComponentContext for Openstack ComponentInstances

* Good, because it simplies handling the configuration and versioning
* Bad, because there is no matching happening in Heureka, and scanner handles it without ComponentVersion
* Bad, because we are NOT using the same Entity Relationship logic for "Vulnerabilities"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad04bca

Please sign in to comment.