vmware-tanzu / cartographer

Cartographer is a Supply Chain Choreographer.
https://cartographer.sh
Apache License 2.0
446 stars 64 forks source link

Add examples that clearly describe how to see the value cartographer brings when using existing pipeline tooling #266

Open rawlingsj opened 3 years ago

rawlingsj commented 3 years ago

Description of problem

If you are completely new to Cartographer, which most folks are ATM, it is a little hard to understand where its value is when comparing to existing pipeline tooling / projects. The current example replicates what most release pipelines are currently doing which can cause confusion as it may seem that Cartographer should be used to replace existing pipelines.

E.g. folks that are using Tekton are almost certainly already building + pushing images using pipeline tasks plus users will already have existing methods for triggering these pipelines, such as Tekton triggers, Prow, Lighthouse. The same situation exists for Jenkins, GHA, Circle, etc etc. Understanding how to kick the tires of Cartographer with their existing automation tooling will help users quickly want to invest time in Proof of Concepts, adoption and contribution.

So to help folks that are new to Cartographer and want to understand the value it gives above their existing automation tooling we should have some clear docs and examples that describe the lines of responsibility and walk people through a simple way to integrate. We want to avoid people thinking that to adopt Cartographer it will involve a redesign or replacement for their existing tooling which most teams will have already invested heavily in. Reducing the barrier to entry.

Proposed solution

Given I am new to Cartographer with no prior knowledge 
When I want to learn the value it will provide me and help decide whether to invest time looking closer
Then I would like to have some examples of how to kick the tires when integrated with existing tooling to promote, validate and approve

Example

Create an example that describes the steps of enabling Cartographer to a cluster that has an existing Tekton pipeline which is building an image and already being triggered via a github commit event. Then using Cartographer to describe promotion, validation and approve paths to production.

Additional Context

Related thread in the community slack channel https://kubernetes.slack.com/archives/C02HKPSEKV1/p1635175384013900?thread_ts=1634906085.009700&cid=C02HKPSEKV1

github-actions[bot] commented 3 years ago

Hello @rawlingsj! Welcome to the Cartographer community and thank you for opening your first issue, we appreciate your contributions

rawlingsj commented 3 years ago

Something to consider is how to not only integrate with tooling and reducing the barrier to entry of using Cartographer but also how to integrate with existing workflows.