Complete the header template across Partnership, Kernel, Deployment and Plugin
Finishes the pass: every script now documents its safeguards, and the deliberate absences in the sourced libraries are recorded so they are not "corrected" later.
This commit is contained in:
@@ -144,6 +144,82 @@
|
||||
# bash /boot/config/plugins/varaverk/Orchestrators/array_started.sh
|
||||
|
||||
|
||||
# ==============================================================================================
|
||||
# DESIGN PRINCIPLES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# Schedule Orchestrators, Not Scripts
|
||||
# The catalog below lists every script in the ecosystem, but only a handful of
|
||||
# orchestrators are meant to be scheduled. The orchestrators own ordering, dependencies,
|
||||
# pass/fail tracking and one notification per window — scheduling their children directly
|
||||
# bypasses all of that and produces overlapping runs the locks then have to fight.
|
||||
#
|
||||
# Everything Listed, Most Commented
|
||||
# Individual scripts are documented here so they can be run standalone for a specific
|
||||
# task, not so they can be scheduled. The commented-out default is the safe state: paste
|
||||
# the file, uncomment exactly one block, set the schedule.
|
||||
#
|
||||
# One Block Per User Script Entry
|
||||
# Each entry runs one thing. Combining blocks defeats the per-entry schedule and makes a
|
||||
# failure in the first silently skip the rest.
|
||||
#
|
||||
# Documentation That Cannot Drift Silently
|
||||
# Schedules here are stated alongside what the script does, so a mismatch with
|
||||
# varaverk.cron is visible when read. Cross-check against the cron before trusting a
|
||||
# cadence quoted in a comment — the cron is authoritative.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# OPERATIONAL SAFEGUARDS
|
||||
# ==============================================================================================
|
||||
#
|
||||
# Inert by Default
|
||||
# Every command in this file is commented out. Pasted as-is it does nothing — the
|
||||
# operator must deliberately uncomment a block. That is the safeguard: there is no state
|
||||
# in which this file runs something unintended.
|
||||
#
|
||||
# No Root, No Lock, No detect_hosts — Deliberate
|
||||
# This is a reference template, never executed as a file. Each uncommented block invokes
|
||||
# a real script that enforces its own root check and takes its own lock. Adding them here
|
||||
# would gate a file that is only ever read.
|
||||
#
|
||||
# Full Paths Throughout
|
||||
# Every example uses an absolute path. User Scripts entries run with an unpredictable
|
||||
# working directory, and a relative path would resolve differently depending on how the
|
||||
# plugin happened to invoke it.
|
||||
#
|
||||
# Background Flag Documented Per Entry
|
||||
# Continuous scripts are marked Background: YES and single-pass ones NO. Getting this
|
||||
# wrong either blocks the array-start sequence on a script that never exits, or detaches
|
||||
# one whose exit code the sequence needed.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# CONFIGURATION
|
||||
# ==============================================================================================
|
||||
#
|
||||
# None — this file configures nothing and reads nothing. It is documentation shaped like a
|
||||
# shell script so it can be pasted into a User Scripts entry.
|
||||
#
|
||||
# What the scheduled orchestrators actually read:
|
||||
#
|
||||
# master.conf ARRAY_START_SCRIPTS, ARRAY_STOP_SCRIPTS, WATCHDOG_ORCHESTRATOR_SCRIPTS,
|
||||
# CRITICAL_/INTERMEDIATE_/DAILY_/WEEKLY_/MONTHLY_MAINTENANCE_SCRIPTS
|
||||
#
|
||||
# Add or remove a script by editing those lists — not by adding another User Scripts entry.
|
||||
# That is the whole point of the orchestrator model.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# RUNTIME MODES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# Not executed. Paste into a User Scripts entry, uncomment ONE block, set its schedule.
|
||||
#
|
||||
# The blocks below are grouped by area (Fallback, Rsync, Docker Essentials, Unraid
|
||||
# Essentials, Media, Transcodes, Monitors, Partnership). Each carries its own recommended
|
||||
# schedule and Background flag.
|
||||
#
|
||||
# ==============================================================================================
|
||||
|
||||
|
||||
# ── ARRAY STOPPING ────────────────────────────────────────────────────────────────────────────
|
||||
# Schedule: At Stopping of Array
|
||||
# Background: YES
|
||||
|
||||
Reference in New Issue
Block a user