ingress-anubis

README

ingress-anubis

WIP ingress controller for anubis.

Disclaimer

This is NOT AT ALL production software and may never be. Likely bugs that will exist are: lack of upwards flowing reconciliation, perfect garbage collection, and the like. State management is hard 😄

Goals

• Wrap ingress-nginx with anubis in front of simple ingresses (one service).
• Only require ingressClassName to be set to anubis to enable, and summarily disable.

Limitations

In line with the above goals, the following limitations are currently present:

• When an ingress is deleted, garbage collection of the created resources is not done (WIP)
• An ingress with more than one target will only point to the first found target. This is because anubis only supports one target and this controller only manages one instance of anubis per ingress, currently.
• Resources created by the controller are not reconciled if outside changes occur unless the source ingress is updated, triggering the reconciliation loop.

Installing

Your cluster should already have the following installed:

• ingress-nginx

helm install --create-namespace --namespace ingress-anubis \
  ingress-anubis oci://ghcr.io/jaredallard/helm-charts/ingress-anubis

Configuration

For available configuration options, see the config key in values.yaml, or in config.go until further documentation is written.

Usage

Once installed, simply set ingressClassName to anubis and watch as your site is now behind it 🎉!

To configure various settings, see configuration.

Development

We use mise to manage the versions of our tools in usage as well as for task management. Check out the mise documentation to get started!

License

GPL-3.0