Previewkernable is not released yet: these docs describe work in progress, and things may change before 1.0.Not released yet.Request early access →
Skip to content

How-to guides ​

Short guides for tasks you meet once your application runs. They assume you know the concepts; the tutorial shows the code they refer to.

Build and change your application ​

GuideWhen you need it
Test your domainYou want to test aggregates without a kernel, or against a real one.
Add tenants, accounts and authorizationYour application needs tenants, people who sign in, roles and invitations.
Schedule a commandA command should run later: a timeout, a reminder, a deadline.
Change an event's formatAn event must carry something new, but stored events stay as they are.
Rebuild a read modelYou fixed a handler bug, or a read model should hold something new.
Remove a listener, middleware or aggregateYou stop running something, and the kernel should stop waiting for it. Covers memberships.

Run it in production ​

GuideWhen you need it
Deploy and upgradeYou start, stop or upgrade the kernel and your processes.
Back up and restoreYou set up backups, or you need to restore.
Move a kernel with export and importYou leave a hosted kernel, move to another machine, or change the store backend.
Share tenants across kernelsOne kernel is not enough for all your tenants: several share them by a signed map.
Run a standbyA second kernel should hold every write and take over, with a witness by itself, when the primary's machine is lost.
Run a listener on several machinesThe same read models and reactors run on more than one machine, each with its own copy.
Run a node from one fileOne file says what runs on a machine: the kernel and its backup follower, started again when they exit or the file changes.
Run kernable on your own serversFrom a bare Linux machine to a node that starts with it: install, a user, keys, the node's file, systemd, the firewall.
Monitor kernableYou want metrics, health checks, alerts and logs, or a reactor parked events.

Security ​

GuideWhen you need it
Keys per service, and changing a keyYou give each service its own key and grant, or you change, revoke or replace a key.
Mutual TLS with your own PKIYou run over TCP with your own CA instead of development certificates.
Passwords and other secretsA command carries a value that must never be stored.

Data ​

GuideWhen you need it
Handle an erasure requestA person asks you to erase their personal data.
Store files and cache valuesA domain needs files (an invoice PDF) or values that expire (a rate limit).

Extend kernable ​

GuideWhen you need it
Write an SDK for another languageYou want processes in a language without an SDK.