Closed rachitb777 closed 3 years ago
Discussion Notes:
Here are few more open questions that came up in review with @smalpani-gh
cc: @rachitb777 , @ammohant , @azooinmyluggage , @pulkitaggarwl , @ds-ms
What is the right naming : Is it Microsoft/GitHub/........? Examples https://github.com/opencontainers/image-spec/blob/master/annotations.md. http://label-schema.org/rc1/
Artifact: What other types will be there and why everything for K8s is of type container artifact.
Design question : How can we work around the need to download image and running docker inspect
Design question : How can we work around the need to download image and running docker inspect
Two ways that we have discussed earlier. One is store it somewhere just like ADO but we understood from GH is building some sort of a store that we can leverage. Second is to have an environment variable store the Docker file path , this is not a full proof way.
@smalpani-gh - This the final schema for the traceability we are closing on. Pls let us know of comments if any.
@rachitb777 @rohit-batra We can commit the final version of the schema once Sanjay gives the go ahead.
@rachitb777 Can I close this issue since we have deferred this work? We can open a new issue when we plan to pick this up.
Abstract Traceability involves ability to track the source for issue, code, commit, artifact, workflow, and the user from the package deployed on the resource, through documented records. This document proposes the traceability schema which captures the traceability data for any deployment which can be used by any "CI/CD" providers and cloud providers to organize the traceability data and consume it in various forms.
Format: The schema organizes the information in the following way
Categorization of various sections :
What was deployed ? Captures the artifacts’ details that has been deployed
Where did it get deployed ? Captures the target resource where the deployment has happened.
The “How” and “Where” part can come from various providers which the schema factors in by having a provision to have any new source “type/provider” to use the schema to generate the traceability data or a cloud provider to deploy the data onto its respective cloud. This definition of the schema makes it agnostic to both cloud providers (Azure, AWS, GCP ,Kusto) as well as source control providers (GitHub, ADO, Bitbucket).
Representation of a specific section: Data is organized into the following in each of the section/categorizes within the traceability data -