Enhanced log. fixed some general inconsistencies
This commit is contained in:
@@ -2,10 +2,16 @@
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# ----------------- UNRAID OPS COMMON LIBRARY (STABLE FRAMEWORK v1) ----------------------------
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# Version: 1.1
|
||||
# Changed: format_duration moved here from daily_sync.sh for shared use
|
||||
# SSH_KEY collision documented — gitea key renamed GITEA_SSH_KEY in Master.conf
|
||||
# Version: 1.2
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# Changelog:
|
||||
# v1.0 — Initial stable framework
|
||||
# v1.1 — format_duration moved here from daily_sync.sh for shared use
|
||||
# SSH_KEY collision resolved — gitea key renamed GITEA_SSH_KEY in Master.conf
|
||||
# Version and changelog tracking added
|
||||
# v1.2 — Consistent function header comment blocks across all functions
|
||||
# check_connectivity friendlier error output with tailscale hint
|
||||
# check_connectivity added as standalone function
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
|
||||
# ICONS
|
||||
@@ -19,7 +25,11 @@ ICON_RETRY="🔁"
|
||||
ICON_SYNC="🔄"
|
||||
ICON_GEAR="⚙️"
|
||||
|
||||
# OUTPUT
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# OUTPUT HELPERS
|
||||
# Standardised output functions used across all scripts.
|
||||
# log() is gated by ENABLE_LOGGING — set in Master.conf or via --log flag.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
info() { echo "$ICON_INFO [INFO] $*"; }
|
||||
warn() { echo "$ICON_WARN [WARN] $*"; }
|
||||
error() { echo "$ICON_ERROR [ERROR] $*"; }
|
||||
@@ -31,8 +41,9 @@ log() {
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# DURATION FORMATTER
|
||||
# Converts raw seconds to human readable format — e.g. 10m53s or 47s
|
||||
# Used by rsync.sh and daily_sync.sh
|
||||
# Converts raw seconds into a human readable string — e.g. 10m53s or 47s
|
||||
# Used by rsync.sh summary and daily_sync.sh summary.
|
||||
# Sourced from common.sh so both scripts share the same implementation.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
format_duration() {
|
||||
local secs=$1
|
||||
@@ -43,6 +54,11 @@ format_duration() {
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# ARG PARSER
|
||||
# Processes all flags and key=value pairs passed to any script.
|
||||
# Positional arguments (directory paths) are separated before calling this — see rsync.sh.
|
||||
# Supported flags: --dry-run, --log, --no-log, --status, --help
|
||||
# Supported key=value: LOG=true/false, or any declared variable e.g. BW_LIMIT=5000
|
||||
# Unparsed positional args are returned in PARSED_ARGS array.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
parse_args() {
|
||||
ENABLE_LOGGING=${ENABLE_LOGGING:-false}
|
||||
@@ -90,6 +106,9 @@ parse_args() {
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# VALIDATION
|
||||
# Checks that a required variable is set and non-empty.
|
||||
# Usage: require_var VAR_NAME
|
||||
# Exits with error if the variable is missing.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
require_var() {
|
||||
[[ -z "${!1:-}" ]] && error "Missing required: $1" && exit 1
|
||||
@@ -97,6 +116,9 @@ require_var() {
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# HOST DETECTION
|
||||
# Determines local and remote server names by comparing hostname against HOST1/HOST2.
|
||||
# Sets LOCAL_SERVER_NAME, REMOTE_SERVER_NAME, and SSH_KEY for the current run direction.
|
||||
# Both HOST1 and HOST2 must be defined in Master.conf.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
detect_hosts() {
|
||||
LOCAL_HOSTNAME="$(hostname)"
|
||||
@@ -118,41 +140,48 @@ detect_hosts() {
|
||||
|
||||
SSH_KEY="${SSH_KEYS[$LOCAL_SERVER_NAME|$REMOTE_SERVER_NAME]}"
|
||||
|
||||
[[ -z "$SSH_KEY" ]] && error "Missing SSH key mapping" && exit 1
|
||||
[[ -z "$SSH_KEY" ]] && error "Missing SSH key mapping for $LOCAL_SERVER_NAME → $REMOTE_SERVER_NAME" && exit 1
|
||||
|
||||
info "Host: $LOCAL_SERVER_NAME → $REMOTE_SERVER_NAME"
|
||||
info "$ICON_GEAR Host: $LOCAL_SERVER_NAME → $REMOTE_SERVER_NAME"
|
||||
}
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# REMOTE IP
|
||||
# REMOTE IP RESOLUTION
|
||||
# Resolves the Tailscale IPv4 address of the remote server.
|
||||
# Sets REMOTE_SERVER used by all subsequent SSH and rsync calls.
|
||||
# Exits if resolution fails — likely means Tailscale is down or peer is offline.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
resolve_remote_ip() {
|
||||
log "Resolving remote IP..."
|
||||
log "$ICON_SYNC 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 remote IP for $REMOTE_SERVER_NAME" && exit 1
|
||||
[[ -z "$REMOTE_SERVER" ]] && error "Failed to resolve Tailscale IP for $REMOTE_SERVER_NAME" && exit 1
|
||||
|
||||
info "Remote IP: $REMOTE_SERVER"
|
||||
info "$ICON_SYNC Remote IP: $REMOTE_SERVER"
|
||||
}
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# CONNECTIVITY CHECK
|
||||
# Verifies remote is reachable before attempting rsync.
|
||||
# Prevents retry loop burning all attempts against an unreachable host.
|
||||
# Pings the remote server to confirm it is reachable before starting any transfers.
|
||||
# Prevents the rsync retry loop from burning all attempts against an unreachable host.
|
||||
# If ping fails, prints a tailscale status hint to aid diagnosis before exiting.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
check_connectivity() {
|
||||
log "Checking connectivity to $REMOTE_SERVER..."
|
||||
if ! ping -c1 -W3 "$REMOTE_SERVER" &>/dev/null; then
|
||||
error "Remote $REMOTE_SERVER is unreachable — aborting"
|
||||
error "Remote $REMOTE_SERVER ($REMOTE_SERVER_NAME) is unreachable"
|
||||
info "Hint: tailscale status | grep $REMOTE_SERVER_NAME"
|
||||
exit 1
|
||||
fi
|
||||
log "Remote is reachable"
|
||||
}
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# CONTAINERS
|
||||
# CRITICAL_CONTAINER_NAMES and DELAYED_CONTAINERS must be bash arrays before calling these.
|
||||
# rsync.sh handles the read -r -a conversion from profile strings.
|
||||
# CONTAINER MANAGEMENT — STOP
|
||||
# Stops all containers listed in CRITICAL_CONTAINER_NAMES on the remote server.
|
||||
# Only stops containers that are currently running — skips those already stopped.
|
||||
# Tracks stopped containers in RUNNING_CONTAINERS for restart after rsync completes.
|
||||
# CRITICAL_CONTAINER_NAMES must be a bash array — rsync.sh handles conversion from profile strings.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
RUNNING_CONTAINERS=()
|
||||
|
||||
@@ -189,6 +218,13 @@ stop_containers() {
|
||||
done
|
||||
}
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# CONTAINER MANAGEMENT — START
|
||||
# Restarts only the containers that were running before rsync and were stopped by stop_containers.
|
||||
# Containers listed in DELAYED_CONTAINERS receive a sleep of CONTAINER_DELAY seconds before
|
||||
# starting — useful for dependencies like Authelia that need upstream services ready first.
|
||||
# DELAYED_CONTAINERS must be a bash array — rsync.sh handles conversion from profile strings.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
start_containers() {
|
||||
if [[ ${#RUNNING_CONTAINERS[@]} -eq 0 ]]; then
|
||||
log "No containers to restart."
|
||||
@@ -224,6 +260,10 @@ start_containers() {
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# RSYNC OPTIONS
|
||||
# Loads rsync options for the current profile from PROFILE_RSYNC_OPTS in Master.conf.
|
||||
# If no profile match is found, falls back to DEFAULT_RSYNC_OPTS.
|
||||
# Note: profile opts do NOT inherit from defaults — all desired flags must be listed explicitly.
|
||||
# Sets RSYNC_OPTS array used directly in the rsync call in rsync.sh.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
get_rsync_opts() {
|
||||
if [[ -n "${PROFILE_RSYNC_OPTS[$PROFILE_NAME]:-}" ]]; then
|
||||
@@ -236,7 +276,10 @@ get_rsync_opts() {
|
||||
}
|
||||
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
# STATUS
|
||||
# STATUS DISPLAY
|
||||
# Prints a summary of the current runtime configuration.
|
||||
# Triggered by --status or --summary flag passed to rsync.sh.
|
||||
# Useful for verifying profile resolution and variable state before a live run.
|
||||
# -----------------------------------------------------------------------------------------------
|
||||
show_status() {
|
||||
echo "===== STATUS ====="
|
||||
|
||||
Reference in New Issue
Block a user