Skip to content

Commit

Permalink
chore(readme): minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
bergerx committed Dec 17, 2019
1 parent 1acc11a commit 73c6bf1
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .ct_config.yaml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/tillerless-helm-release-exporter/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 73c6bf1

Please sign in to comment.