Kube mDNS registers hostnames with Avahi based on annotations given to an
Ingress. This allows Ingresses to have unique .local hostnames assigned to
them, which helps with reverse proxying.
This project is based on docker-mdns, which provides the same functionality
for Docker environments.
The MSRV for this project is currently 1.85.1.
Kube mDNS does not take any command line arguments, but will take logging
configuration from the environment via the RUST_LOG environment variable.
Examples for setting this can be found in the tracing_subscriber
EnvFilter documentation.
The main Kube mDNS configuration is done through annotations on Ingress
objects in Kubernetes.
| Label | Description |
|---|---|
phyber.github.io/kube-mdns.hostnames |
Hostnames to add for this Ingress |
The phyber.github.io/kube-mdns.hostnames annotation can take a list of
whitespace separated hostnames if you want multiple hostnames for a single
Ingress.
The IP addresses that the hostnames point to will be taken from the IP address
of the LoadBalancer that ends up attached to the Ingress object.
---
apiVersion: "networking.k8s.io/v1"
kind: "Ingress"
metadata:
annotations:
nginx.ingress.kubernetes.io/backend-protocol: "HTTP"
nginx.ingress.kubernetes.io/ssl-redirect: "true"
phyber.github.io/kube-mdns.hostnames: "example.local"
spec:
ingressClassName: "nginx"
rules:
- host: "example.local"
http:
paths:
- path: "/"
pathType: "ImplementationSpecific"
backend:
service:
name: "example"
port:
name: "example"These are mostly issues just because they're untested with my current setup.
- This is currently developed in a Kubernetes "cluster" with just a single node
- With >1 node in a cluster, how do we decide which node to announce mDNS
from? Do we need to decide at all?
- RFC-6762 section 6.6 suggests it should be fine to announce all
configured names from each node
- Specifically the second case given, where duplicate mDNS responses contain the same rrtype, rrclass, and rdata
- RFC-6762 section 6.6 suggests it should be fine to announce all
configured names from each node
- The container image is not currently a multi-arch image, making use of the Helm charts a little more difficult as users must manually specify which image tag they'd like to use
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.