Cartographer is a Kubernetes native Choreographer. It allows users to configure K8s resources into re-usable Supply Chains that can be used to define all of the stages that an Application Workload must go through to get to an environment.
Cartographer also allows for separation of controls between a user who is responsible for defining a Supply Chain (known as a App Operator) and a user who is focused on creating applications (Developer). These roles are not necessarily mutually exclusive, but provide the ability to create a separation concern.
- WARNING!! At this time, the Supply Chain ClusterRoleBinding has more permissions than it needs. This will be fixed in an upcoming release. The issue can be tracked here.
Detailed documentation for Cartographer can be found in the site folder of this repository:
- About Cartographer: Details the design and philosophy of Cartographer
- Examples: Contains an example of using Cartographer to create a supply chain that takes a repository, creates and image and deploys it to a cluster
- Spec Reference: Detailed descriptions of the CRD Specs for Cartographer
An example of using Cartographer to define a Supply Chain that pulls code from a repository, builds an image for the code and deploys it the the same cluster can be found in the examples folder of this repository
Installation details are provided in the documentation at cartographer.sh/docs/install
Uninstallation details are provided in the documentation at cartographer.sh/docs/uninstall
Refer to CONTRIBUTING.md for instructions on running tests.
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 community meetings where we share the latest project news, demos, answer questions, among other topics:
- Every Wednesday @ 8:00 AM PT on Zoom
- Previous meetings: [notes | recordings]
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.
Refer to LICENSE for details.