FerryDocs
ArchitectureOverview

The store

The store is the part of ferry-core that reads and writes the SQLite database of Ferry.

Edit on GitHub
APIEngineStoreferry-coreferry.dbSQLite
The API and the engine use the same store

The has the . It says what must run:

  • Which is live for each service.
  • How many instances the service wants.
  • If you suspended the service.
  • Which datastores exist.

Docker says what runs. The reconciler compares the two.

The file is ferry.db, a database, in the data directory. The proxy never reads it on the request path.

The crate ferry-core

ferry-core is a library. It has the types and the rules that all the other crates share. It depends on no other Ferry crate.

In ferry-core
ModelsThe domain models. The types of the API requests and responses.
ConfigurationThe configuration. Validation. The ranges of the resource limits and how to parse them.
EnvironmentHow to merge env vars and how to resolve references.
StorageThe SQLite Store.
Names and timeDocker names. Cron schedules.
TraitsEngine and TlsHooks, which keep the other crates apart.

On this page