Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
jokku
command
Command jokku is the Jokku CLI, server daemon, proxy, SSH forced command, git hook and microVM init in one binary.
|
Command jokku is the Jokku CLI, server daemon, proxy, SSH forced command, git hook and microVM init in one binary. |
|
internal
|
|
|
agent
Package agent runs on every node, the control node included.
|
Package agent runs on every node, the control node included. |
|
api
Package api is Jokku's HTTP API.
|
Package api is Jokku's HTTP API. |
|
backup
Package backup copies volume disks to S3-compatible object storage and back.
|
Package backup copies volume disks to S3-compatible object storage and back. |
|
build
Package build turns a source tarball with a Dockerfile into a rootfs artifact: a read-only ext4 image that microVMs boot from.
|
Package build turns a source tarball with a Dockerfile into a rootfs artifact: a read-only ext4 image that microVMs boot from. |
|
cli
Package cli implements the jokku command line: Dokku's commands, arguments and output, backed by the Jokku API.
|
Package cli implements the jokku command line: Dokku's commands, arguments and output, backed by the Jokku API. |
|
client
Package client is the Go client for the Jokku API, used by the CLI and the git hook.
|
Package client is the Go client for the Jokku API, used by the CLI and the git hook. |
|
cluster
Package cluster is the control plane: it decides what every node runs and learns what is actually running.
|
Package cluster is the control plane: it decides what every node runs and learns what is actually running. |
|
compose
Package compose turns a docker compose file into what Jokku runs: one app whose process types are the file's services, each with its own image.
|
Package compose turns a docker compose file into what Jokku runs: one app whose process types are the file's services, each with its own image. |
|
daemon
Package daemon runs a Jokku node.
|
Package daemon runs a Jokku node. |
|
database
Package database describes the databases Jokku runs for apps: Postgres, MySQL and Redis.
|
Package database describes the databases Jokku runs for apps: Postgres, MySQL and Redis. |
|
deploy
Package deploy turns source into releases and rolls them out:
|
Package deploy turns source into releases and rolls them out: |
|
deps
Package deps pins the third-party software a Jokku node runs: Firecracker, the guest kernel and BuildKit.
|
Package deps pins the third-party software a Jokku node runs: Firecracker, the guest kernel and BuildKit. |
|
dns
Package dns gives microVMs names for each other.
|
Package dns gives microVMs names for each other. |
|
gitrepo
Package gitrepo manages the bare repositories that "git push" targets.
|
Package gitrepo manages the bare repositories that "git push" targets. |
|
guest
Package guest is the init process (PID 1) inside every microVM, and the config it boots from.
|
Package guest is the init process (PID 1) inside every microVM, and the config it boots from. |
|
httpauth
Package httpauth is the cryptography behind logins in front of apps (http-auth): password hashes, TOTP codes, and signed session cookies and login hand-offs.
|
Package httpauth is the cryptography behind logins in front of apps (http-auth): password hashes, TOTP codes, and signed session cookies and login hand-offs. |
|
journal
Package journal reads app output from the systemd journal, where every microVM's console lands tagged with JOKKU_APP, JOKKU_PROCESS and JOKKU_INSTANCE.
|
Package journal reads app output from the systemd journal, where every microVM's console lands tagged with JOKKU_APP, JOKKU_PROCESS and JOKKU_INSTANCE. |
|
latency
Package latency keeps how long requests took, for percentiles over the last hour and day ("jokku top"): as histograms, which are small, add up across nodes exactly, and give a percentile to within 5%.
|
Package latency keeps how long requests took, for percentiles over the last hour and day ("jokku top"): as histograms, which are small, add up across nodes exactly, and give a percentile to within 5%. |
|
mesh
Package mesh connects nodes with WireGuard.
|
Package mesh connects nodes with WireGuard. |
|
nettest
Package nettest reads network tests (types.NetTest) the same way for jokku top, network:report and the event a test records: what a healthy link does in this cluster, how each link and node compares, and which nodes stand out.
|
Package nettest reads network tests (types.NetTest) the same way for jokku top, network:report and the event a test records: what a healthy link does in this cluster, how each link and node compares, and which nodes stand out. |
|
props
Package props declares the Dokku-style "<plugin>:set <app> <key> <value>" properties.
|
Package props declares the Dokku-style "<plugin>:set <app> <key> <value>" properties. |
|
proxy
Package proxy is the HTTP(S) router in front of apps: Caddy, embedded in the jokku binary and run as its own service ("jokku proxy"), so restarting or updating the jokku daemon never interrupts traffic.
|
Package proxy is the HTTP(S) router in front of apps: Caddy, embedded in the jokku binary and run as its own service ("jokku proxy"), so restarting or updating the jokku daemon never interrupts traffic. |
|
session
Package session is how Jokku reaches inside a running microVM: a shell or command (jokku enter), and a volume's files (storage:export, storage:import).
|
Package session is how Jokku reaches inside a running microVM: a shell or command (jokku enter), and a volume's files (storage:export, storage:import). |
|
setup
Package setup prepares a Linux server to run Jokku and (re)starts it.
|
Package setup prepares a Linux server to run Jokku and (re)starts it. |
|
splash
Package splash draws the screen a Jokku server greets you with when you log in: the logo, a striped sun, and live figures about the server and its cluster.
|
Package splash draws the screen a Jokku server greets you with when you log in: the logo, a striped sun, and live figures about the server and its cluster. |
|
sshkeys
Package sshkeys turns stored SSH keys into the jokku user's authorized_keys, where every key is bound to "jokku ssh-command".
|
Package sshkeys turns stored SSH keys into the jokku user's authorized_keys, where every key is bound to "jokku ssh-command". |
|
store
Package store is the control node's state: a single SQLite database.
|
Package store is the control node's state: a single SQLite database. |
|
tui
Package tui is "jokku top": a live, interactive view of the cluster's nodes, apps, instances and events, refreshed every two seconds from the API.
|
Package tui is "jokku top": a live, interactive view of the cluster's nodes, apps, instances and events, refreshed every two seconds from the API. |
|
types
Package types defines the JSON shapes of the Jokku HTTP API.
|
Package types defines the JSON shapes of the Jokku HTTP API. |
|
update
Package update finds jokku releases and runs their update.sh, which backs up, swaps the binary, runs "jokku setup" and rolls back on failure: the one update path, whether "jokku update" starts it or the control node asks a node to update itself.
|
Package update finds jokku releases and runs their update.sh, which backs up, swaps the binary, runs "jokku setup" and rolls back on failure: the one update path, whether "jokku update" starts it or the control node asks a node to update itself. |
|
version
Package version holds build metadata, overridden at link time:
|
Package version holds build metadata, overridden at link time: |
|
vm
Package vm runs microVMs on this node: the bridge they share, and one Firecracker process per instance.
|
Package vm runs microVMs on this node: the bridge they share, and one Firecracker process per instance. |
|
volume
Package volume copies a disk image to another node, sending only the blocks the receiving copy lacks.
|
Package volume copies a disk image to another node, sending only the blocks the receiving copy lacks. |
Click to show internal directories.
Click to hide internal directories.
