.NET Kubernetes Ingress Controller

I'm archiving this repo. I'm going to contribute to the larger https://github.com/microsoft/reverse-proxy repo that this is based on now that initial Kubernetes support has been added.

This project takes a .NET 5 (formerly .NET Core)-based reverse proxy and combines it with a Kubernetes client to form a highly scalable Ingress Controller.

It is based on the following technology:

• ASP.NET 5.0
• Microsoft's Reverse Proxy
• Kubernetes API Client for .NET

This is still very much a new project... still lots of work ahead!

Why .NET?

There are plenty of Ingress Controllers out there but this is (we believe) the first one that uses .NET. Even the Azure AKS Gateway is written in Go.

Given the massive improvements to performance in .NET, in particular, the Kestrel web server, it seems like a perfectly valid option in the Ingress Controller space. For any skeptics out there, you can check out this independent benchmark: https://www.techempower.com/benchmarks/#section=data-r20&hw=ph&test=plaintext

So why C# and .NET?

• Why not, .NET?
• It's super fast!
• It's extensible using a framework many developers know. Have you ever tried to customize Nginx using Perl, Lua or Javascript?

Getting Started

Currently, this project is only available in source code form, so you will need to compile/build yourself.

Ingress Format

An ingress resource would be formatted something like this. Note the ingressClassName field in the spec.

---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: test-ingress-new
  namespace: echoserver
  labels:
    app.kubernetes.io/name: test-ingress-new
    app.kubernetes.io/instance: test-ingress-new
spec:
  ingressClassName: "dotnet"
  rules:
    - host: foo-new.127.0.0.1.nip.io
      http:
        paths:
          - path: /
            pathType: Prefix
            backend:
              service:
                name: echoserver
                port:
                  number: 80

Prerequisties

• .NET Core SDK 5.0
• An editor (VS Code, or Visual Studio 2019+)
• Docker Desktop (minikube may work but this hasn't been tested)
• Kubernetes (v1.18 or higher due to use of the use of the ingressClassName field)

Dev Cycle

1. Make changes
2. Run dotnet publish ./src/Bevo.KubernetesIngressDotNet/Bevo.KubernetesIngressDotNet.csproj -c release
3. Run skaffold run

Note that you can simply debug on your host machine, and the Kubernetes client will automatically connect to your local cluster and generate the ingress routes... not that they will work (because the requests will be sent to the cluster addresses).

Code Linting

This repo uses the dotnet-format linter.

You can install the tool using the following command.

dotnet tool install -g dotnet-format

To check (without modifying) the code, run the following command.

dotnet format --check

To fix any style issues in the code, run the following command.

dotnet format