quilkin-controller

README

quilkin-controller

simple kubernetes control plane for quilkin udp proxy that uses pod annotations to add endpoints and sidecar containers where specified.

⚠ USAGE WARNING ⚠ This project is not production ready use at own risk. Breaking changes may be introduced at a moments notice. it is also lacking any meaningful tests at this point in time.

Usage

To configure the client pods add the following annotations to the pod annotation spec in your deployment. see the examples folder for deployments you can use to test it.

• nfowler.dev/quilkin.receiver: "proxy:4000": Indicates the pod wants to receive data from the node name provided at the port specified.
• nfowler.dev/quilkin.sender: "proxy": Injects a quilkin proxy with a name corresponding to the value provided.

Installation

The supported method of installation for this controller is via Helm. The helm chart is hosted as part of this repo and can be added via:

helm repo add quilkin-controller https://nfowl.github.io/quilkin-controller/