Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Commit e5c9080

Browse files
committed
docs: update README.md
Also cleanup old docs before the repository is archived. Signed-off-by: Shane Utt <shaneutt@linux.com>
1 parent 284bdc9 commit e5c9080

File tree

2 files changed

+16
-109
lines changed

2 files changed

+16
-109
lines changed

README.md

Lines changed: 16 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -21,102 +21,22 @@ A [layer 4][osi] load-balancer for [Kubernetes] written in [Rust] using
2121

2222
## Current Status
2323

24-
We're currently focused on getting some of the core functionality in place. The
25-
immediate goals are to add:
26-
27-
- [ ] support for the [Kubernetes Service API] ([upcoming])
28-
- [ ] support for [Gateway], [GatewayClass], [UDPRoute], [TCPRoute] (in progress, partially complete)
29-
30-
After these goals are achieved, further goals may be decided.
31-
32-
[Kubernetes Service API]:https://kubernetes.io/docs/concepts/services-networking/service/
33-
[upcoming]:https://github.com/kubernetes-sigs/blixt/issues/279
34-
[Gateway]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.Gateway
35-
[GatewayClass]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.GatewayClass
36-
[UDPRoute]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.UDPRoute
37-
[TCPRoute]:https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.TCPRoute
38-
39-
## Usage
40-
41-
> **Note**: We don't host container images for this project. You **must** build,
42-
> load (or host) the images yourself.
43-
44-
> **Warning**: We currently only support [Kubernetes In Docker (KIND)] clusters.
45-
46-
Deploy the [Gateway API] [CRDs]:
47-
48-
```console
49-
kubectl apply -k https://github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=v1.2.1
50-
```
51-
52-
Build container images:
53-
54-
```console
55-
make build.all.images TAG=latest
56-
```
57-
58-
Load images into your Kind cluster:
59-
60-
```console
61-
make load.all.images TAG=latest
62-
```
63-
64-
Deploy Blixt:
65-
66-
```console
67-
kubectl apply -k config/default
68-
```
69-
70-
At this point you should see the `controlplane` and `dataplane` pods running
71-
in the `blixt-system` namespace:
72-
73-
```console
74-
$ kubectl -n blixt-system get pods
75-
NAME READY STATUS RESTARTS AGE
76-
blixt-controlplane-cdccc685b-9dxj2 2/2 Running 0 83s
77-
blixt-dataplane-brsl9 1/1 Running 0 83s
78-
```
79-
80-
> **Note**: Check the `config/samples` directory for `Gateway` and `*Route`
81-
> examples you can now deploy.
82-
83-
[Kubernetes In Docker (KIND)]:https://github.com/kubernetes-sigs/kind
84-
[Gateway API]:https://github.com/kubernetes-sigs/gateway-api
85-
[CRDs]:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
86-
87-
## Development
88-
89-
Development is generally done by making your changes locally, building images
90-
with those changes locally and then deploying those images to a local `kind`
91-
cluster (see the usage section above to get an environment set up).
92-
93-
You can build the data-plane:
94-
95-
```console
96-
make build.image.dataplane
97-
```
98-
99-
Then load it into the cluster and perform a rollout on the `Daemonset`:
100-
101-
```console
102-
make load.image.dataplane
103-
```
104-
105-
The same can be done for the control-plane:
106-
107-
```console
108-
make build.image.controlplane
109-
make load.image.controlplane
110-
```
111-
112-
## Community
113-
114-
Reach by creating [issues] or [discussions]. We also have the `#blixt` channel
115-
on [Kubernetes Slack].
116-
117-
[issues]:https://github.com/kubernetes-sigs/blixt/issues
118-
[discussions]:https://github.com/kubernetes-sigs/blixt/discussions
119-
[Kubernetes Slack]:https://kubernetes.slack.com
24+
**This project is now concluded**. Blixt started in the early 2020's at a time
25+
when eBPF technology was a huge buzz for Kubernetes, and members of the
26+
Kubernetes SIG Network community wanted to experiment with and explore the
27+
technology on K8s. Over time we suggested some specific goals we _could_ have
28+
for the project, but those never really stuck. The project operated primarily as
29+
an experimental sandbox, and a "just for fun" project.
30+
31+
As such if you're reading this, we're glad if it helps you and provides some
32+
interesting insights, but do note that much of what you'll find in this
33+
repository is largely incomplete exploratory attempts which can only be used in
34+
a limited environment, so just keep that in mind.
35+
36+
We had a lot of fun working on this while it was active. It was great to create
37+
the first official Kubernetes project in Rust, and experimenting with eBPF in
38+
its nascence was exciting. All things must come to an end however. Thank you to
39+
everyone who contributed to the project, good times!
12040

12141
# License
12242

SECURITY_CONTACTS

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)