Improve Helm Chart (#557)

* Switch to 1.0.0-preview-6

* Add maintainer

* Introduce CI for helm charts

* Trigger on correct file

* Add License

* Provide basic README for chart

.azure-devops/helm-ci.yml

@@ -0,0 +1,28 @@
+name: $(Date:yyyyMMdd)$(Rev:.r)
+resources:
+- repo: self
+trigger:
+- master
+pr:
+  branches:
+    include:
+    - master
+  paths:
+    include:
+    - charts/*
+    - .azure-devops/helm-ci.yml
+stages:
+- stage: Helm
+  jobs:
+   - job: LintHelmChart
+     displayName: Lint promitor-agent-scraper chart
+     condition: succeeded()
+     pool:
+       vmImage: ubuntu-16.04
+     steps:
+     - task: HelmInstaller@0
+       inputs:
+        helmVersion: '2.9.1'
+     - powershell: |
+        mkdir output/
+        helm lint charts/promitor-agent-scraper/

charts/promitor-agent-scraper/Chart.yaml

@@ -4,4 +4,7 @@ description: A Helm chart to deploy Promitor, an Azure Monitor scraper for Prome
 name: promitor-agent-scraper
 icon: https://raw.githubusercontent.com/tomkerkhove/promitor/master/docs/media/logos/promitor.png
 home: https://github.com/tomkerkhove/promitor
-version: 0.1.0
+version: 0.2.0
+maintainers:
+  - name: Tom Kerkhove
+    url: https://github.com/tomkerkhove

charts/promitor-agent-scraper/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Tom Kerkhove
+
+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/promitor-agent-scraper/README.md

@@ -0,0 +1,41 @@
+# Promitor
+
+[Promitor](https://promitor.io/) is an Azure Monitor scraper for Prometheus providing a scraping endpoint for Prometheus that provides a configured subset of Azure Monitor metrics.
+
+## TL;DR
+
+```console
+$ helm repo add promitor https://promitor.azurecr.io/helm/v1/repo
+$ helm install promitor/promitor-agent-scraper
+```
+
+## Introduction
+
+This chart bootstraps a **Promitor Scraper Agent** deployment on a Kubernetes cluster using the Helm package manager.
+
+## Prerequisites
+
+None.
+
+## Installing the Chart
+
+To install the chart with the release name `promitor-agent-scraper`:
+
+```console
+$ helm install --name promitor-agent-scraper promitor/promitor-agent-scraper \
+               --set azureAuthentication.appId='<azure-ad-app-id>' \
+               --set azureAuthentication.appKey='<azure-ad-app-key>' \
+               --values /path/to/metric-declaration.yaml
+```
+
+The command deploys Prometheus on the Kubernetes cluster with the specified metrics declaration, for more information see [our documentation](https://promitor.io/deployment/#using-our-helm-chart).
+
+## Uninstalling the Chart
+
+To uninstall/delete the `promitor-agent-scraper` deployment:
+
+```console
+$ helm delete promitor-agent-scraper
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.

charts/promitor-agent-scraper/values.yaml

@@ -5,7 +5,7 @@ replicaCount: 1
 
 image:
   repository: tomkerkhove/promitor-agent-scraper
-  tag: 1.0.0-preview-5
+  tag: 1.0.0-preview-6
   pullPolicy: Always
 
 azureAuthentication:

docs/deployment/index.md

@@ -14,7 +14,7 @@ _For more information about advanced configuration, read our documentation [here
                            --env PROMITOR_AUTH_APPID='<azure-ad-app-id>' \
                            --env-file C:/Promitor/az-mon-auth.creds \
                            --volume C:/Promitor/metrics-declaration.yaml:/config/metrics-declaration.yaml \ 
-                           tomkerkhove/promitor-agent-scraper:1.0.0-preview-5
+                           tomkerkhove/promitor-agent-scraper:1.0.0-preview-6
 ```
 
 # Kubernetes
@@ -32,7 +32,7 @@ If all goes well you should be able to list all Promitor charts:
 ```shell
 ❯ helm search promitor/
 NAME                            CHART VERSION   APP VERSION      DESCRIPTION
-promitor/promitor-agent-scraper 0.1.0           1.0.0-preview-5  A Helm chart to deploy Promitor, an Azure Monitor scraper...
+promitor/promitor-agent-scraper 0.1.0           1.0.0-preview-6  A Helm chart to deploy Promitor, an Azure Monitor scraper...
 ```
 
 ## Using our Helm Chart

docs/index.md

@@ -19,7 +19,7 @@ docker run -d -p 8999:80 --name promitor-agent-scraper \
                          --env PROMITOR_AUTH_APPID='<azure-ad-app-id>'   \
                          --env-file C:/Promitor/az-mon-auth.creds \
                          --volume C:/Promitor/metrics-declaration.yaml:/config/metrics-declaration.yaml \ 
-                         tomkerkhove/promitor-agent-scraper:1.0.0-preview-5
+                         tomkerkhove/promitor-agent-scraper:1.0.0-preview-6
 ```
 
 Docker image is available on [Docker Hub](https://hub.docker.com/r/tomkerkhove/promitor-agent-scraper/).