feat(install): polish install UX with banner, spinner, progress bar, summary
Wrap the three install scripts in a shared inline style block (TTY/UTF-8/ NO_COLOR-aware) so the one-liner install looks and feels intentional: banner on start, timed step lines, braille spinner over silent apt/ systemctl calls with failure log dumps, single-line curl progress bars with size-prefixed headers, and a summary box at the end with live-image version + service state + next steps. install.sh defers banner/summary to proxmox-install.sh when VETTING_INSTALL_WRAPPED is set so the two scripts compose without duplication. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
+210
-52
@@ -28,6 +28,172 @@
|
||||
# --force overwrite a customised pxe: block
|
||||
set -euo pipefail
|
||||
|
||||
# ---- style helpers -----------------------------------------------------
|
||||
# Identical block across proxmox-install.sh, install.sh, pxe-setup.sh.
|
||||
# Inlined (not sourced) so the curl|bash entrypoint renders without a
|
||||
# prior fetch. Respects NO_COLOR, non-TTY, and non-UTF-8 locales.
|
||||
_color=0; _unicode=0
|
||||
if [[ -t 2 && -z "${NO_COLOR:-}" && "${TERM:-dumb}" != "dumb" ]]; then
|
||||
_color=1
|
||||
fi
|
||||
case "${LC_ALL:-}${LANG:-}" in
|
||||
*UTF-8*|*utf8*|*UTF8*) _unicode=1 ;;
|
||||
esac
|
||||
if (( _color )); then
|
||||
_B=$'\033[1m'; _D=$'\033[2m'; _R=$'\033[0m'
|
||||
_C=$'\033[1;36m'; _G=$'\033[32m'; _Y=$'\033[33m'; _E=$'\033[31m'
|
||||
else
|
||||
_B=""; _D=""; _R=""; _C=""; _G=""; _Y=""; _E=""
|
||||
fi
|
||||
if (( _unicode )); then
|
||||
_S_STEP="▸"; _S_OK="✓"; _S_WARN="⚠"; _S_FAIL="✗"; _S_INFO="·"
|
||||
_B_TL="╭"; _B_TR="╮"; _B_BL="╰"; _B_BR="╯"; _B_H="─"; _B_V="│"
|
||||
else
|
||||
_S_STEP="-->"; _S_OK="[ok]"; _S_WARN="[!]"; _S_FAIL="[x]"; _S_INFO="*"
|
||||
_B_TL="+"; _B_TR="+"; _B_BL="+"; _B_BR="+"; _B_H="-"; _B_V="|"
|
||||
fi
|
||||
_start_epoch="$(date +%s)"; _step_epoch=""; _quiet_log=""; _spin_pid=""
|
||||
_fmt_dur() {
|
||||
local s=$1
|
||||
if (( s < 60 )); then printf '%ds' "$s"
|
||||
elif (( s < 3600 )); then printf '%dm %ds' "$((s/60))" "$((s%60))"
|
||||
else printf '%dh %dm' "$((s/3600))" "$(((s%3600)/60))"
|
||||
fi
|
||||
}
|
||||
banner() {
|
||||
local inner=" $1 " w line="" i=0
|
||||
w=${#inner}
|
||||
while (( i < w )); do line+="${_B_H}"; i=$((i+1)); done
|
||||
printf '\n %s%s%s%s%s\n' "${_C}" "${_B_TL}" "${line}" "${_B_TR}" "${_R}" >&2
|
||||
printf ' %s%s%s%s%s%s%s%s%s\n' "${_C}" "${_B_V}" "${_R}" "${_B}" "${inner}" "${_R}" "${_C}" "${_B_V}" "${_R}" >&2
|
||||
printf ' %s%s%s%s%s\n\n' "${_C}" "${_B_BL}" "${line}" "${_B_BR}" "${_R}" >&2
|
||||
}
|
||||
step() {
|
||||
_step_epoch="$(date +%s)"
|
||||
printf '%s%s%s %s%s%s\n' "${_C}" "${_S_STEP}" "${_R}" "${_B}" "$1" "${_R}" >&2
|
||||
}
|
||||
ok() {
|
||||
local tail=""
|
||||
if [[ -n "${_step_epoch}" ]]; then
|
||||
tail=" ${_D}($(_fmt_dur $(( $(date +%s) - _step_epoch ))))${_R}"
|
||||
fi
|
||||
printf ' %s%s%s %s%s\n' "${_G}" "${_S_OK}" "${_R}" "$1" "${tail}" >&2
|
||||
_step_epoch=""
|
||||
}
|
||||
info() { printf ' %s%s %s%s\n' "${_D}" "${_S_INFO}" "$1" "${_R}" >&2; }
|
||||
warn() { printf ' %s%s %s%s\n' "${_Y}" "${_S_WARN}" "$1" "${_R}" >&2; }
|
||||
die() {
|
||||
printf '\n%s%s %s%s\n' "${_E}" "${_S_FAIL}" "$1" "${_R}" >&2
|
||||
if [[ -n "${_quiet_log:-}" && -s "${_quiet_log}" ]]; then
|
||||
printf ' %s── last 40 lines of output ──%s\n' "${_D}" "${_R}" >&2
|
||||
tail -n 40 "${_quiet_log}" | sed 's/^/ /' >&2
|
||||
printf ' %sfull log: %s%s\n' "${_D}" "${_quiet_log}" "${_R}" >&2
|
||||
fi
|
||||
exit 1
|
||||
}
|
||||
_SPIN=("⠋" "⠙" "⠹" "⠸" "⠼" "⠴" "⠦" "⠧" "⠇" "⠏")
|
||||
_start_spin() {
|
||||
(( _color && _unicode )) || return 0
|
||||
local label="$1"
|
||||
(
|
||||
local i=0
|
||||
while :; do
|
||||
printf '\r %s%s%s %s ' "${_C}" "${_SPIN[i]}" "${_R}" "${label}" >&2
|
||||
i=$(( (i+1) % ${#_SPIN[@]} ))
|
||||
sleep 0.1
|
||||
done
|
||||
) &
|
||||
_spin_pid=$!
|
||||
}
|
||||
_stop_spin() {
|
||||
[[ -n "${_spin_pid}" ]] || return 0
|
||||
kill "${_spin_pid}" 2>/dev/null || true
|
||||
wait "${_spin_pid}" 2>/dev/null || true
|
||||
_spin_pid=""
|
||||
printf '\r\033[2K' >&2
|
||||
}
|
||||
# run_quiet "<label>" -- <cmd ...>
|
||||
run_quiet() {
|
||||
local label="$1"; shift
|
||||
[[ "${1:-}" == "--" ]] && shift
|
||||
local log start rc=0
|
||||
log="$(mktemp -t vetting-install.XXXXXX)"
|
||||
_quiet_log="${log}"
|
||||
start="$(date +%s)"
|
||||
_start_spin "${label}"
|
||||
"$@" >"${log}" 2>&1 || rc=$?
|
||||
_stop_spin
|
||||
local dt=$(( $(date +%s) - start ))
|
||||
if (( rc == 0 )); then
|
||||
printf ' %s%s%s %s %s(%s)%s\n' "${_G}" "${_S_OK}" "${_R}" "${label}" "${_D}" "$(_fmt_dur "$dt")" "${_R}" >&2
|
||||
rm -f "${log}"; _quiet_log=""
|
||||
return 0
|
||||
fi
|
||||
printf ' %s%s %s failed (exit %d)%s\n' "${_E}" "${_S_FAIL}" "${label}" "${rc}" "${_R}" >&2
|
||||
printf ' %s── last 40 lines of output ──%s\n' "${_D}" "${_R}" >&2
|
||||
tail -n 40 "${log}" | sed 's/^/ /' >&2
|
||||
printf ' %sfull log: %s%s\n' "${_D}" "${log}" "${_R}" >&2
|
||||
exit "${rc}"
|
||||
}
|
||||
# curl_pretty --label LABEL --url URL -- [extra curl args, including -o PATH]
|
||||
curl_pretty() {
|
||||
local label="download" url=""
|
||||
local args=()
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--label) label="$2"; shift 2 ;;
|
||||
--url) url="$2"; args+=("$2"); shift 2 ;;
|
||||
--) shift; args+=("$@"); break ;;
|
||||
*) args+=("$1"); shift ;;
|
||||
esac
|
||||
done
|
||||
local size_str=""
|
||||
if [[ -n "${url}" ]]; then
|
||||
local size_bytes
|
||||
size_bytes="$(curl -fsSLI --max-time 5 "${url}" 2>/dev/null \
|
||||
| awk 'tolower($1) ~ /^content-length:/ {print $2}' \
|
||||
| tr -d '\r' | tail -n1)"
|
||||
if [[ "${size_bytes}" =~ ^[0-9]+$ ]]; then
|
||||
local human
|
||||
human="$(numfmt --to=iec --suffix=B --format='%.1f' "${size_bytes}" 2>/dev/null || echo "${size_bytes}B")"
|
||||
size_str=" ${_D}(${human})${_R}"
|
||||
fi
|
||||
fi
|
||||
printf '%s%s%s %sdownloading %s%s%s\n' "${_C}" "${_S_STEP}" "${_R}" "${_B}" "${label}" "${_R}" "${size_str}" >&2
|
||||
local start rc=0
|
||||
start="$(date +%s)"
|
||||
if [[ -t 2 ]]; then
|
||||
curl -fL --progress-bar "${args[@]}" || rc=$?
|
||||
else
|
||||
curl -fsSL "${args[@]}" || rc=$?
|
||||
fi
|
||||
local dt=$(( $(date +%s) - start ))
|
||||
if (( rc == 0 )); then
|
||||
printf ' %s%s%s %s ready %s(%s)%s\n' "${_G}" "${_S_OK}" "${_R}" "${label}" "${_D}" "$(_fmt_dur "$dt")" "${_R}" >&2
|
||||
return 0
|
||||
fi
|
||||
printf ' %s%s %s download failed (exit %d)%s\n' "${_E}" "${_S_FAIL}" "${label}" "${rc}" "${_R}" >&2
|
||||
exit "${rc}"
|
||||
}
|
||||
rule_open() {
|
||||
local title="$1"
|
||||
local dashes=$(( 46 - ${#title} - 4 ))
|
||||
local tail="" i=0
|
||||
(( dashes < 2 )) && dashes=2
|
||||
while (( i < dashes )); do tail+="${_B_H}"; i=$((i+1)); done
|
||||
printf '\n%s%s%s %s %s%s\n' "${_C}" "${_B_TL}" "${_B_H}" "${title}" "${tail}" "${_R}" >&2
|
||||
}
|
||||
rule_close() {
|
||||
local line="" i=0
|
||||
while (( i < 46 )); do line+="${_B_H}"; i=$((i+1)); done
|
||||
printf '%s%s%s%s\n' "${_C}" "${_B_BL}" "${line:1}" "${_R}" >&2
|
||||
}
|
||||
total_elapsed() {
|
||||
local dt=$(( $(date +%s) - _start_epoch ))
|
||||
printf '%sinstalled in %s%s\n\n' "${_D}" "$(_fmt_dur "$dt")" "${_R}" >&2
|
||||
}
|
||||
# ---- end style helpers -------------------------------------------------
|
||||
|
||||
INTERFACE=""
|
||||
SUBNET=""
|
||||
ORCH_URL=""
|
||||
@@ -63,37 +229,33 @@ while [[ $# -gt 0 ]]; do
|
||||
done
|
||||
|
||||
if [[ $EUID -ne 0 ]]; then
|
||||
echo "pxe-setup.sh must be run as root (try: sudo $0 ...)" >&2
|
||||
exit 1
|
||||
die "pxe-setup.sh must be run as root (try: sudo $0 ...)"
|
||||
fi
|
||||
|
||||
[[ -z "${INTERFACE}" ]] && { echo "ERROR: --interface is required" >&2; exit 2; }
|
||||
[[ -z "${SUBNET}" ]] && { echo "ERROR: --subnet is required (e.g. 192.168.1.0/24)" >&2; exit 2; }
|
||||
[[ -z "${ORCH_URL}" ]] && { echo "ERROR: --orchestrator-url is required" >&2; exit 2; }
|
||||
[[ -z "${INTERFACE}" ]] && die "--interface is required"
|
||||
[[ -z "${SUBNET}" ]] && die "--subnet is required (e.g. 192.168.1.0/24)"
|
||||
[[ -z "${ORCH_URL}" ]] && die "--orchestrator-url is required"
|
||||
|
||||
banner "TheWrightServer · Vetting · PXE"
|
||||
|
||||
# --- sanity checks -----------------------------------------------------
|
||||
|
||||
if ! ip link show "${INTERFACE}" >/dev/null 2>&1; then
|
||||
echo "ERROR: interface ${INTERFACE} not found on host. Check \`ip link\` — the" >&2
|
||||
echo " interface must exist *before* the orchestrator starts dnsmasq." >&2
|
||||
exit 1
|
||||
die "interface ${INTERFACE} not found on host. Check \`ip link\` — the interface must exist *before* the orchestrator starts dnsmasq."
|
||||
fi
|
||||
|
||||
# CIDR shape check — dnsmasq will re-validate, but catch the obvious
|
||||
# errors before we write anything to disk.
|
||||
if [[ ! "${SUBNET}" =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$ ]]; then
|
||||
echo "ERROR: --subnet must be CIDR form (e.g. 192.168.1.0/24), got '${SUBNET}'" >&2
|
||||
exit 2
|
||||
die "--subnet must be CIDR form (e.g. 192.168.1.0/24), got '${SUBNET}'"
|
||||
fi
|
||||
|
||||
if [[ ! -f "${CONFIG}" ]]; then
|
||||
echo "ERROR: ${CONFIG} not found — run deploy/install.sh first." >&2
|
||||
exit 1
|
||||
die "${CONFIG} not found — run deploy/install.sh first."
|
||||
fi
|
||||
|
||||
if ! id -u "${SERVICE_USER}" >/dev/null 2>&1; then
|
||||
echo "ERROR: ${SERVICE_USER} user not found — run deploy/install.sh first." >&2
|
||||
exit 1
|
||||
die "${SERVICE_USER} user not found — run deploy/install.sh first."
|
||||
fi
|
||||
|
||||
# Resolve the bundle dir. When pxe-setup.sh is run from a release
|
||||
@@ -101,16 +263,11 @@ fi
|
||||
# run from the repo tree it's deploy/pxe-setup.sh and the live image is
|
||||
# under live-image/build/. Detect both.
|
||||
if [[ -z "${BUNDLE_DIR}" ]]; then
|
||||
if [[ -f "${SCRIPT_DIR}/ipxe-shas.txt" ]]; then
|
||||
BUNDLE_DIR="${SCRIPT_DIR}"
|
||||
else
|
||||
BUNDLE_DIR="${SCRIPT_DIR}"
|
||||
fi
|
||||
BUNDLE_DIR="${SCRIPT_DIR}"
|
||||
fi
|
||||
SHAS_FILE="${BUNDLE_DIR}/ipxe-shas.txt"
|
||||
if [[ ! -f "${SHAS_FILE}" ]]; then
|
||||
echo "ERROR: ${SHAS_FILE} not found — bundle is incomplete." >&2
|
||||
exit 1
|
||||
die "${SHAS_FILE} not found — bundle is incomplete."
|
||||
fi
|
||||
|
||||
# --- iPXE binaries: stage, verify, install ----------------------------
|
||||
@@ -120,8 +277,9 @@ fi
|
||||
# install(1) unlink-replaces, which avoids ETXTBSY and makes the whole
|
||||
# operation atomic per file.
|
||||
|
||||
echo "==> ensuring ${TFTP_ROOT} exists"
|
||||
step "ensuring ${TFTP_ROOT} exists"
|
||||
install -d -m 0755 -o "${SERVICE_USER}" -g "${SERVICE_USER}" "${TFTP_ROOT}"
|
||||
info "tftp root: ${TFTP_ROOT}"
|
||||
|
||||
STAGE="$(mktemp -d)"
|
||||
trap 'rm -rf "${STAGE}"' EXIT
|
||||
@@ -138,30 +296,28 @@ done
|
||||
# we skip the fetch entirely; if not, re-download.
|
||||
if (( ! need_fetch )); then
|
||||
if ! ( cd "${TFTP_ROOT}" && sha256sum -c --status "${SHAS_FILE}" ); then
|
||||
echo "==> ${TFTP_ROOT} iPXE binaries don't match pinned SHAs — re-fetching"
|
||||
info "iPXE binaries in ${TFTP_ROOT} don't match pinned SHAs — re-fetching"
|
||||
need_fetch=1
|
||||
else
|
||||
echo "==> iPXE binaries already match pins — skipping fetch"
|
||||
info "iPXE binaries already match pins — skipping fetch"
|
||||
fi
|
||||
fi
|
||||
|
||||
if (( need_fetch )); then
|
||||
echo "==> fetching iPXE binaries from boot.ipxe.org"
|
||||
curl -fsSLo "${STAGE}/ipxe.efi" "https://boot.ipxe.org/x86_64-efi/ipxe.efi"
|
||||
curl -fsSLo "${STAGE}/undionly.kpxe" "https://boot.ipxe.org/undionly.kpxe"
|
||||
step "fetching iPXE binaries from boot.ipxe.org"
|
||||
curl_pretty --label "ipxe.efi" --url "https://boot.ipxe.org/x86_64-efi/ipxe.efi" -- -o "${STAGE}/ipxe.efi"
|
||||
curl_pretty --label "undionly.kpxe" --url "https://boot.ipxe.org/undionly.kpxe" -- -o "${STAGE}/undionly.kpxe"
|
||||
|
||||
echo "==> verifying SHA256 against ${SHAS_FILE}"
|
||||
if ! ( cd "${STAGE}" && sha256sum -c "${SHAS_FILE}" ); then
|
||||
echo "ERROR: iPXE SHA256 mismatch. Upstream binaries changed, or a MITM." >&2
|
||||
echo " To accept the new binaries, regenerate ${SHAS_FILE} after" >&2
|
||||
echo " independently verifying the new checksums, then re-run." >&2
|
||||
exit 1
|
||||
step "verifying SHA256 against ${SHAS_FILE}"
|
||||
if ! run_quiet "sha256sum -c" -- bash -c "cd '${STAGE}' && sha256sum -c '${SHAS_FILE}'"; then
|
||||
die "iPXE SHA256 mismatch. Upstream binaries changed, or a MITM. To accept the new binaries, regenerate ${SHAS_FILE} after independently verifying the new checksums, then re-run."
|
||||
fi
|
||||
|
||||
install -m 0644 -o "${SERVICE_USER}" -g "${SERVICE_USER}" \
|
||||
"${STAGE}/ipxe.efi" "${TFTP_ROOT}/ipxe.efi"
|
||||
install -m 0644 -o "${SERVICE_USER}" -g "${SERVICE_USER}" \
|
||||
"${STAGE}/undionly.kpxe" "${TFTP_ROOT}/undionly.kpxe"
|
||||
ok "iPXE binaries staged into ${TFTP_ROOT}"
|
||||
fi
|
||||
|
||||
# --- live image: copy from bundle into live_dir -----------------------
|
||||
@@ -183,20 +339,19 @@ if [[ -z "${LIVE_SRC}" ]]; then
|
||||
# the one-liner install, so a missing bundle/live-image/ is expected
|
||||
# when pxe-setup.sh is run from /usr/local/sbin.
|
||||
if [[ -f "${LIVE_DIR}/vmlinuz" && -f "${LIVE_DIR}/initrd.img" ]]; then
|
||||
echo "==> live image already staged in ${LIVE_DIR} (from install.sh)"
|
||||
info "live image already staged in ${LIVE_DIR} (from install.sh)"
|
||||
else
|
||||
echo "WARN: no live image found under ${BUNDLE_DIR}/live-image," >&2
|
||||
echo " ${BUNDLE_DIR}/../live-image/build, or ${LIVE_DIR}." >&2
|
||||
echo " The orchestrator will fail PXE startup validation until" >&2
|
||||
echo " vmlinuz + initrd.img land in ${LIVE_DIR}." >&2
|
||||
warn "no live image found under ${BUNDLE_DIR}/live-image, ${BUNDLE_DIR}/../live-image/build, or ${LIVE_DIR}."
|
||||
warn "the orchestrator will fail PXE startup validation until vmlinuz + initrd.img land in ${LIVE_DIR}."
|
||||
fi
|
||||
else
|
||||
echo "==> staging live image from ${LIVE_SRC} into ${LIVE_DIR}"
|
||||
step "staging live image from ${LIVE_SRC}"
|
||||
install -d -m 0755 -o "${SERVICE_USER}" -g "${SERVICE_USER}" "${LIVE_DIR}"
|
||||
install -m 0644 -o "${SERVICE_USER}" -g "${SERVICE_USER}" \
|
||||
"${LIVE_SRC}/vmlinuz" "${LIVE_DIR}/vmlinuz"
|
||||
install -m 0644 -o "${SERVICE_USER}" -g "${SERVICE_USER}" \
|
||||
"${LIVE_SRC}/initrd.img" "${LIVE_DIR}/initrd.img"
|
||||
ok "live image staged into ${LIVE_DIR}"
|
||||
fi
|
||||
|
||||
# --- patch the pxe: block in vetting.yaml -----------------------------
|
||||
@@ -243,16 +398,13 @@ existing_iface="$(extract_yaml_value interface "${CONFIG}")"
|
||||
existing_subnet="$(extract_yaml_value subnet "${CONFIG}")"
|
||||
|
||||
if [[ -n "${existing_iface}" && "${existing_iface}" != "${INTERFACE}" && ${FORCE} -eq 0 ]]; then
|
||||
echo "ERROR: pxe.interface in ${CONFIG} is already set to ${existing_iface}, which" >&2
|
||||
echo " differs from --interface ${INTERFACE}. Pass --force to overwrite." >&2
|
||||
exit 1
|
||||
die "pxe.interface in ${CONFIG} is already set to ${existing_iface}, which differs from --interface ${INTERFACE}. Pass --force to overwrite."
|
||||
fi
|
||||
if [[ -n "${existing_subnet}" && "${existing_subnet}" != "${SUBNET}" && ${FORCE} -eq 0 ]]; then
|
||||
echo "ERROR: pxe.subnet in ${CONFIG} is already ${existing_subnet}, which" >&2
|
||||
echo " differs from --subnet ${SUBNET}. Pass --force to overwrite." >&2
|
||||
exit 1
|
||||
die "pxe.subnet in ${CONFIG} is already ${existing_subnet}, which differs from --subnet ${SUBNET}. Pass --force to overwrite."
|
||||
fi
|
||||
|
||||
step "patching pxe: block in ${CONFIG}"
|
||||
new_block=$(cat <<EOF
|
||||
pxe:
|
||||
enabled: true
|
||||
@@ -286,11 +438,17 @@ orig_owner="$(stat -c '%U:%G' "${CONFIG}")"
|
||||
install -m "${orig_mode}" -o "${orig_owner%:*}" -g "${orig_owner#*:}" \
|
||||
"${tmp_yaml}" "${CONFIG}"
|
||||
rm -f "${tmp_yaml}"
|
||||
ok "pxe: block written"
|
||||
|
||||
echo
|
||||
echo "==> rendered pxe: block in ${CONFIG}:"
|
||||
echo "${new_block}" | sed 's/^/ /'
|
||||
echo
|
||||
echo "Next: systemctl restart vetting && journalctl -fu vetting"
|
||||
echo "The orchestrator will refuse to start with clear errors if anything"
|
||||
echo "is still missing; you should see dnsmasq come up cleanly."
|
||||
rule_open "pxe configured"
|
||||
while IFS= read -r ln; do
|
||||
info "${ln}"
|
||||
done <<<"${new_block}"
|
||||
printf '\n' >&2
|
||||
info "next:"
|
||||
info " systemctl restart vetting"
|
||||
info " journalctl -fu vetting"
|
||||
info "the orchestrator refuses to start with clear errors if anything is still missing;"
|
||||
info "you should see dnsmasq come up cleanly."
|
||||
rule_close
|
||||
total_elapsed
|
||||
|
||||
Reference in New Issue
Block a user