Kadras Application Platform

Warning This package has been replaced by engineering-platform.

A curated set of Carvel packages to build an engineering platform supporting application developers with paved paths to production on Kubernetes.

🚀  Getting Started

Prerequisites

• Kubernetes 1.24+

• 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

Installation

Add the Kadras package repository to your Kubernetes cluster:

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

Installation without package repository

The recommended way of installing the Kadras Application Platform 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 application-platform-package -n kadras-packages -y \
  -f https://github.com/kadras-io/kadras-application-platform/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/kadras-application-platform/releases/latest/download/package.yml

Install the Kadras Application Platform package:

kctrl package install -i application-platform \
  -p application-platform.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 application-platform.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.

🎯  Configuration

The Kadras Application Platform package can be customized via a values.yml file.

excluded_blueprints:
  - "config-template"

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

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

Values

The Kadras Application Platform package has the following configurable properties.

Configurable properties

Config	Default	Description
packages.namespace	""	The namespace where to install the platform.
packages.exclusions	[]	A list of packages to exclude from being installed.
cartographer.blueprints	{}	Configuration for the Cartographer Blueprints package.
cartographer.delivery	{}	Configuration for the Cartographer Delivery package.
cartographer.supply_chains	{}	Configuration for the Cartographer Supply Chains package.
cert_manager	{}	Configuration for the Cert Manager package.
contour	{}	Configuration for the Contour package.
conventions.spring_boot	{}	Configuration for the Spring Boot Conventions package.
knative.serving	{}	Configuration for the Knative Serving package.
kpack	{}	Configuration for the Kpack package.
kpack_dependencies	{}	Configuration for the Kpack Dependencies package.
metrics_server	{}	Configuration for the Metrics Server package.
namespace_setup	{}	Configuration for the Namespace Setup package.
secretgen_controller	{}	Configuration for the Secretgen Controller package.
tekton.pipelines	{}	Configuration for the Tekton Pipelines package.

🛡️  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 inspired by:

• the App Toolkit package used in Tanzu Community Edition before its retirement;
• the OSS Stack example of Tanzu Application Platform.