Cartographer
Cartographer is a Kubernetes-native Choreographer.
Documentation
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 an image, and deploys it to a cluster
- Spec Reference: Detailed descriptions of the CRD Specs for 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
Installation details are provided in the documentation at cartographer.sh/docs/install
Uninstall
Uninstallation details are provided in the documentation at cartographer.sh/docs/uninstall
Running Tests
Refer to CONTRIBUTING.md for instructions on running tests.
🤗 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 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]
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
Refer to LICENSE for details.