Skip to content

Commit 1b60142

Browse files
committed
docs: update tradeoffs section to reflect scanner independence (#818)
Signed-off-by: swapnasagar pradhan <[email protected]>
1 parent e7851ce commit 1b60142

File tree

3 files changed

+48
-12
lines changed

3 files changed

+48
-12
lines changed

website/versioned_docs/version-v0.7.x/design.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,19 @@ type PackageManager interface {
7676

7777
## Tradeoffs
7878

79-
- The core architectural choice of relying on packages as the unit of patching creates a couple of constraints:
80-
- By relying on existing vulnerability scanner behavior that only detects vulnerabilities via presence/absence of vulnerable packages, copa is limited in the kinds of vulnerabilities it can address and false positive/negatives from scanners flow downstream to copa.
81-
- copa depends on individual package manager adapters to correctly deploy patches to the target images, but there is a long tail of compatibility issues that arise depending on the target image itself (e.g. outdated package manager config/keys, invalid/missing package graph, etc.). Overall, the maintenance cost of the project is expected to be non-trivial to address this.
82-
- No support for windows containers given the dependency on buildkit.
79+
The core architectural choice of using packages as the unit of patching creates several constraints:
80+
81+
1. **Package-Based Update Model**:
82+
- While Copa can work with or without vulnerability scanner reports, its patching capability is fundamentally based on os-level package updates
83+
- When using scanner reports to perform a targeted patching of packages, false positives/negatives from scanners flow downstream to Copa
84+
85+
2. **Package Manager Dependencies**:
86+
- Copa depends on individual package manager adapters to correctly deploy patches to target images
87+
- There is a long tail of compatibility issues that arise depending on the target image itself:
88+
- Outdated package manager config/keys
89+
- Invalid/missing package graph
90+
- Repository configuration issues
91+
- Overall, the maintenance cost of the project is expected to be non-trivial to address these package manager complexities
92+
93+
3. **Platform Limitations**:
94+
- No support for Windows containers given the dependency on buildkit

website/versioned_docs/version-v0.8.x/design.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,19 @@ type PackageManager interface {
7676

7777
## Tradeoffs
7878

79-
- The core architectural choice of relying on packages as the unit of patching creates a couple of constraints:
80-
- By relying on existing vulnerability scanner behavior that only detects vulnerabilities via presence/absence of vulnerable packages, copa is limited in the kinds of vulnerabilities it can address and false positive/negatives from scanners flow downstream to copa.
81-
- copa depends on individual package manager adapters to correctly deploy patches to the target images, but there is a long tail of compatibility issues that arise depending on the target image itself (e.g. outdated package manager config/keys, invalid/missing package graph, etc.). Overall, the maintenance cost of the project is expected to be non-trivial to address this.
82-
- No support for windows containers given the dependency on buildkit.
79+
The core architectural choice of using packages as the unit of patching creates several constraints:
80+
81+
1. **Package-Based Update Model**:
82+
- While Copa can work with or without vulnerability scanner reports, its patching capability is fundamentally based on os-level package updates
83+
- When using scanner reports to perform a targeted patching of packages, false positives/negatives from scanners flow downstream to Copa
84+
85+
2. **Package Manager Dependencies**:
86+
- Copa depends on individual package manager adapters to correctly deploy patches to target images
87+
- There is a long tail of compatibility issues that arise depending on the target image itself:
88+
- Outdated package manager config/keys
89+
- Invalid/missing package graph
90+
- Repository configuration issues
91+
- Overall, the maintenance cost of the project is expected to be non-trivial to address these package manager complexities
92+
93+
3. **Platform Limitations**:
94+
- No support for Windows containers given the dependency on buildkit

website/versioned_docs/version-v0.9.x/design.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,19 @@ type PackageManager interface {
7676

7777
## Tradeoffs
7878

79-
- The core architectural choice of relying on packages as the unit of patching creates a couple of constraints:
80-
- By relying on existing vulnerability scanner behavior that only detects vulnerabilities via presence/absence of vulnerable packages, copa is limited in the kinds of vulnerabilities it can address and false positive/negatives from scanners flow downstream to copa.
81-
- copa depends on individual package manager adapters to correctly deploy patches to the target images, but there is a long tail of compatibility issues that arise depending on the target image itself (e.g. outdated package manager config/keys, invalid/missing package graph, etc.). Overall, the maintenance cost of the project is expected to be non-trivial to address this.
82-
- No support for windows containers given the dependency on buildkit.
79+
The core architectural choice of using packages as the unit of patching creates several constraints:
80+
81+
1. **Package-Based Update Model**:
82+
- While Copa can work with or without vulnerability scanner reports, its patching capability is fundamentally based on os-level package updates
83+
- When using scanner reports to perform a targeted patching of packages, false positives/negatives from scanners flow downstream to Copa
84+
85+
2. **Package Manager Dependencies**:
86+
- Copa depends on individual package manager adapters to correctly deploy patches to target images
87+
- There is a long tail of compatibility issues that arise depending on the target image itself:
88+
- Outdated package manager config/keys
89+
- Invalid/missing package graph
90+
- Repository configuration issues
91+
- Overall, the maintenance cost of the project is expected to be non-trivial to address these package manager complexities
92+
93+
3. **Platform Limitations**:
94+
- No support for Windows containers given the dependency on buildkit

0 commit comments

Comments
 (0)