From 73c6bf115c631d9b6c6b18765d64c4f2cbbf395e Mon Sep 17 00:00:00 2001 From: Bekir Dogan Date: Mon, 16 Dec 2019 22:05:43 +0000 Subject: [PATCH] chore(readme): minor improvements --- .ct_config.yaml | 2 ++ README.md | 22 +++++++++++++------ .../values.yaml | 2 +- 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/.ct_config.yaml b/.ct_config.yaml index 28b599f..408601d 100644 --- a/.ct_config.yaml +++ b/.ct_config.yaml @@ -1,3 +1,5 @@ chart-yaml-schema: .chart_schema.yaml lint-conf: .lintconf.yaml +# Version management is handled by semantic-release, so we are disabling the +# version check here. See .releaserc for more details. check-version-increment: false diff --git a/README.md b/README.md index 577d8c3..398bb27 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,14 @@ Helm (both v2 and v3) exporter which collects information directly from [Release [![Docker pulls](https://img.shields.io/docker/pulls/bergerx/tillerless-helm-release-exporter.svg)](https://hub.docker.com/r/bergerx/tillerless-helm-release-exporter/) [![Go Report Card](https://goreportcard.com/badge/github.com/bergerx/tillerless-helm-release-exporter)](https://goreportcard.com/report/github.com/bergerx/tillerless-helm-release-exporter) -Collects metrics for Releases: +Collects metrics for Releases which are: * deployed with Helm v2 with Tiller, -* in all Namespaces in the Kubernetes cluster indepdendently from where the Tiller is running, +* in any Namespaces in the Kubernetes cluster indepdendently from where the Tiller is running, * deployed with Helm v2 without in-cluster Tiller (e.g. [Tillerless Helm](https://github.com/rimusz/helm-tiller)), -* deployed Helm v3 +* deployed with Helm v3 -Doesn't collect metrics for Releases: -* deployed with `helm template ... | kubectl apply -f -` (e.g. [Istio Install with Helm, Option 1](https://istio.io/docs/setup/install/helm/#option-1-install-with-helm-via-helm-template)). Since these are not really a [Helm Release](https://helm.sh/docs/glossary/#release), they are not stored in either ConfigMap or a Secret backend. +Doesn't collect metrics for Releases which are: +* deployed with `helm template ... | kubectl apply -f -` (e.g. [Istio Install with Helm, Option 1](https://istio.io/docs/setup/install/helm/#option-1-install-with-helm-via-helm-template)). Since these are not really [Helm Release](https://helm.sh/docs/glossary/#release)s, they are not stored in either ConfigMap or a Secret backend. # Installing the Chart @@ -38,8 +38,16 @@ helm install bergerx-helm-exporter/tillerless-helm-release-exporter Install using helm 3: ```bash -helm3 repo add bergerx-helm-exporter https://bergerx.github.io/tillerless-helm-release-exporter -helm3 install helm-exporter bergerx-helm-exporter/tillerless-helm-release-exporter +helm repo add bergerx-helm-exporter https://bergerx.github.io/tillerless-helm-release-exporter +helm install helm-exporter bergerx-helm-exporter/tillerless-helm-release-exporter +``` + +Check [values.yaml](charts/tillerless-helm-release-exporter/values.yaml) for all helm parameters. + +For deploying into a cluster with prometheus operator: + +```bash +helm install bergerx-helm-exporter/tillerless-helm-release-exporter --set serviceMonitor.enabled=true ``` # Collected metrics diff --git a/charts/tillerless-helm-release-exporter/values.yaml b/charts/tillerless-helm-release-exporter/values.yaml index da83dd2..dc820dd 100644 --- a/charts/tillerless-helm-release-exporter/values.yaml +++ b/charts/tillerless-helm-release-exporter/values.yaml @@ -38,7 +38,7 @@ serviceMonitor: # namespace: monitoring ## Set how frequently Prometheus should scrape interval: 30s - ## Set timeout for scrape + ## Set timeout for scrape, it usually takes longer then 10s (default) in big clusters # scrapeTimeout: 10s ## Specify Metric Relabellings to add to the scrape endpoint # metricRelabelings: