Skip to content

Commit

Permalink
chore: update readme for unifi dns general availability (#30)
Browse files Browse the repository at this point in the history
* chore: Update README

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
onedr0p authored Jun 3, 2024
1 parent 9d6d1a7 commit 700503a
Showing 1 changed file with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# ExternalDNS Webhook Provider for UniFi

> [!CAUTION]
>
<div align="center">

[![GitHub Release](https://img.shields.io/github/v/release/kashalls/external-dns-unifi-webhook?style=for-the-badge)](https://github.com/kashalls/external-dns-unifi-webhook/releases)&nbsp;&nbsp;
[![Discord](https://img.shields.io/discord/673534664354430999?style=for-the-badge&label&logo=discord&logoColor=white&color=blue)](https://discord.gg/home-operations)

</div>

> [!WARNING]
> This software is experimental and **NOT FIT FOR PRODUCTION USE!**
>
> This webhook relies on Early Access features from Unifi, and may stop working at any time.
[ExternalDNS](https://github.com/kubernetes-sigs/external-dns) is a Kubernetes add-on for automatically managing DNS records for Kubernetes ingresses and services by using different DNS providers. This webhook allows to manage your UniFi domains inside your Kubernetes cluster.
[ExternalDNS](https://github.com/kubernetes-sigs/external-dns) 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
## 🎯 Requirements

- ExternalDNS >= v0.14.0
- UniFi OS >= 4.0.3 (currently Early Access only)
- UniFi Network >= 8.2.87 (currently Early Access only)
- UniFi OS >= 3.x
- UniFi Network >= 8.2.93

## Deployment
## Deployment

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

Expand All @@ -24,7 +28,7 @@
helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/
```

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

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

Expand Down Expand Up @@ -64,6 +68,8 @@
port: http-wh-metrics
initialDelaySeconds: 10
timeoutSeconds: 5
extraArgs:
- --ignore-ingress-tls-spec
policy: sync
sources: ["ingress", "service"]
txtOwnerId: default
Expand All @@ -76,3 +82,17 @@
```sh
helm install external-dns-unifi external-dns/external-dns -f external-dns-unifi-values yaml --version 1.14.3 -n external-dns
```

## ⭐ Stargazers

<div align="center">

[![Star History Chart](https://api.star-history.com/svg?repos=kashalls/external-dns-unifi-webhook&type=Date)](https://star-history.com/#kashalls/external-dns-unifi-webhook&Date)

</div>

---

## 🤝 Gratitude and Thanks

Thanks to all the people who donate their time to the [Home Operations](https://discord.gg/home-operations) Discord community.

0 comments on commit 700503a

Please sign in to comment.