Skip to main content

Install the certified set

The current certified set is Quantum 1.28.0: Quark v1.11.0, Nucleus v1.24.0 and Orbit v1.9.2, tested together. Every version on this page is generated from the suite manifest (versions.yaml) when the site is built — nothing here is copied by hand, so it cannot go stale.

There is no "suite installer": each pillar is an ordinary Go module you go get. What the set gives you is the answer to which versions.

One pillar at a time

Only the data layer:

go get github.com/jcsvwinston/quark@v1.11.0

The web framework (and its CLI, at the same certified tag — @latest can run ahead of the set):

go get github.com/jcsvwinston/nucleus@v1.24.0
go install github.com/jcsvwinston/nucleus/cmd/nucleus@v1.24.0

The admin panel (requires Nucleus in the same app):

go get github.com/jcsvwinston/orbit@v1.9.2

The whole set, as a require block

A certified set is more than the three pillars. Each product ships its optional pieces as separate modules — database drivers, telemetry exporters, cloud storage and LDAP for Nucleus; one driver module per engine for Quark; the fleet trio and the two Quark bridges for Orbit — and the set pins every one of them. This is the full block, generated from the manifest's four module blocks. Paste what you need into your go.mod:

require (
github.com/jcsvwinston/quark v1.11.0
github.com/jcsvwinston/quark/drivers/mssql v0.1.2
github.com/jcsvwinston/quark/drivers/mysql v0.1.2
github.com/jcsvwinston/quark/drivers/oracle v0.1.2
github.com/jcsvwinston/quark/drivers/postgres v0.1.2
github.com/jcsvwinston/quark/drivers/sqlite v0.1.2
github.com/jcsvwinston/nucleus v1.24.0
github.com/jcsvwinston/nucleus/drivers/mssql v0.1.2
github.com/jcsvwinston/nucleus/drivers/mysql v0.1.2
github.com/jcsvwinston/nucleus/drivers/oracle v0.1.2
github.com/jcsvwinston/nucleus/drivers/postgres v0.1.2
github.com/jcsvwinston/nucleus/drivers/sqlite v0.1.2
github.com/jcsvwinston/nucleus/exporters/otlp v0.1.2
github.com/jcsvwinston/nucleus/exporters/prometheus v0.1.2
github.com/jcsvwinston/nucleus/providers/ldap v0.2.6
github.com/jcsvwinston/nucleus/providers/secrets-aws v0.1.2
github.com/jcsvwinston/nucleus/providers/storage-azure v0.1.2
github.com/jcsvwinston/nucleus/providers/storage-gcs v0.1.2
github.com/jcsvwinston/nucleus/providers/storage-s3 v0.1.2
github.com/jcsvwinston/orbit v1.9.2
github.com/jcsvwinston/orbit/proto v0.4.4
github.com/jcsvwinston/orbit/agent v0.6.16
github.com/jcsvwinston/orbit/server v0.11.2
github.com/jcsvwinston/orbit/quarkbridge v1.8.20
github.com/jcsvwinston/orbit/quarkdatasource v1.8.21
)

Two honest notes about that block:

  • go mod tidy will prune what you don't import. That is fine — the block's job is to pin the modules you do use at certified versions, not to force every dependency on every app.
  • Go may resolve higher, never lower. These are minimum versions: another dependency can pull a pillar above the certified set (Go's version selection takes the maximum of the minimums). Between sets each product keeps releasing on its own — see certified sets for the upgrade policy.

Which module do I actually need?

If you use…Add
Quark alone, or as a Nucleus app's data layerquark
A web applicationnucleus
The admin panel on a Nucleus apporbit
A database, in Nucleus (one module per engine; no app starts without one)nucleus/drivers/{postgres,mysql,sqlite,mssql,oracle}
A database, in Quark (registers the driver and its error classifier)quark/drivers/{postgres,mysql,sqlite,mssql,oracle}
Data Studio over Quark modelsorbit/quarkdatasource
Quark SQL in Orbit's live feedorbit/quarkbridge
Fleet observability (multi-node admin)orbit/agent, orbit/server, orbit/proto
A /metrics endpoint for Prometheus to scrapenucleus/exporters/prometheus
Traces and metrics pushed to an OTLP collectornucleus/exporters/otlp
S3 (or compatible), Google Cloud Storage, Azure Blobnucleus/providers/storage-{s3,gcs,azure}
AWS Secrets Managernucleus/providers/secrets-aws
LDAP authentication in Nucleusnucleus/providers/ldap

Every optional module is a go get plus a blank import, and the import is the step people forget — the build succeeds without it and the failure arrives at run time. The Nucleus CLI does both in one step:

nucleus add sqlite prometheus # go get + the `_` import, for each name
nucleus add --help # the list of names it knows

Configuration does not change when you add a module: database_url, otlp_endpoint, metrics_path and storage.provider mean what they always meant. If the module a setting needs is not linked, startup stops with the two lines that fix it.

The quickstart uses the pillars, both SQLite driver modules and the two bridges, and shows where each one enters.

Developing against the suite source

To work on the products themselves (or run the integration examples from source), clone the umbrella repo with submodules — it pins each product's checkout to the certified set and ships a ready go.work:

git clone --recurse-submodules https://github.com/jcsvwinston/quantum.git