Merge pull request #21 from jlpedrosa/kube_docs

Add documentation for kubernetes

documentation/docs/install/installmethod.md

@@ -5,7 +5,7 @@ title: Install Method
 
 ## Chosing an Install Method
 
-There are two main methods to install the Unpollor 'suite' (Unpoller and accociated programs)
+There are three main methods to install the Unpollor 'suite' (Unpoller and accociated programs)
 
 ### Docker Image
 This is the recommended way to install and the best option for new users.
@@ -37,6 +37,19 @@ Install each of the components individually
 - Harder to update
 - Requires manual configuration
 
+### Kubernetes
+Run Unpoller in a k8s cluster through the usage of the helm chart. 
+
+#### Advantages of Kubernetes
+- Automatic updates when combined with flux
+- Integration with prometheus operator and grafana operator
+- Pre packed solution
+
+#### Disadvantages of Kubernetes
+- Requires a kubernetes cluster + all associated complexities
+- Requires kubernetes knowledge to troubleshoot
+- Higher complexity
+
 ### Device Specific
 Some devices have specific install methods. If you have one of those devices the instructions for that device take precedence.
 

documentation/docs/install/kubernetes.md

@@ -0,0 +1,70 @@
+---
+id: linux
+title: Linux
+---
+
+This page assumes that you have decided to install UniFi Poller on to an kubernetes cluster.
+Installing a cluster is not in the scope of this guide.
+
+## First
+All the possible configuration can be found on the [main page](https://github.com/unpoller/helm-chart) hosting the chart 
+This chart uses CRDs from the prometheus operator, which can be installed with their [community
+repository](https://github.com/prometheus-community/helm-charts)
+
+---
+## Installation
+The two main ways to install the helm chart is through the CLI or through a gitops tools as flux.
+
+```shell
+helm repo add unpoller https://unpoller.github.io/helm-chart
+helm repo update
+```
+
+If you are using flux, you can rely on their CR:
+```yaml
+apiVersion: source.toolkit.fluxcd.io/v1
+kind: HelmRepository
+metadata:
+  name: unpoller
+  namespace: flux-system
+spec:
+  interval: 10m
+  url: https://unpoller.github.io/helm-chart
+```
+
+Once the repository has been configured, you can proceed to install the chart.
+```bash
+helm install -f myvalues.yaml your-release-name unpoller/unpoller
+```
+
+```yaml
+apiVersion: helm.toolkit.fluxcd.io/v2
+kind: HelmRelease
+metadata:
+  name: unpoller
+  namespace: flux-system
+spec:
+  interval: 5m
+  targetNamespace: unifi
+  chart:
+    spec:
+      chart: unpoller
+      version: 2.11.2-Chart6
+      sourceRef:
+        kind: HelmRepository
+        name: unpoller
+        namespace: flux-system
+      interval: 10m
+  values:
+    allPossibleValues:
+```
+
+## Maintenance
+When a new release of the chart (or unpoller is generated) you can update unpoller
+by running helm
+
+```bash
+helm upgrade --reuse-values yourreleasename ./redis
+```
+
+In case of flux/argocd, just updating the version of the chart, should be enough.

documentation/docs/install/overview.md

@@ -55,6 +55,7 @@ Platform specific install docs:
 - [MacOS](macos)
 - [Linux](linux)
 - [FreeBSD](freebsd)
+- [Kubernetes](kubernetes)
 
 </details>