Design Documents¶
An index of various (informal) design and explanation documents that were created for different purposes. Mainly to brainstorm how Starboard works.
NOTE This is not an official documentation of Starboard. Some design documents may be out of date.
Overview¶
| File | Description |
|---|---|
| caching_scan_result_by_repo_digest.md | [DRAFT] Caching Scan Results by Image Reference |
| design_trivy_file_system_scanner.md | Scan Container Images with Trivy Filesystem Scanner |
| design_vulnerability_scan_in_same_ns.md | Schedule vulnerability scan jobs in the same namespace as scanned workload |
| design_scan_by_image_digest.png | Design of vulnerability scanning by image digest (ContainerStatus vs PodSpec). |
| design_starboard_at_scale.png | Design of Starboard Operator at scale with more efficient worker queue. |
| design_vulnerability_scanning_2.0.png | Design of most efficient vulnerability scanning that you can imagine. |
| explain_starboard_rescan_jitter.png | Explain a preferred way to rescan (evenly distributed vs bursty events). |
| explain_starboard_cli_init.png | Explain which K8s API object are created when the starboard init command is executed. |
| design_namespace_security_report.pdf | Design of a security report generated by Starboard CLI for a given namespace. |
