offline / test (push) Waiting to run

Details

Document every repo in Sphinx, catalog PDFs, and verae-ops

Add missing package READMEs, expand Sphinx to all runtime modules,
publish a LaTeX/PDF README book, and add verae-ops for Docker,
Proxmox, VMs, dedicated hardware, and service linking. Catalog
defaults to public PDF links for each module README and samples.

2026-09-11 14:36:17 -04:00

3 KiB

Raw Blame History

`verae-fleet/supervisor`

Package: verae-fleet
Source: packages/verae-fleet/src/supervisor.js
Lines: 511

What this module is

Implementation module in verae-fleet. The tables below are extracted from the source (signatures + JSDoc).

Exports

Supervisor

Types / interfaces / classes

Kind	Name
class	`Supervisor`

Functions

Name	Parameters	Param types (JSDoc)	Returns	Calls (same file / helpers)
`waitExit`	`child, ms`	—	`unknown`	see Call graph
`waitForHealth`	`rec, ms`	—	`unknown`	see Call graph

Methods (class / object)

Name	Parameters
`constructor`	`opts = {}`
`machines`	`(none)`
`addMachine`	`spec`
`setMachineEnabled`	`id, enabled`
`checkMachine`	`id`
`machineOf`	`rec`
`controlInstance`	`rec, pathname, body`
`log`	`type, detail`
`spec`	`serviceId`
`nextIndex`	`serviceId`
`startOne`	`serviceId, opts = {}`
`stopInstance`	`instanceId, { replace = true } = {}`
`pauseInstance`	`instanceId, { replace = true } = {}`
`resumeInstance`	`instanceId`
`restartInstance`	`instanceId`
`markUnhealthy`	`instanceId`
`probe`	`rec`
`available`	`serviceId`
`reconcile`	`only`
`startService`	`serviceId`
`stopService`	`serviceId, { holdFloor = false } = {}`
`pauseService`	`serviceId`
`resumeService`	`serviceId`
`stopAll`	`(none)`
`status`	`(none)`

What it imports / requires

node:child_process
node:fs
node:path
node:url
./load.js
./health.js
./classify.js
./machines.js
./rtt.js
./ssh.js

Call graph (identifiers invoked)

floor, join, dirname, fileURLToPath, constructor, loadFleet, mkdirSync, isArray, machines, addMachine, upsertMachine, saveOverlay, log, setMachineEnabled, find, checkMachine, sshCheck, httpProbe, machineOf, controlInstance, sshHttp, postControl, toISOString, push, splice, spec, nextIndex, values, filter, map, has, startOne, get, pickMachine, sshSpawnWorker, spawn, now, on, set, waitForHealth, stopInstance, sshKillWorker, kill, waitExit, delete, reconcile, pauseInstance, resumeInstance, restartInstance, markUnhealthy, probe, isFinite, summarizeRtt, available, keys, min, startService, stopService, pauseService, resumeService

Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.

Return values (how to read this)

HTTP route handlers return Express res.json(...) bodies (see route docs).
Zapier perform functions return a single object (creates) or an array (triggers/searches).
Pricing functions return integer cents on Quote.totalCents.

3 KiB Raw Blame History Unescape Escape

verae-fleet/supervisor