benthos-captain

module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Jan 25, 2024 License: MIT

README

Benthos Captain

⚠️ This is a work in progress proof of concept ⚠️

Benthos Captain is a Kubernetes Operator to orchestrate Benthos pipelines.

Getting Started

Currently, there isn't a stable release of the operator. If you want to install the operator for development purposes, you can follow the developer guide.

The operator provides a custom resource for managing Benthos pipelines. Once you've got the operator running, you can deploy a Pipeline resource to test it out:

---
apiVersion: captain.benthos.dev/v1alpha1
kind: Pipeline
metadata:
  name: pipeline-sample
spec:
  replicas: 2
  config:
    input:
      generate:
        mapping: root = "woof"
        interval: 5s
        count: 0

    pipeline:
      processors:
        - mapping: root = content().uppercase()

    output:
      stdout: {}

Once the resource is deployed, you can monitor the state of the resoure:

kubectl get pipelines

NAME                     READY   PHASE     REPLICAS   AVAILABLE   AGE
pipeline-sample   true    Running   2          2           62s

Directories

Path Synopsis
api
v1alpha1
Package v1alpha1 contains API Schema definitions for the captain v1alpha1 API group +kubebuilder:object:generate=true +groupName=captain.benthos.dev
Package v1alpha1 contains API Schema definitions for the captain v1alpha1 API group +kubebuilder:object:generate=true +groupName=captain.benthos.dev
internal

Jump to

Keyboard shortcuts

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