cartographer

README

Cartographer

Cartographer is a Kubernetes-native Choreographer providing higher modularity and scalability for the software supply chain.

Learn more about Cartographer

Getting Started

Examples of using Cartographer can be found in the examples folder of this repository. The examples begin by demonstrating how to define a Supply Chain that pulls code from a repository, builds an image for the code, and deploys in the same cluster. Enhancements of that example (e.g. adding tests) are then demonstrated.

Installation

Pre requisites

1. Administrative capabilities in a Kubernetes cluster (1.19+)
2. cert-manager 1.5.3 installed

The quickest method to install Cartographer leverages the cartographer.yaml file provided with each release:

1. Create the namespace where the controller will be installed:

kubectl create namespace cartographer-system

1. Submit the objects included in the release:

kubectl apply -f https://github.com/vmware-tanzu/cartographer/releases/latest/download/cartographer.yaml

And you're done!

Documentation

Detailed documentation for Cartographer can be found in the site folder of this repository:

• About Cartographer: details the design and philosophy of Cartographer
• Architecture: covers the concepts and theory of operation
• Tutorials: gives a quickstart guide to working with Cartographer
• Examples: contains a collection of examples that demonstrate how common patterns can be implemented in Cartographer
• Spec Reference: detailed descriptions of the CRD Specs for Cartographer
  • GVK
  • Workload and Supply Chains
  • Deliverable and Delivery
  • Templates
  • Runnable
• Cartotest: explains how to use the cartotest CLI to affirm your templates

🤗 Community, discussion, contribution, and support

Cartographer is developed in the open and is constantly improved by our users, contributors and maintainers. It is because of you that we are able to configure Kubernetes resources into reusable Supply Chains.

Join us!

If you have questions or want to get the latest project news, you can connect with us in the following ways:

• Chat with us in the Kubernetes Slack in the #cartographer channel
• Subscribe to the Cartographer Google Group for access to discussions and calendars
• Join our weekly Office Hours meetings where we share the latest project news, answer questions and discuss the ideas to keep improving the project following the RFC process :
  • Every Monday @ 2:00PM ET on Zoom
  • Previous meetings: [notes | recordings]

Contributing

Pull Requests and feedback on issues are very welcome! See the issue tracker if you're unsure where to start, especially the Good first issue label, and also feel free to reach out to discuss.

If you are ready to jump in and test, add code, or help with documentation, please follow the instructions on our Contribution Guidelines to get started and - at all times- follow our Code of Conduct.

License

Apache 2.0. Refer to LICENSE for details.