External-DNS Webhook Redis Registry

A webhook registry implementation for External-DNS, with Redis support for storing ownership metadata.

Overview

This project implements a generic webhook registry for External-DNS that allows DNS record ownership information to be stored in a Redis backend rather than in TXT records.

Configuration

Prerequisite

You must install and configure Redis cluster/server.

This Redis must be accessible from this Registry Webhook provider.

Change the REDIS_xxxx environment variable accordingly.

OWNER_ID can be setted on external-dns side or Registry Webhook server, it's negociated by externel-dns.

Environment Variables

This environment variable must be set before run this Registry Webhook provider to change the default value. Idealy must be set in environment part the spec of the kubernetes pod that host this Registry Webhook provider.

Variable	Description	Default
REDIS_ADDR	Redis Address	localhost:6379
REDIS_PASSWORD	Redis Password	``
REDIS_DB	Redis Database	0
REDIS_KEY_PREFIX	Redis key prefix	external-dns:registry:
OWNER_ID	Owner ID	external-dns-webhook-registry
REGISTRY_LISTEN_URL	The listen url of the webhook	0.0.0.0:8888

Example of usage with External-DNS

external-dns \
--source=service \
--source=ingress \
--provider=aws \
--registry=webhook \
--registry-webhook-url=http://webhook-registry:8888 \
--owner-id=external-dns-webhook-registry \
--domain-filter=example.com

To Build

go build ./cmd/webhook-registry-server

API to implemente to be a External-DNS Registry WebHook