1
0
mirror of https://github.com/ribbybibby/ssl_exporter.git synced 2024-11-27 08:31:02 +02:00

Update README.md

- Remove TOC (Github provides one)
- Add quicker links at the top of the doc
This commit is contained in:
Rob Best 2021-05-05 22:48:04 +01:00
parent 5265251777
commit d5cbd64f94

View File

@ -1,35 +1,14 @@
# SSL Certificate Exporter
Exports metrics for certificates collected from TCP probes, local files or
Kubernetes secrets. The metrics are labelled with fields from the certificate,
which allows for informational dashboards and flexible alert routing.
Exports metrics for certificates collected from various sources:
- [TCP probes](#tcp)
- [HTTPS probes](#https)
- [PEM files](#file)
- [Kubernetes secrets](#kubernetes)
- [Kubeconfig files](#kubeconfig)
## Table of Contents
- [SSL Certificate Exporter](#ssl-certificate-exporter)
- [Table of Contents](#table-of-contents)
- [Building](#building)
- [Docker](#docker)
- [Release process](#release-process)
- [Usage](#usage)
- [Metrics](#metrics)
- [Configuration](#configuration)
- [TCP](#tcp)
- [HTTPS](#https)
- [File](#file)
- [Kubernetes](#kubernetes)
- [Kubeconfig](#kubeconfig)
- [Configuration file](#configuration-file)
- [<module>](#module)
- [<tls_config>](#tls_config)
- [<https_probe>](#https_probe)
- [<tcp_probe>](#tcp_probe)
- [<kubernetes_probe>](#kubernetes_probe)
- [Example Queries](#example-queries)
- [Peer Certificates vs Verified Chain Certificates](#peer-certificates-vs-verified-chain-certificates)
- [Grafana](#grafana)
Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
The metrics are labelled with fields from the certificate, which allows for
informational dashboards and flexible alert routing.
## Building