Merge pull request #28 from syseleven/incorporate-helm-chart

Incorporate helm chart

README.md

@@ -85,3 +85,4 @@ docker pull syseleven/syseleven-exporter:<TAG>
 ## Credits
 
 - [Staffbase](https://github.com/Staffbase/) - Original Author
+- [vfm](https://github.com/vfm) - Original Author of the Helm chart

charts/syseleven-exporter-chart/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/syseleven-exporter-chart/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: syseleven-exporter
+description: A Helm Chart to deploy the SysEleven Exporter in Kubernetes.
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.4.0
+
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+appVersion: 1.1.1

charts/syseleven-exporter-chart/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 vfm Konzept GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

charts/syseleven-exporter-chart/README.md

@@ -0,0 +1,59 @@
+# SysEleven Exporter Helm-Chart
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![Release Charts](https://github.com/vfm/syseleven-exporter-chart/workflows/Release%20Charts/badge.svg?branch=main)
+![Badge](https://img.shields.io/badge/made%20with%20%E2%9D%A4%20by-vfm-002C5B)
+
+
+A Helm Chart to deploy the [SysEleven Exporter](https://github.com/syseleven/syseleven-exporter) in Kubernetes.
+
+## Usage
+
+Add this Github-Repository as Helm Repository.
+
+```bash
+helm repo add syseleven-exporter https://syseleven.github.io/syseleven-exporter-chart
+helm repo update
+```
+
+Now you can install the Chart.
+
+```bash
+helm install syseleven-exporter/syseleven-exporter --generate-name
+```
+
+Add your Openstack credentials to allow *read-only* access to the API-Endpoint `https://api.cloud.syseleven.net:5001`
+
+```bash
+openstack.username
+openstack.password
+openstack.projectId
+```
+
+### Prometheus
+
+If you want an [Prometheus ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#servicemonitor) you can use the `prometheus.serviceMonitor.enabled` flag, which is false by default. The default `serviceMonitor.interval` is 10 minutes, since the API is only polled once per hour by the exporter pod.
+
+```bash
+prometheus.serviceMonitor.enabled
+prometheus.serviceMonitor.interval
+```
+
+The default Namespace for the ServiceMonitor is the Helm Release Namespace.
+If you need the ServiceMonitor in an other namespace, you have to specify the `prometheus.serviceMonitor.namespace`.
+
+```bash
+prometheus.serviceMonitor.namespace
+```
+
+#### Rules
+
+To use a default set of Prometheus Alertrules, you have to enable the `prometheus.rules.enabled` flag. Simliar to the ServiceMonitor, you can adjust the default Namespace with `prometheus.rules.namespace`.
+
+To see the full list of all options look at [Values.yaml](charts/syseleven-exporter-chart/values.yaml).
+
+
+#### Dashboard
+
+To use a default Grafana Dashboard, you have to enable the `prometheus.dashboards.enabled` flag. Simliar to the Rules, you can adjust the Namespace with `prometheus.dashboards.namespace`.
+
+To see the full list of all options look at [Values.yaml](charts/syseleven-exporter-chart/values.yaml).