docs: ADR-0003: customization of list output #103
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jonathan Howard <[email protected]>
jhoward-lm
requested review from
eddiezane,
houdini91,
ashearin,
idunbarh and
mfrystacky
|
I don't have an opinion on this. @eddiezane and @ashearin what are your thoughts? |
… meeting on 7/29/2024 Signed-off-by: Ian Dunbar-Hall <[email protected]>
|
ADR was discussed and approved during the community call on 7/29/2024. Minor updates were added to clarify a separate |
idunbarh
approved these changes
Jul 30, 2024
ashearin
approved these changes
Aug 5, 2024
idunbarh
added
the
adr
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
3. List output customization
Date: 2024-07-11
Status
Accepted
Context
This is an enhancement proposal to allow users to customize the output of
bomctl listthat listsSBOM Documents by specifying a search expression, filter, or template.
Decision
Update
bomctl listto accept an expression to customize the output table of SBOM documents.This would be similar in functionality to the
--formatoption used by variousdockercommands.Either the existing use of positional argument will be retained, or an additional flag (such as
--formator--query) will be added.The supported search/filter expression syntaxes will be:
The expression would then be parsed to construct a SQL query or call to the
entbackend toretrieve and display the desired table(s)/column(s).
A separate
bomctl querycommand will be used to query/filter nodes,bomctl listis reservedfor finding SBOM Documents.
@puerco recommended reading the store into CEL to simplify listing.
Consequences
This change would allow users greater control over inspecting the contents of their cached SBOMs.