Skip to content

Commit b870186

Browse files
committed
doc: improved docs
1 parent d2dc3be commit b870186

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,28 @@ Sentinel monitors Kubernetes workloads across labeled namespaces and tracks whic
1010

1111
<br>
1212

13+
- [Sentinel](#sentinel)
14+
- [Why Sentinel?](#why-sentinel)
15+
- [Quick Start](#quick-start)
16+
- [Prerequisites](#prerequisites)
17+
- [Installation](#installation)
18+
- [Metrics Exposed](#metrics-exposed)
19+
- [`sentinel_container_image_info`](#sentinel_container_image_info)
20+
- [`sentinel_image_changes_total`](#sentinel_image_changes_total)
21+
- [Dynamic Label Enrichment](#dynamic-label-enrichment)
22+
- [⚙️ Configuration](#️-configuration)
23+
- [1. Config file (`/etc/sentinel/sentinel.yaml`)](#1-config-file-etcsentinelsentinelyaml)
24+
- [2. Environment variables](#2-environment-variables)
25+
- [3. CLI flags](#3-cli-flags)
26+
- [Configuration Reference](#configuration-reference)
27+
- [📊 Grafana Dashboard](#-grafana-dashboard)
28+
- [Local Development](#local-development)
29+
- [Build and Run Locally](#build-and-run-locally)
30+
- [Test with KIND](#test-with-kind)
31+
- [🌟 Project Status](#-project-status)
32+
33+
<br>
34+
1335
## Why Sentinel?
1436

1537
Gain real-time visibility into your cluster's container image landscape. Perfect for:
@@ -218,9 +240,9 @@ A pre-built Grafana dashboard is included in [`dashboard/grafana.json`](dashboar
218240
- **Registry distribution** – Donut chart showing image count by registry
219241
- **Change tracking log** – Table of all detected image changes with old → new tags
220242

243+
![example](./images/dashboard.png)
221244

222-
223-
---
245+
<br>
224246

225247
## Local Development
226248

0 commit comments

Comments
 (0)