Skip to content

Commit 8bccd14

Browse files
authored
Nice intro + ToC for README
1 parent ce48478 commit 8bccd14

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
[![Docker images](https://img.shields.io/docker/automated/flant/k8s-image-availability-exporter)](https://hub.docker.com/r/flant/k8s-image-availability-exporter)
44
[![Latest Docker image](https://img.shields.io/docker/v/flant/k8s-image-availability-exporter?sort=semver)](https://hub.docker.com/r/flant/k8s-image-availability-exporter)
55

6+
k8s-image-availability-exporter (or *k8s-iae* for short) is a Prometheus exporter that warns you proactively about images that are defined in Kubernetes objects (e.g., an `image` field in the Deployment) but are not available in the container registry (such as Docker Registry, etc.).
7+
8+
Receiving alerts when container images related to running Kubernetes controllers are missing helps you to solve the problem before it manifests itself. For more details on the reasons behind k8s-iae and how it works, please read [this article](https://medium.com/flant-com/prometheus-exporter-to-check-kubernetes-images-availability-26c306c44c08).
9+
10+
* [Deploying / Installing](#deploying) k8s-iae in your Kubernetes cluster
11+
* [Prometheus integration](#prometheus-integration) to scrape metrics
12+
* [Alerting](#alerting) based on k8s-iae metrics
13+
* [Configuration](#configuration)
14+
* [CLI options](#command-line-options)
15+
* [Metrics](#metrics) for Prometheus provided by k8s-iae
16+
* [Compatibility](#compatibility)
17+
618
## Deploying
719

820
After cloning this repo:
@@ -215,6 +227,6 @@ Each `<TYPE>` in the exporter's metrics name is replaced with the following valu
215227

216228
## Compatibility
217229

218-
`k8s-image-availability-exporter` is compatible with Kubernetes 1.15+ and Docker Registry V2 compliant container registries.
230+
k8s-image-availability-exporter is compatible with Kubernetes 1.15+ and Docker Registry V2 compliant container registries.
219231

220232
Since the exporter operates as a Deployment, it *does not* support container registries that should be accessed via authorization on a node.

0 commit comments

Comments
 (0)