fix(opensearch): scope CycloneDX SBOM to shipped components only#1452
Open
fix(opensearch): scope CycloneDX SBOM to shipped components only#1452
Conversation
This file contains hidden or 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
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.
Description
Scope the CycloneDX SBOM generation to only include subprojects that are actually shipped in the Stackable OpenSearch image. The image uses the
opensearch-mindistribution which does not include plugins, but the SBOM was generated from the full Gradle build graph, causing false positive vulnerability reports for dependencies of unshipped plugins (e.g. CVE-2025-66516 for tika-core from the ingest-attachment plugin).Only
repository-s3andtelemetry-otelare extracted from the local build into the image. All other plugin subprojects and example-plugins are now excluded from the BOM.The approach differs per OpenSearch version due to different CycloneDX plugin versions:
skipProjectscyclonedxDirectBomtask for unshipped pluginsThe patches would ideally need to be adapted once we decide to ship more plugins. However, even if the SBOM is not generated for some plugins, all shipped plugins inside the image should still be picked up by Syft once we scan the container image to generate the SBOM (only the dependency relationship information will probably missing for these plugins).
I built both images and verified the component is not present anymore:
Definition of Done Checklist
Note
Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant.
Please make sure all these things are done and tick the boxes
TIP: Running integration tests with a new product image
The image can be built and uploaded to the kind cluster with the following commands:
See the output of
boilto retrieve the image manifest URI for<MANIFEST_URI>.