From 65b92d6bbb4b3bd429a2dcec995791710971f6e6 Mon Sep 17 00:00:00 2001 From: prahaladd Date: Mon, 24 May 2021 00:43:30 +0530 Subject: [PATCH] Incorporated table of contents Signed-off-by: prahaladd --- proposals/pluggable-image-scanning-api-v2.md | 26 ++++++++++++-------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/proposals/pluggable-image-scanning-api-v2.md b/proposals/pluggable-image-scanning-api-v2.md index 3146014a..a6623310 100644 --- a/proposals/pluggable-image-scanning-api-v2.md +++ b/proposals/pluggable-image-scanning-api-v2.md @@ -4,19 +4,25 @@ Authors: Prahalad Deshpande @prahaladd Proposed Reviewers: Steven Zou @szou, Daniel Pacak @danielpacak, Zach Hill @zhill -## Discussions - -[Initial Meeting of the Harbor Scanner Workgroup on 19th March 2021](https://drive.google.com/file/d/1TXjsASDPEBL30yFAk0Wnmg5sB3Ka4yw2/view?usp=sharing) -## TOC -- Abstract -- Use Cases -- Design - - High Level Component Interaction - - Result Aggregation - - Error Handling +- [Proposal: Unified API for Pluggable Image Scanners](#proposal-unified-api-for-pluggable-image-scanners) + - [Discussions](#discussions) + - [Abstract](#abstract) + - [Use Cases](#use-cases) + - [Unified API Requirements](#unified-api-requirements) + - [Unified API Design](#unified-api-design) + - [Supporting multiple scan types](#supporting-multiple-scan-types) + - [Scan capability advertisement by scanner implementations](#scan-capability-advertisement-by-scanner-implementations) + - [Single endpoint to trigger scans](#single-endpoint-to-trigger-scans) + - [Scan API Endpoint Multiplexing](#scan-api-endpoint-multiplexing) + - [Scan API response handling](#scan-api-response-handling) + - [Error Handling](#error-handling) + - [Advantages of proposed design](#advantages-of-proposed-design) + - [References](#references) +## Discussions +[Initial Meeting of the Harbor Scanner Workgroup on 19th March 2021](https://drive.google.com/file/d/1TXjsASDPEBL30yFAk0Wnmg5sB3Ka4yw2/view?usp=sharing) ## Abstract Maintaining the security and compliance of container images stored within the Harbor registry entails more than just software package and OS vulnerability scanning results such as enumerating the Bill of Materials present in an image or validating the contents of the container file system.