A CLI tool has runtime modes, not a request
This commit is contained in:
@@ -9,6 +9,19 @@
|
|||||||
// Onboard calls this on the mirror after deploying the owner's stack, so those containers land
|
// Onboard calls this on the mirror after deploying the owner's stack, so those containers land
|
||||||
// somewhere that says whose they are instead of scattering into the mirror's own groups.
|
// somewhere that says whose they are instead of scattering into the mirror's own groups.
|
||||||
//
|
//
|
||||||
|
// OPERATIONAL MODEL
|
||||||
|
// Create-or-update, never replace. The named folder is found in folder.view3 if it exists and
|
||||||
|
// is amended in place; only its absence causes one to be created. Every other folder in the
|
||||||
|
// file, and every container already filed elsewhere, is left exactly as it was — this is one
|
||||||
|
// shelf in someone else's cupboard.
|
||||||
|
//
|
||||||
|
// Called during onboard on the mirror, after the owner's stack has been deployed there, so the
|
||||||
|
// containers exist by the time anything tries to file them.
|
||||||
|
//
|
||||||
|
// The icon is resolved separately from the folder and never gates it. --icon-only performs
|
||||||
|
// just that lookup and prints the URL, which is how onboard asks for it without writing
|
||||||
|
// anything.
|
||||||
|
//
|
||||||
// DESIGN PRINCIPLES
|
// DESIGN PRINCIPLES
|
||||||
// The name comes from master.conf, never from a second source.
|
// The name comes from master.conf, never from a second source.
|
||||||
// HOST2="unRAID-Jayred36" → "Jayred36-Fallback". The convention already existed by hand as
|
// HOST2="unRAID-Jayred36" → "Jayred36-Fallback". The convention already existed by hand as
|
||||||
@@ -39,7 +52,7 @@
|
|||||||
// --dry-run prints the resulting folder and writes nothing.
|
// --dry-run prints the resulting folder and writes nothing.
|
||||||
// Icon resolution failing never blocks the folder: no image is a cosmetic loss, no folder is not.
|
// Icon resolution failing never blocks the folder: no image is a cosmetic loss, no folder is not.
|
||||||
//
|
//
|
||||||
// REQUEST
|
// RUNTIME MODES
|
||||||
// fallback_folder.php --host=HOST2 [--containers=A,B,C] [--icon=URL] [--dry-run]
|
// fallback_folder.php --host=HOST2 [--containers=A,B,C] [--icon=URL] [--dry-run]
|
||||||
// fallback_folder.php --host=HOST2 --icon-only resolve and print the icon URL, write nothing
|
// fallback_folder.php --host=HOST2 --icon-only resolve and print the icon URL, write nothing
|
||||||
//
|
//
|
||||||
|
|||||||
@@ -44,6 +44,17 @@
|
|||||||
// php mesh_traffic_sample.php append one sample per mesh peer
|
// php mesh_traffic_sample.php append one sample per mesh peer
|
||||||
// php mesh_traffic_sample.php --show print what it would record, write nothing
|
// php mesh_traffic_sample.php --show print what it would record, write nothing
|
||||||
//
|
//
|
||||||
|
// CONFIGURATION
|
||||||
|
// master.conf
|
||||||
|
// HOST1, HOST2, … the hostname of each node in the mesh. Every HOST<n> with a non-empty
|
||||||
|
// value becomes a name matched against tailscale's peer list; a peer that
|
||||||
|
// is not one of them is skipped, so a device that merely shares the
|
||||||
|
// tailnet is never recorded as mesh traffic. No HOST<n> set at all means
|
||||||
|
// there is no mesh to sample and the run exits without writing.
|
||||||
|
//
|
||||||
|
// Nothing is read from host*.conf. This samples the local tailscale daemon, so it needs to
|
||||||
|
// know which peers count and nothing about how to reach them.
|
||||||
|
//
|
||||||
// DEPENDS ON
|
// DEPENDS ON
|
||||||
// tailscale status --json the counters
|
// tailscale status --json the counters
|
||||||
// include/config.php DATA_DIR, vv_conf_vars() for the HOST* list
|
// include/config.php DATA_DIR, vv_conf_vars() for the HOST* list
|
||||||
|
|||||||
Reference in New Issue
Block a user