Cartographer

Warning The Cartographer upstream project is not actively developed anymore. As a consequence, this package has been archived. Check out the https://github.com/kadras-io/supply-chains package from the Kadras Engineering Platform as an alternative.

A Carvel package for Cartographer, a cloud-native framework to build paved paths to production on Kubernetes.

🚀  Getting Started

Prerequisites

• Kubernetes 1.27+

• Carvel kctrl CLI.

• Carvel kapp-controller deployed in your Kubernetes cluster. You can install it with Carvel kapp (recommended choice) or kubectl.

  kapp deploy -a kapp-controller -y \
    -f https://github.com/carvel-dev/kapp-controller/releases/latest/download/release.yml

Dependencies

Cartographer requires cert-manager. You can install it from the Kadras package repository.

Installation

Add the Kadras package repository to your Kubernetes cluster:

kctrl package repository add -r kadras-packages \
  --url ghcr.io/kadras-io/kadras-packages \
  -n kadras-packages --create-namespace

Installation without package repository

The recommended way of installing the Cartographer package is via the Kadras package repository. If you prefer not using the repository, you can add the package definition directly using kapp or kubectl.

kubectl create namespace kadras-packages
kapp deploy -a cartographer-package -n kadras-packages -y \
  -f https://github.com/kadras-io/package-for-cartographer/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-cartographer/releases/latest/download/package.yml

Install the Cartographer package:

kctrl package install -i cartographer \
  -p cartographer.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-packages

Note You can find the ${VERSION} value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.

kctrl package available list -p cartographer.packages.kadras.io -n kadras-packages

Verify the installed packages and their status:

kctrl package installed list -n kadras-packages

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to Cartographer, check out cartographer.sh.

🎯  Configuration

The Cartographer package can be customized via a values.yml file.

cartographer:
  concurrency:
    max_workloads: 10
    max_deliveries: 10

Reference the values.yml file from the kctrl command when installing or upgrading the package.

kctrl package install -i cartographer \
  -p cartographer.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-packages \
  --values-file values.yml

Values

The Cartographer package has the following configurable properties.

Configurable properties

Config	Default	Description
optional_components.cartographer_conventions	true	Whether to deploy the Cartographer Conventions component.
ca_cert_data	""	PEM-encoded certificate data to trust TLS connections with a custom CA.
logging.level	info	Log verbosity level. Options: debug, info, error.

Settings for the Cartographer component.

Config	Default	Description
cartographer.concurrency.max_workloads	2	Maximum concurrent Workloads processed by the Cartographer controller.
cartographer.concurrency.max_runnables	2	Maximum concurrent Runnables processed by the Cartographer controller.
cartographer.concurrency.max_deliveries	2	Maximum concurrent Deliveries processed by the Cartographer controller.
cartographer.resources.requests.cpu	500m	CPU requests configuration for the Cartographer controller.
cartographer.resources.requests.memory	512Mi	Memory requests configuration for the Cartographer controller.
cartographer.resources.limits.cpu	1	CPU limits configuration for the Cartographer controller.
cartographer.resources.limits.memory	1Gi	Memory limits configuration for the Cartographer controller.

Settings for the Cartographer Conventions component.

Config	Default	Description
conventions.resources.requests.cpu	100m	CPU requests configuration for the Cartographer Conventions controller.
conventions.resources.requests.memory	20Mi	Memory requests configuration for the Cartographer Conventions controller.
conventions.resources.limits.cpu	100m	CPU limits configuration for the Cartographer Conventions controller.
conventions.resources.limits.memory	256Mi	Memory limits configuration for the Cartographer Conventions controller.

🛡️  Security

The security process for reporting vulnerabilities is described in SECURITY.md.

🖊️  License

This project is licensed under the Apache License 2.0. See LICENSE for more information.

🙏  Acknowledgments

This package is based on the original Cartographer package used in the Tanzu Community Edition project before its retirement.