From 98a76e83c39251959cfd317558a74fc94d75e108 Mon Sep 17 00:00:00 2001 From: Ramkumar Chinchani Date: Mon, 23 Dec 2019 23:32:08 -0800 Subject: [PATCH] README: update notes about compliance clarify what compliance tests will achieve report results of tests conducted --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 78dfccd0..d1c2d8a8 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,34 @@ Examples of config files are available in [examples/](examples/) dir. bin/zot compliance -H hostIP -P port [-V "all"] [--json] ``` +Compliance is important for the following reasons: + +1. A standards-based client code can be implemented that can then interact with + compliant registries. + +2. Customers benefit from the ability to move and locate their images across + compliant registries. + +## Methodology + +* A _positive_ compliance means the registry is compliant and meaningful work +can be accomplished when interacting with that registry. + +* A _negative_ compliance means the registry is compliant, however, it only +returns errors that are compliant and no meaningful work can be performed when +interacting with that registry. + +The focus of compliance tests is _positive_ compliance. + +## Compliance Reports + +Registry | Notes +---------|------ +zot | +docker | +quay | TBD + + # Ecosystem ## skopeo