Concepts and Architecture
Concepts and Architectureβ
This section serves two purposes:
- The first few pages give you the mental model you need to use Styrmin β driver, cluster, environment, deployment, reconciliation, context. Read these.
- The remaining pages are optional under-the-hood detail. Read them when you want to understand what's happening internally β usually because something surprised you, because you're integrating Styrmin into a larger system, or because you're about to write a driver and want to know which lifecycle hook runs when.
Each page is short, educational, and assumes you are not a Kubernetes expert. We explain the moving parts in plain English and link out to the deeper internal docs when you want more.
What's in hereβ
| Page | Read it when⦠|
|---|---|
| Architecture | You want the big picture: server, agent, database, and how they talk to each other. |
| Reconciliation | You're wondering what actually happens between "I changed this deployment" and "the cluster matches". |
The operator and StyrminDeployment | You've heard the word "CRD" or "operator" and want to know what Styrmin is doing with them. |
| Ingress and networking | You want to understand how an application becomes reachable on a URL after you deploy it. |
| Backups and restores | You want to know what Styrmin actually does when you click "backup", and where the data ends up. |
| Lifecycle hooks and actions | You're about to write a driver, or you want to know how Styrmin runs the right code at the right moment. |
| Status reporting | You're wondering how the UI stays up-to-date with what's actually running in the cluster. |
Suggested reading orderβ
If you read top-to-bottom, the pages build on each other:
- Architecture first β everything else slots into the picture it draws.
- Reconciliation β the core loop Styrmin runs over and over.
- The operator and
StyrminDeploymentβ what reconciliation looks like once the agent is involved. - The remaining four are independent β read whichever solves your current problem.
If you just want one specific answer, jump straight to that page from the table above.