all scripts are now current with common.sh v2.1
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
#!/bin/bash
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# ------------------------- UNRAID OPS COMMON LIBRARY (v1.6) ------------------------------------
|
||||
# ----------------- UNRAID OPS COMMON LIBRARY (STABLE FRAMEWORK v1) ----------------------------
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# Version: 2.1
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# Changelog:
|
||||
# v1.0 — Initial stable framework
|
||||
@@ -23,24 +25,32 @@
|
||||
# ICON_NOT_RUNNING changed to ⭕ — distinct from ICON_STOPPED 🔴
|
||||
# Section dividers updated from --- to ━━━ for cleaner log readability
|
||||
# Summary passed/failed lines use ICON_SUCCESS and ICON_ERROR consistently
|
||||
# v1.7 — ICON_MOVER added for mover operations
|
||||
# ICON_CONTAINERS replaces ICON_DOCKER for docker/container operations
|
||||
# validate_int added — reusable integer validation for any script
|
||||
# v1.8 — ICON_PHP added for PHP-FPM operations
|
||||
# v1.9 — ICON_REBOOT added for server reboot operations
|
||||
# v2.0 — ICON_PLUGIN added for User Scripts plugin operations
|
||||
# v2.1 — ICON_ZFS and ICON_MEM added for ZFS and memory diagnostics
|
||||
# Diagnostics icon group added to icon block
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# ICONS
|
||||
# Each icon has one job — do not reuse across different contexts.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
# System / Host
|
||||
ICON_HOST="🖥️" # host detection
|
||||
ICON_NET="🌐" # network / IP resolution
|
||||
ICON_PING="📡" # connectivity check
|
||||
ICON_GEAR="⚙️" # setup section header / profile load
|
||||
|
||||
|
||||
# Health Checks
|
||||
ICON_DISK="💾" # disk checks
|
||||
ICON_HEALTH="🩺" # rootfs / share health checks
|
||||
ICON_SHIELD="🛡️" # pre-flight section header
|
||||
|
||||
|
||||
# Containers
|
||||
ICON_CONTAINERS="📦" # container section anchor — paired with action icon for direction
|
||||
ICON_STOP="⛔" # stop command being issued
|
||||
@@ -49,23 +59,33 @@ ICON_START="▶️" # start command being issued
|
||||
ICON_STARTED="💚" # container confirmed started
|
||||
ICON_RUNNING="🟢" # container already running when checked
|
||||
ICON_NOT_RUNNING="⭕" # container already stopped when checked — distinct from ICON_STOPPED
|
||||
|
||||
|
||||
# Transfer
|
||||
ICON_SYNC="🔄" # transfer section header
|
||||
ICON_RUN="🚀" # sync starting / rsync attempt
|
||||
ICON_RETRY="🔁" # retry attempt
|
||||
ICON_DONE="🏁" # transfer complete
|
||||
|
||||
|
||||
# Summary
|
||||
ICON_SUMMARY="📋" # summary section header
|
||||
ICON_TIME="⏱️" # duration line
|
||||
|
||||
|
||||
# System Operations
|
||||
ICON_MOVER="🔃" # mover operations
|
||||
ICON_REBOOT="⚡" # server reboot operations
|
||||
ICON_PLUGIN="🧩" # user scripts plugin operations
|
||||
ICON_PHP="👥" # PHP-FPM operations
|
||||
|
||||
# Diagnostics
|
||||
ICON_ZFS="📊" # ZFS ARC statistics
|
||||
ICON_MEM="🧠" # memory status
|
||||
|
||||
# Output
|
||||
ICON_INFO="ℹ️"
|
||||
ICON_WARN="⚠️"
|
||||
ICON_ERROR="❌"
|
||||
ICON_SUCCESS="✅"
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# OUTPUT HELPERS
|
||||
# Standardised output functions used across all scripts.
|
||||
@@ -75,11 +95,11 @@ info() { echo "$ICON_INFO [INFO] $*"; }
|
||||
warn() { echo "$ICON_WARN [WARN] $*"; }
|
||||
error() { echo "$ICON_ERROR [ERROR] $*"; }
|
||||
success() { echo "$ICON_SUCCESS [OK] $*"; }
|
||||
|
||||
|
||||
log() {
|
||||
[[ "${ENABLE_LOGGING:-false}" == true ]] && echo "[LOG] $*"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# DURATION FORMATTER
|
||||
# Converts raw seconds into a human readable string — e.g. 10m53s or 47s
|
||||
@@ -92,7 +112,7 @@ format_duration() {
|
||||
local rem=$((secs % 60))
|
||||
[[ $mins -gt 0 ]] && echo "${mins}m${rem}s" || echo "${rem}s"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# ARG PARSER
|
||||
# Processes all flags and key=value pairs passed to any script.
|
||||
@@ -105,14 +125,14 @@ parse_args() {
|
||||
ENABLE_LOGGING=${ENABLE_LOGGING:-false}
|
||||
DRY_RUN=${DRY_RUN:-false}
|
||||
SHOW_STATUS=${SHOW_STATUS:-false}
|
||||
|
||||
|
||||
CLEAN_ARGS=()
|
||||
|
||||
|
||||
for ARG in "$@"; do
|
||||
if [[ "$ARG" == *=* ]]; then
|
||||
VAR="${ARG%%=*}"
|
||||
VAL="${ARG#*=}"
|
||||
|
||||
|
||||
case "$VAR" in
|
||||
LOG)
|
||||
[[ "$VAL" == "true" ]] && ENABLE_LOGGING=true
|
||||
@@ -141,10 +161,10 @@ parse_args() {
|
||||
esac
|
||||
fi
|
||||
done
|
||||
|
||||
|
||||
PARSED_ARGS=("${CLEAN_ARGS[@]}")
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# VALIDATION
|
||||
# Checks that a required variable is set and non-empty.
|
||||
@@ -154,7 +174,31 @@ parse_args() {
|
||||
require_var() {
|
||||
[[ -z "${!1:-}" ]] && error "Missing required: $1" && exit 1
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# INTEGER VALIDATION
|
||||
# Checks that a variable contains a valid positive integer.
|
||||
# Exits with a clear error if the value is missing, empty, or not a number.
|
||||
# Usage: validate_int VAR_NAME "$VAR_VALUE"
|
||||
# Example: validate_int MOVER_STOP_TIMEOUT "$MOVER_STOP_TIMEOUT"
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
validate_int() {
|
||||
local name="$1"
|
||||
local value="$2"
|
||||
|
||||
if [[ -z "$value" ]]; then
|
||||
error "$name is not set — check Master.conf"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! [[ "$value" =~ ^[0-9]+$ ]]; then
|
||||
error "$name must be a positive integer — got: '$value'"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
log "$name validated: $value"
|
||||
}
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# HOST DETECTION
|
||||
# Determines local and remote server names by comparing hostname against HOST1/HOST2.
|
||||
@@ -163,7 +207,7 @@ require_var() {
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
detect_hosts() {
|
||||
LOCAL_HOSTNAME="$(hostname)"
|
||||
|
||||
|
||||
if [[ "$LOCAL_HOSTNAME" == "$HOST1" ]]; then
|
||||
LOCAL_SERVER_NAME="$HOST1"
|
||||
REMOTE_SERVER_NAME="$HOST2"
|
||||
@@ -174,18 +218,18 @@ detect_hosts() {
|
||||
error "Unknown host: $LOCAL_HOSTNAME"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
declare -A SSH_KEYS
|
||||
SSH_KEYS["$HOST1|$HOST2"]="$HOST1_SSH_KEY"
|
||||
SSH_KEYS["$HOST2|$HOST1"]="$HOST2_SSH_KEY"
|
||||
|
||||
|
||||
SSH_KEY="${SSH_KEYS[$LOCAL_SERVER_NAME|$REMOTE_SERVER_NAME]}"
|
||||
|
||||
|
||||
[[ -z "$SSH_KEY" ]] && error "Missing SSH key mapping for $LOCAL_SERVER_NAME → $REMOTE_SERVER_NAME" && exit 1
|
||||
|
||||
|
||||
info "$ICON_HOST Host: $LOCAL_SERVER_NAME → $REMOTE_SERVER_NAME"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# REMOTE IP RESOLUTION
|
||||
# Resolves the Tailscale IPv4 address of the remote server.
|
||||
@@ -195,12 +239,12 @@ detect_hosts() {
|
||||
resolve_remote_ip() {
|
||||
log "Resolving remote IP for $REMOTE_SERVER_NAME..."
|
||||
REMOTE_SERVER=$(tailscale ip -4 "$REMOTE_SERVER_NAME" 2>/dev/null)
|
||||
|
||||
|
||||
[[ -z "$REMOTE_SERVER" ]] && error "Failed to resolve Tailscale IP for $REMOTE_SERVER_NAME" && exit 1
|
||||
|
||||
|
||||
info "$ICON_NET Remote IP: $REMOTE_SERVER"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# CONNECTIVITY CHECK
|
||||
# Pings the remote server to confirm it is reachable before starting any transfers.
|
||||
@@ -216,7 +260,7 @@ check_connectivity() {
|
||||
fi
|
||||
info "$ICON_PING $REMOTE_SERVER_NAME is reachable"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# REMOTE ROOTFS SPACE CHECK
|
||||
# Checks the remote server's rootfs usage before any rsync runs.
|
||||
@@ -227,15 +271,15 @@ check_connectivity() {
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
check_remote_rootfs() {
|
||||
log "Checking remote rootfs usage..."
|
||||
|
||||
|
||||
REMOTE_USAGE=$(ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" \
|
||||
"df / --output=pcent | tail -1 | tr -d ' %'" 2>/dev/null)
|
||||
|
||||
|
||||
if [[ -z "$REMOTE_USAGE" ]]; then
|
||||
error "Could not retrieve rootfs usage from $REMOTE_SERVER_NAME"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
if [[ "$REMOTE_USAGE" -ge "${ROOTFS_WARN:-75}" ]]; then
|
||||
echo ""
|
||||
error "$ICON_HEALTH Remote rootfs is ${REMOTE_USAGE}% full — threshold is ${ROOTFS_WARN:-75}%"
|
||||
@@ -244,10 +288,10 @@ check_remote_rootfs() {
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
info "$ICON_HEALTH Remote rootfs: ${REMOTE_USAGE}% used (threshold: ${ROOTFS_WARN:-75}%)"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# REMOTE SHARE VALIDATION
|
||||
# Verifies that the target directory exists and is not empty on the remote server.
|
||||
@@ -258,12 +302,12 @@ check_remote_rootfs() {
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
check_remote_share() {
|
||||
local dir="$1"
|
||||
|
||||
|
||||
log "Checking remote share: $dir..."
|
||||
|
||||
|
||||
SHARE_EXISTS=$(ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" \
|
||||
"[[ -d '$dir' ]] && echo yes || echo no" 2>/dev/null)
|
||||
|
||||
|
||||
if [[ "$SHARE_EXISTS" != "yes" ]]; then
|
||||
echo ""
|
||||
error "$ICON_HEALTH Remote share does not exist: $dir"
|
||||
@@ -272,10 +316,10 @@ check_remote_share() {
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
SHARE_EMPTY=$(ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" \
|
||||
"[[ -z \"\$(ls -A '$dir' 2>/dev/null)\" ]] && echo yes || echo no" 2>/dev/null)
|
||||
|
||||
|
||||
if [[ "$SHARE_EMPTY" == "yes" ]]; then
|
||||
echo ""
|
||||
warn "$ICON_HEALTH Remote share exists but is empty: $dir"
|
||||
@@ -284,10 +328,10 @@ check_remote_share() {
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
info "$ICON_HEALTH Remote share verified: $dir"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# REMOTE DISK CHECK
|
||||
# Verifies that all physical disks backing a share are online and mounted on the remote server.
|
||||
@@ -301,12 +345,12 @@ check_remote_disks() {
|
||||
local dir="$1"
|
||||
local share_name
|
||||
share_name=$(basename "$dir")
|
||||
|
||||
|
||||
info "$ICON_DISK Checking disks backing $share_name on $REMOTE_SERVER_NAME..."
|
||||
|
||||
|
||||
DISK_PATHS=$(ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" \
|
||||
"ls -d /mnt/disk*/$share_name 2>/dev/null" 2>/dev/null)
|
||||
|
||||
|
||||
if [[ -z "$DISK_PATHS" ]]; then
|
||||
echo ""
|
||||
error "$ICON_DISK No disks found backing share $share_name on $REMOTE_SERVER_NAME"
|
||||
@@ -315,18 +359,18 @@ check_remote_disks() {
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
local all_ok=true
|
||||
|
||||
|
||||
while IFS= read -r disk_share_path; do
|
||||
local disk_mount
|
||||
disk_mount=$(dirname "$disk_share_path")
|
||||
local disk_name
|
||||
disk_name=$(basename "$disk_mount")
|
||||
|
||||
|
||||
MOUNTED=$(ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" \
|
||||
"mountpoint -q '$disk_mount' && echo yes || echo no" 2>/dev/null)
|
||||
|
||||
|
||||
if [[ "$MOUNTED" == "yes" ]]; then
|
||||
info "$ICON_DISK $disk_name $ICON_RUNNING — $share_name present"
|
||||
else
|
||||
@@ -334,7 +378,7 @@ check_remote_disks() {
|
||||
all_ok=false
|
||||
fi
|
||||
done <<< "$DISK_PATHS"
|
||||
|
||||
|
||||
if [[ "$all_ok" == false ]]; then
|
||||
echo ""
|
||||
error "One or more disks backing $share_name are offline on $REMOTE_SERVER_NAME"
|
||||
@@ -343,10 +387,10 @@ check_remote_disks() {
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
success "All disks backing $share_name are online"
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# CONTAINER MANAGEMENT — STOP
|
||||
# Stops all containers listed in CRITICAL_CONTAINER_NAMES on the remote server.
|
||||
@@ -355,29 +399,29 @@ check_remote_disks() {
|
||||
# CRITICAL_CONTAINER_NAMES must be a bash array — rsync.sh handles conversion from profile strings.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
RUNNING_CONTAINERS=()
|
||||
|
||||
|
||||
stop_containers() {
|
||||
if [[ ${#CRITICAL_CONTAINER_NAMES[@]} -eq 0 ]] || \
|
||||
[[ "${CRITICAL_CONTAINER_NAMES[*]}" == "" ]]; then
|
||||
log "No containers configured for this profile, skipping stop."
|
||||
return
|
||||
fi
|
||||
|
||||
|
||||
info "Stopping containers..."
|
||||
RUNNING_CONTAINERS=()
|
||||
|
||||
|
||||
for c in "${CRITICAL_CONTAINER_NAMES[@]}"; do
|
||||
[[ -z "$c" ]] && continue
|
||||
|
||||
|
||||
info "Checking $c..."
|
||||
|
||||
|
||||
STATUS=$(ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" \
|
||||
"docker inspect -f '{{.State.Running}}' $c 2>/dev/null" 2>/dev/null || echo "false")
|
||||
|
||||
|
||||
if [[ "$STATUS" == "true" ]]; then
|
||||
echo "$ICON_STOP Stopping $c..."
|
||||
RUNNING_CONTAINERS+=("$c")
|
||||
|
||||
|
||||
if ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" "docker stop $c" >/dev/null; then
|
||||
echo "$ICON_STOPPED $c stopped"
|
||||
else
|
||||
@@ -388,7 +432,7 @@ stop_containers() {
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# CONTAINER MANAGEMENT — START
|
||||
# Restarts only the containers that were running before rsync and were stopped by stop_containers.
|
||||
@@ -401,12 +445,12 @@ start_containers() {
|
||||
log "No containers to restart."
|
||||
return
|
||||
fi
|
||||
|
||||
|
||||
info "Starting containers..."
|
||||
|
||||
|
||||
for c in "${RUNNING_CONTAINERS[@]}"; do
|
||||
[[ -z "$c" ]] && continue
|
||||
|
||||
|
||||
local needs_delay=false
|
||||
for d in "${DELAYED_CONTAINERS[@]}"; do
|
||||
if [[ "$c" == "$d" ]]; then
|
||||
@@ -414,12 +458,12 @@ start_containers() {
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
|
||||
if [[ "$needs_delay" == true ]]; then
|
||||
info "Waiting ${CONTAINER_DELAY}s before starting $c..."
|
||||
sleep "$CONTAINER_DELAY"
|
||||
fi
|
||||
|
||||
|
||||
echo "$ICON_START Starting $c..."
|
||||
if ssh -i "$SSH_KEY" root@"$REMOTE_SERVER" "docker start $c" >/dev/null; then
|
||||
echo "$ICON_STARTED $c started"
|
||||
@@ -428,7 +472,7 @@ start_containers() {
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# RSYNC OPTIONS
|
||||
# Loads rsync options for the current profile from PROFILE_RSYNC_OPTS in Master.conf.
|
||||
@@ -445,11 +489,11 @@ get_rsync_opts() {
|
||||
log "Using default rsync opts: ${RSYNC_OPTS[*]}"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# STATUS DISPLAY
|
||||
# Prints a summary of the current runtime configuration.
|
||||
# Triggered by --status or --summary flag passed to rsync.sh.
|
||||
# Triggered by --status or --summary flag passed to any script.
|
||||
# Useful for verifying profile resolution and variable state before a live run.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
show_status() {
|
||||
|
||||
Reference in New Issue
Block a user