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

docs: update tradeoffs section to reflect scanner independence (#818) #888

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

Conversation

pradhans0906
Copy link
Contributor

Updates the tradeoffs section in the design documentation to accurately reflect copa's ability to work with or without vulnerability scanner reports.

The changes:

  • Remove outdated statements about scanner report dependencies
  • Clarify the package-based update model
  • Maintain information about package manager dependencies and platform limitations
  • Improve document structure for better readability

Changes

  • Replace outdated tradeoffs content with updated, accurate information
  • Add clearer section organization with numbered points
  • Update description of scanner integration to reflect optional usage

Closes #818

website/versioned_docs/version-v0.9.x/design.md Outdated Show resolved Hide resolved
website/versioned_docs/version-v0.9.x/design.md Outdated Show resolved Hide resolved
website/versioned_docs/version-v0.9.x/design.md Outdated Show resolved Hide resolved
@ashnamehrotra
Copy link
Contributor

@pradhans0906 thanks for the PR! Looks like commit needs sign-off for DCO check

pradhans0906 and others added 7 commits January 19, 2025 17:12
Updates the tradeoffs section in the design documentation to accurately reflect copa's ability to work with or without vulnerability scanner reports.

The changes:
- Remove outdated statements about scanner report dependencies
- Clarify the package-based update model
- Maintain information about package manager dependencies and platform limitations
- Improve document structure for better readability

# Changes
- Replace outdated tradeoffs content with updated, accurate information
- Add clearer section organization with numbered points
- Update description of scanner integration to reflect optional usage

Closes project-copacetic#818

Signed-off-by: swapnasagar pradhan <[email protected]>
…up (project-copacetic#889)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#891)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…acetic#892)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…t-copacetic#893)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.98%. Comparing base (252a358) to head (fceeb8a).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #888   +/-   ##
=======================================
  Coverage   46.98%   46.98%           
=======================================
  Files          18       18           
  Lines        2205     2205           
=======================================
  Hits         1036     1036           
  Misses       1111     1111           
  Partials       58       58           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines +93 to +94
- Windows containers lack a standardized package upgrade mechanism and has limited Windows continer support
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- While BuildKit has experimental Windows container support
- Windows containers lack a standardized package upgrade mechanism and has limited Windows continer support
- While BuildKit has experimental Windows container support, Windows containers lack a standardized package upgrade mechanism

Copy link
Contributor

Choose a reason for hiding this comment

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

and same changes in other versioned docs

1. **Package-Based Update Model**:
- While Copa can work with or without vulnerability scanner reports, its patching capability is fundamentally based on OS package updates
- When using scanner reports, false positives/negatives from scanners flow downstream to copa
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- When using scanner reports, false positives/negatives from scanners flow downstream to copa
- When using scanner reports, false positives/negatives from scanners flow downstream to Copa

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

[DOC] update design/tradeoffs doc regarding scanner vuln reports
2 participants