ExternalDNS Webhook Provider for UniFi

Warning

This software is experimental and NOT FIT FOR PRODUCTION USE!

ExternalDNS is a Kubernetes add-on for automatically managing DNS records for Kubernetes ingresses and services by using different DNS providers. This webhook provider allows you to automate DNS records from your Kubernetes clusters into your UniFi Network controller.

🎯 Requirements

ExternalDNS >= v0.14.0
UniFi OS >= 3.x
UniFi Network >= 8.2.93

🚫 Limitations

Wildcard CNAME Records are not supported by UniFi.

⛵ Deployment

Create a local user with a password in your UniFi OS, this user only needs read/write access to the UniFi Network appliance.

Add the ExternalDNS Helm repository to your cluster.

helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/

Create a Kubernetes secret called external-dns-unifi-secret that holds username and password with their respected values from step 1.

Create the helm values file, for example external-dns-unifi-values.yaml:

fullnameOverride: external-dns-unifi
logLevel: &logLevel debug
provider:
  name: webhook
  webhook:
    image:
      repository: ghcr.io/kashalls/external-dns-unifi-webhook
      tag: main # replace with a versioned release tag
    env:
      - name: UNIFI_HOST
        value: https://192.168.1.1 # replace with the address to your UniFi router/controller
      - name: UNIFI_EXTERNAL_CONTROLLER
        value: false
      - name: UNIFI_USER
        valueFrom:
          secretKeyRef:
            name: external-dns-unifi-secret
            key: username
      - name: UNIFI_PASS
        valueFrom:
          secretKeyRef:
            name: external-dns-unifi-secret
            key: password
      - name: LOG_LEVEL
        value: *logLevel
    livenessProbe:
      httpGet:
        path: /healthz
        port: http-webhook
      initialDelaySeconds: 10
      timeoutSeconds: 5
    readinessProbe:
      httpGet:
        path: /readyz
        port: http-webhook
      initialDelaySeconds: 10
      timeoutSeconds: 5
extraArgs:
  - --ignore-ingress-tls-spec
policy: sync
sources: ["ingress", "service"]
txtOwnerId: default
txtPrefix: k8s.
domainFilters: ["example.com"] # replace with your domain

Install the Helm chart

helm install external-dns-unifi external-dns/external-dns -f external-dns-unifi-values.yaml --version 1.14.3 -n external-dns

Configuration

Unifi Controller Configuration

Environment Variable	Description	Default Value
`UNIFI_USER`	Username for the Unifi Controller (must be provided).	N/A
`UNIFI_SKIP_TLS_VERIFY`	Whether to skip TLS verification (true or false).	`true`
`UNIFI_SITE`	Unifi Site Identifier (used in multi-site installations)	`default`
`UNIFI_PASS`	Password for the Unifi Controller (must be provided).	N/A
`UNIFI_HOST`	Host of the Unifi Controller (must be provided).	N/A
`UNIFI_EXTERNAL_CONTROLLER`	Whether your controller is supported by official Ubiquiti hardware.	`false`
`LOG_LEVEL`	Change the verbosity of logs (used when making a bug report)	`info`

Server Configuration

Environment Variable	Description	Default Value
`SERVER_HOST`	The host address where the server listens.	`localhost`
`SERVER_PORT`	The port where the server listens.	`8888`
`SERVER_READ_TIMEOUT`	Duration the server waits before timing out on read operations.	N/A
`SERVER_WRITE_TIMEOUT`	Duration the server waits before timing out on write operations.	N/A
`DOMAIN_FILTER`	List of domains to include in the filter.	Empty
`EXCLUDE_DOMAIN_FILTER`	List of domains to exclude from filtering.	Empty
`REGEXP_DOMAIN_FILTER`	Regular expression for filtering domains.	Empty
`REGEXP_DOMAIN_FILTER_EXCLUSION`	Regular expression for excluding domains from the filter.	Empty

⭐ Stargazers

🤝 Gratitude and Thanks

Thanks to all the people who donate their time to the Home Operations Discord community.

aki263/external-dns-unifi-webhook