Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kubernetes-sigs/blixt

Layer 4 Kubernetes load-balancer
https://github.com/kubernetes-sigs/blixt

ebpf gateway golang kubernetes operator rust

Last synced: 14 days ago
JSON representation

Layer 4 Kubernetes load-balancer

Awesome Lists containing this project

README 

        
![blixt](https://github.com/kubernetes-sigs/blixt/assets/5332524/387ce94a-88fd-43a9-bde9-73fb9005564d)



> **Warning**: The `main` branch is under heavy development, and is not fully

> functional yet as we are [rewriting our control-plane][rewrite]. if you're

> interested in using or testing Blixt, use the `archive/golang-control-plane`

> branch temporarily.



> **Warning**: Experimental. There is no intention to ever make this viable for production. **DO NOT USE IN PRODUCTION**.



[rewrite]:https://github.com/kubernetes-sigs/blixt/milestone/8



# Blixt



An experimental [layer 4][osi] load-balancer for [Kubernetes] written in [Rust]

and employing [Gateway API] for the control-plane and [eBPF]/[Aya] for the

data-plane.



This project is a sandbox for experimentation and learning. This repo is mainly

meant for those interested in experimenting. This project **intentionally does

not have end-users** and is a safe place to learn, break stuff and have fun!



> **Note**: The word "blixt" means "lightning" in Swedish.



[osi]:https://en.wikipedia.org/wiki/OSI_model

[Kubernetes]:https://kubernetes.io

[Rust]:https://rust-lang.org

[Gateway API]:https://gateway-api.sigs.k8s.io

[eBPF]:https://www.tigera.io/learn/guides/ebpf/ebpf-xdp/

[Aya]:https://aya-rs.dev



## Current Status



Current project goals are the following:



- [ ] support the [Kubernetes Service API][svc] (upcoming)

- [ ] support [Gateway]/[GatewayClass] + [UDPRoute] / [TCPRoute] (in progress, partially complete)



After these goals are achieved, further goals may be decided.



[svc]:https://kubernetes.io/docs/concepts/services-networking/service/

[Gateway]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.Gateway

[GatewayClass]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.GatewayClass

[UDPRoute]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.UDPRoute

[TCPRoute]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.TCPRoute



## Usage



> **Warning**: Currently our container images are under migration from a private

> repository. At this moment, you **must** build and load images yourself locally.



> **Warning**: Currently usage is only possible on [Kubernetes In Docker

> (KIND)][kind] clusters. You can generate a new development cluster for testing

> with `make build.cluster`.



Deploy the [Gateway API] [CRDs]:



```console

kubectl apply -k https://github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=v0.8.1

```



Build container images:



```console

make build.all.images TAG=latest

```



Load images into your Kind cluster:



```console

make load.all.images TAG=latest

```



Deploy Blixt:



```console

kubectl apply -k config/default

```



At this point you should see the `controlplane` and `dataplane` pods running

in the `blixt-system` namespace:



```console

$ kubectl -n blixt-system get pods

NAME                                 READY   STATUS    RESTARTS   AGE

blixt-controlplane-cdccc685b-9dxj2   2/2     Running   0          83s

blixt-dataplane-brsl9                1/1     Running   0          83s

```



> **Note**: Check the `config/samples` directory for `Gateway` and `*Route`

> examples you can now deploy.



[kind]:https://github.com/kubernetes-sigs/kind

[Gateway API]:https://github.com/kubernetes-sigs/gateway-api

[CRDs]:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/



## Development



Development is generally done by making your changes locally, building images

with those changes locally and then deploying those images to a local `kind`

cluster (see the usage section above to get an environment set up).



You can build the data-plane:



```console

make build.image.dataplane

```



Then load it into the cluster and perform a rollout on the `Daemonset`:



```console

make load.image.dataplane

```



The same can be done for the control-plane:



```console

make build.image.controlplane

make load.image.controlplane

```



> **Warning**: The integration tests are currently written in Golang, which is

> a little awkward, but it is a temporary situation as we rewrite them in Rust.

> Run `make test.integration.deprecated` after deploying your custom images to

> the cluster.



> **Note**: We use [Cargo workspaces] to manage the various crates spread across

> the Rust parts of the repo. However, there is one exception. The

> `dataplane/eBPF` crate must be kept as a standalone because it needs to

> re-implement the `panic` handler. All new crates should be added to the

> workspace, if possible.



[Cargo Workspaces]:https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html



## Community



You can reach out to the community by creating [issues] or [discussions]. You

can also reach out on [Kubernetes Slack] on the `#blixt` channel. There is also

an `#ebpf` channel on Kubernetes Slack for general eBPF related help!



[issues]:https://github.com/kubernetes-sigs/blixt/issues

[discussions]:https://github.com/kubernetes-sigs/blixt/discussions

[Kubernetes Slack]:https://kubernetes.slack.com



# License



The Blixt control-plane components are licensed under [Apache License, Version

2.0][apache2], which is everything _outside_ of the `dataplane/` directory. The

data-plane components are dual-licensed under the [General Public License,

Version 2.0 (only)][gplv2] and the [2-Clause BSD License][bsd2c] (at your

option) including everything _inside_ the `dataplane/` directory.



[apache2]:https://github.com/kubernetes-sigs/blixt/blob/main/LICENSE

[gplv2]:https://github.com/kubernetes-sigs/blixt/blob/main/dataplane/LICENSE.GPL-2.0

[bsd2c]:https://github.com/kubernetes-sigs/blixt/blob/main/dataplane/LICENSE.BSD-2-Clause