docs: ADR-0005: SBOM document aliases/tags 8000 #105
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
5. SBOM document aliases/tags
Date: 2024-07-11
Status
Accepted
Context
A shorter form of referencing SBOM documents stored in
bomctl
's database is needed, while alsoadding adding annotations/labels for adding key/value pair metadata.
Decision
Add support for user assignment of annotations/labels per stored SBOM document:
alias
key is reserved and will be used as a unique short hand label for the SBOM documentThese options could also be consolidated into a unified concept such as labels.
Users should be able to perform this action either at fetch/import or as a standalone command/operation.
Consequences
Implementing
alias
key could be limiting due to their 1:1 association.Using the label methodology may provide greater flexibility in association between documents for
actions like storing and retrieving a group of SBOMs in a tree structure.