From 0d6459848b406fa0db6dfa13b0fdda11f04bcf79 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Mon, 20 Mar 2017 14:48:08 -0700 Subject: [PATCH 1/2] Create Image Tools Interface Describes an interface that the image-tools project could provide for image validation Signed-off-by: Rob Dolin --- image-tools-interface.md | 49 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 image-tools-interface.md diff --git a/image-tools-interface.md b/image-tools-interface.md new file mode 100644 index 00000000..5a04c5a2 --- /dev/null +++ b/image-tools-interface.md @@ -0,0 +1,49 @@ +# Image Tools Interface + +The below document describes an interface for the OCI Image Tools project as desired by the OCI Certification Program working group (Cert WG.) + +Goals: +* An engineer can verify a container image complies with the OCI Image Spec (https://github.com/opencontainers/image-spec/releases) + +Inputs: +* (REQUIRED): Path or reference to a container image +* (OPTIONAL): If the user would like verbose output + +Outputs: +* Number of cases run +* Number of cases passed +* Number of cases failed +* List of cases failed +* Version of OCI Image Tools +* (IF VERBOSE) List of cases passed + +## Possible Example + +INPUT: +`oci-image-tools image validate ` + +OUTPUT (default): +``` +OCI Image Tools vX.Y.Z validating : +Case 12: FAILED: Image using reserved field key: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#reserved +Results: +* Ran: 24 / 24 (100%) validation cases +* Passed: 23 / 24 (96%) +* Failed: 1 / 24 (4%) +``` + +OUTPUT (verbose): +``` +OCI Image Tools vX.Y.Z validating : +Case 1: PASSED: … +Case 2: PASSED: … +… +Case 12: FAILED: Image using reserved field key: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#reserved +Case 13: PASSED: … +… +Case 24: PASSED: … +Results: +* Ran: 24 / 24 (100%) validation cases +* Passed: 23 / 24 (96%) +* Failed: 1 / 24 (4%) +``` From b0268a687ab28b22f1bbad8ac1f54b66f44530e2 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Thu, 13 Apr 2017 14:19:03 -0700 Subject: [PATCH 2/2] [Image Tools Interface] Add Image Spec version --- image-tools-interface.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/image-tools-interface.md b/image-tools-interface.md index 5a04c5a2..36ffdc95 100644 --- a/image-tools-interface.md +++ b/image-tools-interface.md @@ -8,6 +8,8 @@ Goals: Inputs: * (REQUIRED): Path or reference to a container image * (OPTIONAL): If the user would like verbose output +* (OPTIONAL): Which version of the OCI Image Spec to validate against +(IF the OCI Image Tool supports multiple OCI Image Spec versions; Default to highest supported) Outputs: * Number of cases run @@ -15,6 +17,7 @@ Outputs: * Number of cases failed * List of cases failed * Version of OCI Image Tools +* Version of OCI Image Spec * (IF VERBOSE) List of cases passed ## Possible Example @@ -24,7 +27,7 @@ INPUT: OUTPUT (default): ``` -OCI Image Tools vX.Y.Z validating : +OCI Image Tools vX.Y.Z validating with OCI Image Spec vA.B.C: Case 12: FAILED: Image using reserved field key: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#reserved Results: * Ran: 24 / 24 (100%) validation cases @@ -34,7 +37,7 @@ Results: OUTPUT (verbose): ``` -OCI Image Tools vX.Y.Z validating : +OCI Image Tools vX.Y.Z validating with OCI Image Spec vA.B.C: Case 1: PASSED: … Case 2: PASSED: … …