ThomasVitale/package-for-knative-eventing

Kubernetes-native package for Knative Eventing, which provides tools for routing events from event producers to sinks, enabling developers to use an event-driven architecture with their applications.

Knative Eventing

Warning This package has been archived. For event-driven features based on CloudEvents, you can choose Dapr, supported out-of-the-box by Kadras, or bring your own Knative Eventing package.

A Carvel package for Knative Eventing, a cloud-native solution for routing events from event producers to sinks, enabling developers to use an event-driven architecture with their applications.

🚀  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

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 Knative Eventing 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 knative-eventing-package -n kadras-packages -y \
  -f https://github.com/kadras-io/package-for-knative-eventing/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-knative-eventing/releases/latest/download/package.yml

Install the Knative Eventing package:

kctrl package install -i knative-eventing \
  -p knative-eventing.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 knative-eventing.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 Knative Eventing, check out knative.dev.

🎯  Configuration

The Knative Eventing package can be customized via a values.yml file.

default_broker:
  enabled: true

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

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

Values

The Knative Eventing package has the following configurable properties.

Configurable properties

Config	Default	Description
default_broker.enabled	false	Enable the in-memory default broker.
default_broker.namespace	default	The namespace where to create the in-memory default broker.

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