Concepts and architecture
Concepts and architecture
Read Core concepts and What is an application driver? first: they define the terms that the other pages use. The Glossary gives a one-sentence definition of each term.
Each other page explains one internal mechanism. Read it when you need it: for example, when Styrmin does something you did not expect, when you connect Styrmin to another system, or when you write a driver and need to know which lifecycle hook runs when.
Pages in this section
| Page | Read it when you want to |
|---|---|
| Architecture | Know the components (server, agent, database) and how they connect. |
| Reconciliation | Know what happens between a change to a deployment and the cluster matching it. |
The operator and StyrminDeployment | Know what the operator and the StyrminDeployment custom resource do in the cluster. |
| Ingress and networking | Know how an application gets a URL after you deploy it. |
| Backups and restores | Know what Styrmin does when you start a backup, and where it stores the data. |
| Image overrides | Run a custom or patched build on one component of a deployment, without forking its driver. |
| Replica overrides | Change the number of pods of one component, or find where a component's pod count comes from. |
| Node affinity | Run a deployment's pods only on nodes with a given label, or replace a removed node_selector value. |
| Lifecycle hooks and actions | Write a driver, or know which hook runs which driver code, and when. |
| Status reporting | Know how the UI shows the state of the cluster. |
Reading order
The pages below build on each other:
- Architecture: the other pages refer to its components.
- Reconciliation: the loop that Styrmin runs for each change.
- The operator and
StyrminDeployment: reconciliation inside the cluster, in the agent.
The other pages are independent. Read the one that answers your question.