typhoon

module
v0.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 24, 2025 License: Apache-2.0

README

typhoon

Go Report Card Taylor Swift Volkswagen License

An event bridge for applications and services build on top of NATS.io and Knative Eventing/Serving.

Open in GitHub Codespaces

Why

AWS EventBridge is a great service to bridge events between different sources and targets in your enterprise. However, it is not a cloud-native solution and it is not open-source.

It is the goal to create a cloud-native and open-source alternative that works on-premise and in the cloud and that has a focus on enterprise-readyness.

Design

  • Event mesh. The system is capable to route events from producers to consumers in hybrid cloud environemts.
  • Streaming. The system is capable to stream events from producers to consumers. That means it is capable of replaying events not only queueing them.
  • Event bridging. The system is capable to bridge events from different sources to different targets, also transforming them. Furthermore, this should use a declarative approach.
  • Scalability. The system is capable to scale horizontally and vertically.
  • Resilience. The system is capable to recover from failures.
  • Security. The system is capable to secure the communication between producers and consumers.
  • Open standards. The system is based on open standards like NATS.io and Knative Eventing.

Overview

Typhoon is built on top of NATS.io and Knative Eventing. It provides a control plane for managing event sources, triggers, and targets.

The accounting should be done via the Operator for NATS Accounting that we provide to configure NATS.io accounts and users.

Sources

Targets

Installation

Helm can be used to install Typhoon to your Kubernetes cluster.

helm repo add typhoon https://zeiss.github.io/typhoon
helm repo update
helm search repo typhoon

Install Typhoon to your cluster and wait for the deployment to finish.

helm install typhoon typhoon/typhoon --wait

Prerequisites

  • Kubernetes v1.28 or newer
  • Knative Eventing v1.16 or newer
  • Knative Serving v1.16 or newer
  • Helm 3.0 or newer

The prerequisites can be installed via the ZEISS Charts.

Installation

Typhoon depends on Knative Eventing and NATS.

Development

You can use minikube to run a local Kubernetes cluster.

sh scripts/setup-minikube.sh

Run the following Makefile target to deploy Typhoon to your local Kubernetes cluster.

make deploy

License

Apache 2.0

Directories

Path Synopsis
cmd
controller command
typhoon-webhook command
internal
tools/updater command
pkg
apis
Package apis provides primitives to interact with the openapi HTTP API.
Package apis provides primitives to interact with the openapi HTTP API.
apis/accounts
Package accounts provides primitives to interact with the openapi HTTP API.
Package accounts provides primitives to interact with the openapi HTTP API.
apis/common/v1alpha1
Package v1alpha1 contains interfaces and types common to all API groups.
Package v1alpha1 contains interfaces and types common to all API groups.
apis/extensions/v1alpha1
Package v1alpha1 contains API Schema definitions for the extensions/v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the extensions/v1alpha1 API group.
apis/flow/v1alpha1
Package v1alpha1 contains API Schema definitions for the flow/v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the flow/v1alpha1 API group.
apis/routing/v1alpha1
Package v1alpha1 contains API Schema definitions for the routing/v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the routing/v1alpha1 API group.
apis/sources/v1alpha1
Package v1alpha1 contains API Schema definitions for the sources/v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the sources/v1alpha1 API group.
apis/targets/v1alpha1
Package v1alpha1 contains API Schema definitions for the targets/v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the targets/v1alpha1 API group.
client/generated/clientset/internalclientset/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/generated/clientset/internalclientset/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/generated/clientset/internalclientset/typed/extensions/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/generated/clientset/internalclientset/typed/extensions/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/generated/clientset/internalclientset/typed/flow/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/generated/clientset/internalclientset/typed/flow/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/generated/clientset/internalclientset/typed/routing/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/generated/clientset/internalclientset/typed/routing/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/generated/clientset/internalclientset/typed/sources/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/generated/clientset/internalclientset/typed/sources/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/generated/clientset/internalclientset/typed/targets/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/generated/clientset/internalclientset/typed/targets/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
metrics
Package metrics contains interfaces for reporting OpenCensus stats to a metrics backend, such as Prometheus.
Package metrics contains interfaces for reporting OpenCensus stats to a metrics backend, such as Prometheus.
reconciler/event
Package event contains functions for generating Kubernetes API events.
Package event contains functions for generating Kubernetes API events.
reconciler/resource
Package resource contains helpers to generate Kubernetes API objects.
Package resource contains helpers to generate Kubernetes API objects.
reconciler/skip
Package skip allows a Context to carry the intention to skip parts of the code execution.
Package skip allows a Context to carry the intention to skip parts of the code execution.
routing/adapter/common/controller
Package controller contains helpers shared between controllers embedded in routing adapters.
Package controller contains helpers shared between controllers embedded in routing adapters.
routing/adapter/common/env
Package env allows propagating runtime configurations via the environment.
Package env allows propagating runtime configurations via the environment.
sources/adapter/common/controller
Package controller contains helpers shared between controllers embedded in source adapters.
Package controller contains helpers shared between controllers embedded in source adapters.
sources/adapter/common/env
Package env allows propagating runtime configurations via the environment.
Package env allows propagating runtime configurations via the environment.
sources/adapter/common/health
Package health contains helpers to enable HTTP health checking.
Package health contains helpers to enable HTTP health checking.
sources/secret
Package secret contains utilities for consuming secret values from various data sources.
Package secret contains utilities for consuming secret values from various data sources.
status
Package status contains helpers to observe the status of Kubernetes objects.
Package status contains helpers to observe the status of Kubernetes objects.
targets/adapter/cloudevents
Package cloudevents provides a CloudEvents library focused on target component requirements and on how responses should be composed.
Package cloudevents provides a CloudEvents library focused on target component requirements and on how responses should be composed.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL