From 3d1b4c67d53a5580ac706c72bf4bfc3dfacfd303 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 16 May 2019 20:06:21 +0200 Subject: [PATCH] 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 | 28 ++++++++++++++++ charts/promitor-agent-scraper/Chart.yaml | 5 ++- charts/promitor-agent-scraper/LICENSE | 21 ++++++++++++ charts/promitor-agent-scraper/README.md | 41 +++++++++++++++++++++++ charts/promitor-agent-scraper/values.yaml | 2 +- docs/deployment/index.md | 4 +-- docs/index.md | 2 +- 7 files changed, 98 insertions(+), 5 deletions(-) create mode 100644 .azure-devops/helm-ci.yml create mode 100644 charts/promitor-agent-scraper/LICENSE create mode 100644 charts/promitor-agent-scraper/README.md diff --git a/.azure-devops/helm-ci.yml b/.azure-devops/helm-ci.yml new file mode 100644 index 000000000..14fac358f --- /dev/null +++ b/.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/ \ No newline at end of file diff --git a/charts/promitor-agent-scraper/Chart.yaml b/charts/promitor-agent-scraper/Chart.yaml index 6b26ea38c..f230c07b8 100644 --- a/charts/promitor-agent-scraper/Chart.yaml +++ b/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 \ No newline at end of file diff --git a/charts/promitor-agent-scraper/LICENSE b/charts/promitor-agent-scraper/LICENSE new file mode 100644 index 000000000..782e6b8ab --- /dev/null +++ b/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. diff --git a/charts/promitor-agent-scraper/README.md b/charts/promitor-agent-scraper/README.md new file mode 100644 index 000000000..2a11db318 --- /dev/null +++ b/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='' \ + --set azureAuthentication.appKey='' \ + --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. \ No newline at end of file diff --git a/charts/promitor-agent-scraper/values.yaml b/charts/promitor-agent-scraper/values.yaml index 2814a5ebc..8581ad29c 100644 --- a/charts/promitor-agent-scraper/values.yaml +++ b/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: diff --git a/docs/deployment/index.md b/docs/deployment/index.md index 645a632b2..f2ee16afd 100644 --- a/docs/deployment/index.md +++ b/docs/deployment/index.md @@ -14,7 +14,7 @@ _For more information about advanced configuration, read our documentation [here --env PROMITOR_AUTH_APPID='' \ --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 diff --git a/docs/index.md b/docs/index.md index c9cf8eb55..0d1f14a67 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,7 +19,7 @@ docker run -d -p 8999:80 --name promitor-agent-scraper \ --env PROMITOR_AUTH_APPID='' \ --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/).