Skip to content

Commit 5d574a7

Browse files
authored
enhance readme (#892)
add what, why and how it works
1 parent a753076 commit 5d574a7

4 files changed

Lines changed: 38 additions & 5 deletions

File tree

.markdownlint.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@
33
"MD013": false,
44
"MD024": false,
55
"MD029": { "style": one },
6+
"MD033": false,
7+
"MD041": false,
68
}

README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# ![Reloader-logo](assets/web/reloader-round-100px.png) Reloader
1+
<p align="center">
2+
<img src="assets/web/reloader.jpg" alt="Reloader" width="40%"/>
3+
</p>
24

35
[![Go Report Card](https://goreportcard.com/badge/github.com/stakater/reloader?style=flat-square)](https://goreportcard.com/report/github.com/stakater/reloader)
46
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/stakater/reloader)
@@ -9,13 +11,42 @@
911
[![license](https://img.shields.io/github/license/stakater/reloader.svg?style=flat-square)](LICENSE)
1012
[![Get started with Stakater](https://stakater.github.io/README/stakater-github-banner.png)](https://stakater.com/?utm_source=Reloader&utm_medium=github)
1113

12-
## Problem
14+
## 🔁 What is Reloader?
1315

14-
We would like to watch if some change happens in `ConfigMap` and/or `Secret`; then perform a rolling upgrade on relevant `DeploymentConfig`, `Deployment`, `Daemonset`, `Statefulset` and `Rollout`
16+
Reloader is a Kubernetes controller that automatically triggers rollouts of workloads (like Deployments, StatefulSets, and more) whenever referenced `Secrets` or `ConfigMaps` are updated.
1517

16-
## Solution
18+
In a traditional Kubernetes setup, updating a `Secret` or `ConfigMap` does not automatically restart or redeploy your workloads. This can lead to stale configurations running in production, especially when dealing with dynamic values like credentials, feature flags, or environment configs.
1719

18-
Reloader can watch changes in `ConfigMap` and `Secret` and do rolling upgrades on Pods with their associated `DeploymentConfigs`, `Deployments`, `Daemonsets` `Statefulsets` and `Rollouts`.
20+
Reloader bridges that gap by ensuring your workloads stay in sync with configuration changes — automatically and safely.
21+
22+
## 🚀 Why Reloader?
23+
24+
-**Zero manual restarts**: No need to manually rollout workloads after config/secret changes.
25+
- 🔒 **Secure by design**: Ensure your apps always use the most up-to-date credentials or tokens.
26+
- 🛠️ **Flexible**: Works with all major workload types — Deployment, StatefulSet, Daemonset, ArgoRollout, and more.
27+
-**Fast feedback loop**: Ideal for CI/CD pipelines where secrets/configs change frequently.
28+
- 🔄 **Out-of-the-box integration**: Just label your workloads and let Reloader do the rest.
29+
30+
## 🔧 How It Works
31+
32+
```mermaid
33+
flowchart LR
34+
ExternalSecret -->|Creates| Secret
35+
SealedSecret -->|Creates| Secret
36+
Secret -->|Watched by| Reloader
37+
Configmap -->|Watched by| Reloader
38+
39+
Reloader -->|Triggers Rollout| Deployment
40+
Reloader -->|Triggers Rollout| DeploymentConfig
41+
Reloader -->|Triggers Rollout| Daemonset
42+
Reloader -->|Triggers Rollout| Statefulset
43+
Reloader -->|Triggers Rollout| ArgoRollout
44+
Reloader -->|Triggers Job| CronJob
45+
```
46+
47+
- Sources like `ExternalSecret` or `SealedSecret` create or manage your Kubernetes Secrets.
48+
- `Secrets` and `ConfigMaps` are watched by Reloader.
49+
- When changes are detected, Reloader automatically triggers a rollout of the associated workloads, ensuring your app always runs with the latest configuration.
1950

2051
## Enterprise Version
2152

-11.8 KB
Binary file not shown.

assets/web/reloader.jpg

117 KB
Loading

0 commit comments

Comments
 (0)