Please read the Contributing Guide for guidance on how to structure a contribution and what to expect.
To aid with a mental model a high level execution flow of the tool is shown here:
From a simplistic point of view the tool is a special-purpose templating engine that attempts to find the template from among the references which, when rendered, will best match the cluster manifest. It then reports the differences between the rendered result and the cluster manifest.
Correlators are the mechanism by which a cluster manifest is matched to a template from the reference. Various types of Correlator are available with different matching criteria, see the implementations for more details.
TODO details on how to write tests