diff --git a/README.md b/README.md index 9dd80bc..f60eafc 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ # ExternalDNS Webhook Provider for UniFi -> [!CAUTION] -> +
+ +[![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)   +[![Discord](https://img.shields.io/discord/673534664354430999?style=for-the-badge&label&logo=discord&logoColor=white&color=blue)](https://discord.gg/home-operations) + +
+ +> [!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 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. @@ -24,7 +27,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 that holds `UNIFI_USER` and `UNIFI_PASS` with their respected values. 4. Create the helm values file, for example `external-dns-unifi-values.yaml`: @@ -76,3 +79,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 + +
+ +[![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) + +
+ +--- + +## 🤝 Gratitude and Thanks + +Thanks to all the people who donate their time to the [Home Operations](https://discord.gg/home-operations) Discord community.