Buildpacks Catalog

A Carvel package providing a set of buildpacks, stacks, and builders to use with kpack, a Kubernetes-native implementation of Cloud Native Buildpacks to build application source code into OCI images.

This package relies on the Paketo Buildpacks implementation, which provide support for multiple languages and frameworks, including Java, Spring, GraalVM, Go, Python, NodeJs, and more.

🚀  Getting Started

Prerequisites

• Kubernetes 1.28+

• 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

Buildpacks Catalog requires the kpack package. 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-system --create-namespace

Installation without package repository

The recommended way of installing the buildpacks-catalog 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-system
kapp deploy -a buildpacks-catalog-package -n kadras-system -y \
  -f https://github.com/kadras-io/buildpacks-catalog/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/buildpacks-catalog/releases/latest/download/package.yml

Install the Buildpacks Catalog package:

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

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 buildpacks-catalog.packages.kadras.io -n kadras-system

Verify the installed packages and their status:

kctrl package installed list -n kadras-system

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to kpack, check out github.com/buildpacks-community/kpack.

🎯  Configuration

The Buildpacks Catalog package can be customized via a values.yml file.

kp_default_repository:
  name: ghcr.io/thomasvitale/kpack-build

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

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

Values

The Buildpacks Catalog package has the following configurable properties.

Configurable properties

Config	Default	Description
kp_default_repository.name	""	The default repository to use for builder images and dependencies. For example, GitHub Container Registry: ghcr.io/my-org/my-repo; GCR: gcr.io/my-project/my-repo; Harbor: myharbor.io/my-project/my-repo, Dockerhub: docker.io/my-username/my-repo.

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