Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADR - Handling component version in policy violation based scanners #293

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

maxwellL21
Copy link
Collaborator

Description

This adds the ADR for handling "component" entities in Heureka for policy scanning and adds an "images" folder for the ADR documentations. The description of the ADR deals with the following issue: 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?

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help
  • Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added to documentation?

  • 📜 README.md
  • 🤝 Documentation pages updated
  • 🙅 no documentation needed
  • (if applicable) generated OpenAPI docs for CRD changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@maxwellL21 maxwellL21 self-assigned this Oct 16, 2024
Copy link
Collaborator

@drochow drochow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just a couple minor comments, please address!

docs/adr/components-for-policy-scanning.md Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Outdated Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Outdated Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Outdated Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Show resolved Hide resolved
docs/adr/components-for-policy-scanning.md Show resolved Hide resolved
@drochow
Copy link
Collaborator

drochow commented Oct 22, 2024

@maxwellL21 please address

@drochow drochow added the question Further information is requested label Oct 22, 2024
dorneanu
dorneanu previously approved these changes Oct 22, 2024
Copy link
Collaborator

@dorneanu dorneanu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@maxwellL21
Copy link
Collaborator Author

maxwellL21 commented Oct 24, 2024

@drochow Hey David, Sorry for the wait. I added the mermaid diagrams. Should we keep the "images" folder? To include the original diagrams?

Also would you like the Mermaid diagrams to have the 1 to many relationships, etc? Or is that detail not necessary

maxwellL21

This comment was marked as spam.

@maxwellL21 maxwellL21 requested a review from drochow November 4, 2024 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

research(OS_Scan): Research on how to handle component version in policy violation based scanners
3 participants