From e0639a8974b12e30f6320f8e17886fef0dbce19b Mon Sep 17 00:00:00 2001
From: Tobias Trabelsi <lerentis@uploadfilter24.eu>
Date: Fri, 20 Oct 2023 21:57:19 +0200
Subject: [PATCH] added docs

---
 README.md                            | 37 ++++++++++++++++++++++++++++
 chart/metallb-ip-floater/values.yaml |  1 -
 2 files changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bcc4a9f..c209c39 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
 # metallb-ip-floater
 
+[![status-badge](https://woodpecker.uploadfilter24.eu/api/badges/7/status.svg)](https://woodpecker.uploadfilter24.eu/repos/7)
+
+Checks metallb speaker pods if they announce some services. If they do, assign a given floating ip on hetzner to the k8s node that announces.
+
+## Getting Started
+
+The deployment will use helm and the chart in `chart/metallb-ip-floater`.  
+You will need a hcloud api token and the name of your floating IP. Also your k8s nodes should be labeled in hcloud.  
+Expose these information to the floater as described in this example:
+
+```yaml
+env:
+  - name: METALLB_IP_FLOATER_LABELSELECTOR
+    value: "kops.k8s.io/instance-role=Node"
+  - name: METALLB_IP_FLOATER_HCLOUD_TOKEN
+    value: "define_it"
+  - name: METALLB_IP_FLOATER_FLOATING_IP_NAME
+    value: "define_it"
+```
+
+you can also create a secret manually with these information and reference the existing secret like this in the `values.yaml`:
+
+```yaml
+externalConfigSecret:
+  enabled: true
+  name: "my-existing-secret"
+```
+
+Now you are able to deploy:
+
+```bash
+kubectl create namespace metallb-ip-floater
+cd chart/metallb-ip-floater
+helm upgrade --install -f values.yaml -n metallb-ip-floater metallb-ip-floater ./
+```
+
+> Made with ♡ by the folkes at uploadfilter24.eu :)
diff --git a/chart/metallb-ip-floater/values.yaml b/chart/metallb-ip-floater/values.yaml
index 385de04..cc31165 100644
--- a/chart/metallb-ip-floater/values.yaml
+++ b/chart/metallb-ip-floater/values.yaml
@@ -48,7 +48,6 @@ env:
 
 externalConfigSecret:
   enabled: false
-
   name: ""
 
 resources: {}