Spring Boot Conventions

Warning The Cartographer Conventions 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 the Spring Boot Convention Server, a component that works with Cartographer Conventions to apply best-practices to workloads at runtime by understanding the developer's intent. It is a key component to build application-aware platforms rather than forcing applications to be platform-aware.

🚀  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

Spring Boot Conventions requires the Cartographer and cert-manager packages. You can install them 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 Spring Boot Conventions 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 spring-boot-conventions-package -n kadras-packages -y \
  -f https://github.com/kadras-io/package-for-spring-boot-conventions/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-spring-boot-conventions/releases/latest/download/package.yml

Install the Spring Boot Conventions package:

kctrl package install -i spring-boot-conventions \
  -p spring-boot-conventions.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 spring-boot-conventions.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 Conventions, check out github.com/vmware-tanzu/cartographer-conventions.

🎯  Configuration

The Spring Boot Conventions package can be customized via a values.yml file.

namespace: spring-boot-conventions

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

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

Values

The Spring Boot Conventions package has the following configurable properties.

Configurable properties

Config	Default	Description
namespace	spring-boot-conventions	The namespace where to install Spring Boot Conventions.
resources.limits.cpu	100m	CPU limits for the Convention Server.
resources.limits.memory	256Mi	Memory limits for the Convention Server.
resources.requests.cpu	100m	CPU requests for the Convention Server.
resources.requests.memory	20Mi	Memory requests for the Convention Server.

🛡️  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.