Add full banner headers to all scripts across the codebase
Every script now has the established header format: PURPOSE with ─────── separator, OPERATIONAL MODEL, DESIGN PRINCIPLES, OPERATIONAL SAFEGUARDS, CONFIGURATION, and RUNTIME MODES — structured with full ====== banner sections throughout. Orchestrators converted from compact ── inline format to full banners. Stale emby-fallback and dirty sync references removed from Plugin/user_script_plug-in.sh.
This commit is contained in:
@@ -20,6 +20,30 @@
|
||||
# RAM → backup removed → fallback.sh runs with last-known-good partner vars
|
||||
#
|
||||
# Own conf is never in the backup — it's always on disk.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# DESIGN PRINCIPLES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# Remove After Use
|
||||
# The persistent backup is always removed at the end of the run — whether it
|
||||
# was used or not. Stale backups from a previous shutdown should never be left
|
||||
# behind as a permanent fallback; the backup is a single-boot safety net, not
|
||||
# a long-lived cache.
|
||||
#
|
||||
# Partner Only
|
||||
# Own conf is on disk and is always available regardless of array or partner
|
||||
# state. Only partner confs can be missing after a boot — only those are
|
||||
# restored.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# OPERATIONAL SAFEGUARDS
|
||||
# ==============================================================================================
|
||||
#
|
||||
# require_partnership — exits early if PARTNERSHIP_ENABLED=false
|
||||
# detect_hosts() — determines which conf files belong to partners vs self
|
||||
# No-backup guard — exits cleanly if PERSISTENT_CONF_CACHE doesn't exist
|
||||
#
|
||||
# ==============================================================================================
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
|
||||
@@ -16,6 +16,28 @@
|
||||
#
|
||||
# Only partner confs are saved — own conf is always on disk.
|
||||
# Path adapts to storage mode: $SCRIPTS_DIR/.cache/vv/d (internal or appdata).
|
||||
#
|
||||
# ==============================================================================================
|
||||
# DESIGN PRINCIPLES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# Save at Shutdown, Not at Boot
|
||||
# The backup is created at array stop while the RAM cache is at its freshest.
|
||||
# By the next boot the partner may be unreachable — but the conf is already
|
||||
# preserved and available the moment conf_cache_restore.sh runs.
|
||||
#
|
||||
# Partner Only
|
||||
# Own conf is on disk — always present, never needs saving. Only partner confs
|
||||
# live in RAM and can be missing at the next boot.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# OPERATIONAL SAFEGUARDS
|
||||
# ==============================================================================================
|
||||
#
|
||||
# require_partnership — exits early if PARTNERSHIP_ENABLED=false
|
||||
# detect_hosts() — determines which confs to save (partner confs only)
|
||||
# No-cache guard — exits cleanly if RAM cache is empty or missing
|
||||
#
|
||||
# ==============================================================================================
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
|
||||
@@ -25,6 +25,29 @@
|
||||
# works whether the remote is in internal or appdata storage mode.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# DESIGN PRINCIPLES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# RAM-Only Credentials
|
||||
# Partner credentials and keys never touch disk on the receiving server.
|
||||
# /tmp/.cache/vv/d is tmpfs — cleared every reboot. This is intentional:
|
||||
# partner conf files are not discoverable on disk between boots.
|
||||
#
|
||||
# Pull Resolves Remote Path
|
||||
# The pull step reads the remote's varaverk.cfg to discover their SCRIPTS_DIR
|
||||
# before SSHing for the conf. Works whether the remote is in internal or
|
||||
# appdata storage mode — no hardcoded path assumptions about the remote.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# OPERATIONAL SAFEGUARDS
|
||||
# ==============================================================================================
|
||||
#
|
||||
# require_partnership — exits early if PARTNERSHIP_ENABLED=false
|
||||
# detect_hosts() — partner list for push/pull routing
|
||||
# acquire_lock — prevents concurrent sync runs
|
||||
# SSH reachability — partners that fail SSH are skipped, not fatal
|
||||
#
|
||||
# ==============================================================================================
|
||||
# RUNTIME MODES
|
||||
# ==============================================================================================
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user