Files
archie/scripts/archie-update-install
T

362 lines
17 KiB
Bash
Executable File

#!/usr/bin/env bash
# archie-update-install -- component-aware update installation adapter.
#
# CommandInstaller passes the freshly revalidated, approved snapshot through
# ARCHIE_UPDATE_{DAEMON,AGENT}_{PREVIOUS,VERSION}. A VERSION is non-empty only
# when that component changed in the approved snapshot. This script must never
# rediscover a broader plan after approval.
set -euo pipefail
json_escape() {
printf '%s' "$1" | sed 's/\\/\\\\/g; s/"/\\"/g'
}
SOURCE_URL="${ARCHIE_SOURCE_URL:-https://github.com/samcharles93/archie-core.git}"
BIN_DIR="${ARCHIE_BIN_DIR:-$HOME/.local/bin}"
CONFIG_PATH="${ARCHIE_CONFIG_PATH:-${XDG_CONFIG_HOME:-$HOME/.config}/archie/config.toml}"
export PATH="/usr/local/go/bin:$PATH"
# The worker image is daemon configuration, not an updater-specific setting.
# Honour an explicit environment override for nonstandard deployers; otherwise
# read the [containers] image from the same config archied starts with. This
# deliberately understands only that one scalar, rather than trying to parse
# general TOML in shell. The daemon remains the authority for validation.
configured_agent_image() {
local image
image="$(awk '
/^\[containers\][[:space:]]*(#.*)?$/ { in_containers = 1; next }
/^\[/ { in_containers = 0 }
in_containers && /^[[:space:]]*image[[:space:]]*=/ {
value = $0
sub(/^[[:space:]]*image[[:space:]]*=[[:space:]]*/, "", value)
sub(/[[:space:]]*(#.*)?$/, "", value)
if (value ~ /^".*"$/) {
sub(/^"/, "", value)
sub(/"$/, "", value)
print value
} else if (length(value) >= 2 && substr(value, 1, 1) == sprintf("%c", 39) && substr(value, length(value), 1) == sprintf("%c", 39)) {
print substr(value, 2, length(value) - 2)
}
exit
}
' "$CONFIG_PATH" 2>/dev/null || true)"
printf '%s' "$image"
}
AGENT_IMAGE="${ARCHIE_AGENT_IMAGE:-$(configured_agent_image)}"
AGENT_IMAGE="${AGENT_IMAGE:-ghcr.io/samcharles93/archie-agent:latest}"
AGENT_IMAGE_BACKUP="$BIN_DIR/archie-agent-image.prev.tar"
# State for the managed image, independent of archied's daemon build stamp.
AGENT_VERSION_FILE="${ARCHIE_AGENT_VERSION_FILE:-$BIN_DIR/archie-agent.version}"
AGENT_VERSION_BACKUP="${ARCHIE_AGENT_VERSION_BACKUP:-$BIN_DIR/archie-agent.version.prev}"
DB_SNAPSHOT="${ARCHIE_DB_SNAPSHOT:-$BIN_DIR/archie-db.pre-update.dump}"
# The address the daemon dials for its state, so the watchdog can wait for it to
# accept connections before it starts archied. Read with a narrow awk: the
# daemon stays the authority on validation, and this script deliberately
# understands one scalar rather than parsing TOML. Scoped to [services.state] so the Gateway's own target cannot be
# mistaken for it, and exact on the key so target_token is not.
configured_state_store_target() {
awk '
/^[[:space:]]*\[services\.state\][[:space:]]*$/ { inside = 1; next }
/^[[:space:]]*\[/ { inside = 0 }
inside && /^[[:space:]]*target[[:space:]]*=/ {
value = $0
sub(/^[[:space:]]*target[[:space:]]*=[[:space:]]*/, "", value)
sub(/[[:space:]]*(#.*)?$/, "", value)
if (value ~ /^".*"$/) { sub(/^"/, "", value); sub(/"$/, "", value); print value }
else if (length(value) >= 2 && substr(value, 1, 1) == sprintf("%c", 39) && substr(value, length(value), 1) == sprintf("%c", 39)) print substr(value, 2, length(value) - 2)
exit
}
' "$CONFIG_PATH" 2>/dev/null || true
}
STATE_STORE_TARGET="${ARCHIE_UPDATE_STATE_STORE_TARGET:-$(configured_state_store_target)}"
# The archied release is a set of processes, not one binary. Listed in start
# order: the State Store owns archie.db and every other process dials it, the
# Gateway serves the chat contract archied, the UI and the Messaging Service
# dial, and each comes up before its consumers. deployments/systemd-user-service.md is
# the reference deployment; installing archied alone leaves the rest on the
# previous release, which is why a 1.23.0 update failed its health check
# (archie-core-hbqk).
#
# archie-messaging is a service, not a CLI: it owns the Telegram, email and
# webhook channels since the v1.30.0 extraction, so a host that updates without
# it keeps running with dead channels and no error anywhere
# (archie-core-1c01). TestDistZipShipsEveryHostCommand fails if this
# list and GATEWAY_BINARIES stop covering the commands the release zip ships.
GATEWAY_SERVICES="archie-state-store archie-gateway archied archie-ui archie-messaging"
GATEWAY_BINARIES="$GATEWAY_SERVICES"
PREV_GW="${ARCHIE_UPDATE_DAEMON_PREVIOUS:-}"
PREV_RT="${ARCHIE_UPDATE_AGENT_PREVIOUS:-}"
GW_TARGET="${ARCHIE_UPDATE_DAEMON_VERSION:-}"
RT_TARGET="${ARCHIE_UPDATE_AGENT_VERSION:-}"
GW="$PREV_GW"
RT="$PREV_RT"
components=""
if [ -n "$GW_TARGET" ] && [ "$GW_TARGET" != "$PREV_GW" ]; then
GW="$GW_TARGET"
components="daemon"
fi
if [ -n "$RT_TARGET" ] && [ "$RT_TARGET" != "$PREV_RT" ]; then
case "$RT_TARGET" in
dev|unknown) echo "refusing to build a released runtime image with version '$RT_TARGET'" >&2; exit 1 ;;
esac
RT="$RT_TARGET"
components="${components:+$components,}agent"
fi
# Per-binary skew is a different question from the unit set, and the one the
# updater could not answer (archie-core-k94o): it is component-driven, so a host
# whose individual binaries disagree -- a hand-installed outlier beside an
# otherwise current install -- looks healthy, because "no approved component
# changes" short-circuits before any binary is read. Ask every installed binary
# what it is and refuse, named, rather than reporting the install current.
verify_installed_versions() {
reference="$1"
problems=""
for cmd in $GATEWAY_BINARIES; do
[ -f "$BIN_DIR/$cmd" ] || continue
reported="$("$BIN_DIR/$cmd" -version 2>/dev/null | awk -v want="$cmd" '$1 == want { print $2; exit }')"
[ -n "$reported" ] || reported="unknown"
if [ "$reported" != "$reference" ]; then
problems="${problems:+$problems }$cmd=$reported"
fi
done
if [ -n "$problems" ]; then
echo "refusing: installed binaries disagree with $reference: $problems" >&2
echo "each host binary must report the release it was built from; reinstall the outliers from archied/v$reference, or approve an update that rebuilds them" >&2
return 1
fi
}
if [ -z "$components" ]; then
reference="$PREV_GW"
if [ -z "$reference" ]; then
reference="$("$BIN_DIR/archied" -version 2>/dev/null | awk '$1 == "archied" { print $2; exit }')"
fi
if [ -n "$reference" ] && ! verify_installed_versions "$reference"; then
exit 1
fi
echo '==> no approved component changes; nothing to install'
echo 'ARCHIE_UPDATE_RESULT {"previous":{},"installed":{},"components":[],"restart_requested":false}'
exit 0
fi
valid_release_version() {
[[ "$1" =~ ^[0-9]+\.[0-9]+\.[0-9]+([+-][0-9A-Za-z.-]+)?$ ]]
}
for target in "$GW_TARGET" "$RT_TARGET"; do
if [ -n "$target" ] && ! valid_release_version "$target"; then
echo "refusing non-release component version '$target'" >&2
exit 1
fi
done
tmp="$(mktemp -d)"
source_dir="$tmp/source"
trap 'rm -rf "$tmp"' EXIT
echo "==> fetching approved component releases"
# Updates are independent of the agent/operator checkout. Fetch into an
# invocation-scoped clone, resolve the approved tags there, and build the
# installed binary from that isolated source tree.
git clone --quiet --filter=blob:none --no-checkout "$SOURCE_URL" "$source_dir"
git -C "$source_dir" fetch --quiet --tags origin
# Build from the exact approved release commit, not the moving branch tip.
# Resolve each changed component's tag commit independently: components are
# independently versioned (RELEASING.md), so the daemon and agent tags usually
# sit on different commits -- most releases are gateway-only. The first
# checkout is the daemon release when one is being installed, because the
# adapter refresh below reads the scripts of the release being installed; the
# agent image is rebuilt from its own tag's commit further down.
gw_commit=""
rt_commit=""
if [[ ",$components," == *,daemon,* ]]; then
gw_commit="$(git -C "$source_dir" rev-parse --verify "refs/tags/archied/v$GW^{commit}")"
fi
if [[ ",$components," == *,agent,* ]]; then
rt_commit="$(git -C "$source_dir" rev-parse --verify "refs/tags/archied/v$RT^{commit}")"
fi
build_commit="$gw_commit"
[ -n "$build_commit" ] || build_commit="$rt_commit"
git -C "$source_dir" checkout --quiet --detach "$build_commit"
cd "$source_dir"
# Refuse before touching anything if the release runs processes this host has
# no unit for. Installing the binaries anyway would leave archied dialling a
# State Store that nothing starts: it fails its health check and rolls back,
# which reads as a broken release rather than an incomplete deployment.
if [[ ",$components," == *,daemon,* ]]; then
missing_units=""
for svc in $GATEWAY_SERVICES; do
[ -d "$source_dir/cmd/$svc" ] || continue
if ! systemctl --user list-unit-files "$svc.service" --no-legend 2>/dev/null | grep -q .; then
missing_units="${missing_units:+$missing_units }$svc.service"
fi
done
if [ -n "$missing_units" ]; then
echo "refusing to install archied $GW: it runs as separate processes and this host has no unit for: $missing_units" >&2
echo "create them from deployments/systemd-user-service.md, then retry the update" >&2
exit 1
fi
# The other direction, and the one archie-core-1faq actually was: a unit this
# host runs that GATEWAY_SERVICES does not name is never backed up, built,
# installed or restarted, so it keeps running the previous release while
# everything else moves. The installed updater is refreshed only after an
# update proceeds, so a stale list cannot repair itself -- refuse and name
# what it left out rather than completing a partial update and reporting
# success.
unmanaged_units=""
for dir in "$source_dir"/cmd/*/; do
[ -d "$dir" ] || continue
svc="$(basename "$dir")"
case " $GATEWAY_SERVICES " in
*" $svc "*) continue ;;
esac
if systemctl --user list-unit-files "$svc.service" --no-legend 2>/dev/null | grep -q .; then
unmanaged_units="${unmanaged_units:+$unmanaged_units }$svc.service"
fi
done
if [ -n "$unmanaged_units" ]; then
echo "refusing to install archied $GW: this host runs units the update does not manage: $unmanaged_units" >&2
echo "a current install.sh writes units for: $GATEWAY_SERVICES. If the installed updater predates this release, replace $BIN_DIR/archie-update-install with scripts/archie-update-install from archied/v$GW; otherwise remove the extra unit, or add it to GATEWAY_SERVICES if this host is meant to run it." >&2
exit 1
fi
fi
# The pre-migration snapshot of the PostgreSQL database: the whole database,
# since every service shares it. The new State Store migrates on start and a
# migration is never undone automatically (goose Down drops tables), so this
# snapshot is the only way back, restored by an operator with every service
# stopped. The recovery subcommand resolves database_url from the same config
# the services boot with, so the connection string never passes through this
# script. No snapshot, no update: this pre-flight runs before any write to the
# host, so a refusal changes nothing at all.
if [[ ",$components," == *,daemon,* ]]; then
echo "==> snapshotting the database before the update migrates it"
mkdir -p "$(dirname "$DB_SNAPSHOT")"
if ! go run ./cmd/archie-state-store backup -config "$CONFIG_PATH" -out "$DB_SNAPSHOT"; then
echo "refusing to install $GW: could not snapshot the database named by $CONFIG_PATH, so a failed migration could not be recovered" >&2
exit 1
fi
fi
# Refresh adapters from the approved release source. The running shell
# continues with this copy; subsequent updates use the current contract.
install -m755 "$source_dir/scripts/archie-update-install" "$BIN_DIR/archie-update-install"
install -m755 "$source_dir/scripts/archie-update-watchdog" "$BIN_DIR/archie-update-watchdog"
install -m755 "$source_dir/scripts/archie-update-check" "$BIN_DIR/archie-update-check"
# built accumulates only the binaries this release actually ships, so an
# update to a release predating one of these processes stays buildable.
built=""
if [[ ",$components," == *,daemon,* ]]; then
ldflags="-X github.com/samcharles93/archie-core/internal/installtype.buildType=binary"
# The updater is a build site too: without this stamp its own outputs would
# report "dev" and fail the skew check it just installed.
ldflags="$ldflags -X github.com/samcharles93/archie-core/internal/buildinfo.Version=$GW"
ldflags="$ldflags -X github.com/samcharles93/archie-core/internal/buildinfo.Runtime=$RT"
for cmd in $GATEWAY_BINARIES; do
[ -d "./cmd/$cmd" ] || continue
echo "==> building $cmd $GW"
go build -ldflags "$ldflags" -o "$tmp/$cmd" "./cmd/$cmd"
built="${built:+$built }$cmd"
done
echo "==> backing up current binaries"
for cmd in $built; do
if [ -f "$BIN_DIR/$cmd" ]; then
cp -f "$BIN_DIR/$cmd" "$BIN_DIR/$cmd.prev"
else
# New in this release: record that there was nothing here, so a
# rollback removes it instead of leaving a stray binary behind.
rm -f "$BIN_DIR/$cmd.prev"
fi
done
echo "==> installing $built"
for cmd in $built; do
install -m755 "$tmp/$cmd" "$BIN_DIR/$cmd"
done
# Every installed binary must now report the release just installed; a binary
# this release did not rebuild is skew, not success.
if ! verify_installed_versions "$GW"; then
exit 1
fi
fi
if [[ ",$components," == *,agent,* ]]; then
# Independent versioning: the agent tag usually points at a different
# commit than the daemon's, so switch back to it for the image build (a
# no-op checkout for an agent-only update, which never left this commit).
git checkout --quiet --detach "$rt_commit"
echo "==> saving managed worker image $AGENT_IMAGE for rollback"
docker image save --output "$AGENT_IMAGE_BACKUP" "$AGENT_IMAGE"
# Save explicit sidecar state, including the first-install (absent) case,
# before changing it. The watchdog restores this alongside the image.
if [ -f "$AGENT_VERSION_FILE" ]; then
cp -f "$AGENT_VERSION_FILE" "$AGENT_VERSION_BACKUP"
AGENT_VERSION_PREVIOUS_EXISTS=1
else
rm -f "$AGENT_VERSION_BACKUP"
AGENT_VERSION_PREVIOUS_EXISTS=0
fi
echo "==> rebuilding managed worker image $AGENT_IMAGE for runtime $RT"
docker build --build-arg "RUNTIME_VERSION=$RT" --tag "$AGENT_IMAGE" .
# Only record a version after the image build succeeds. Write beside the
# state atomically so the check never observes a partial version.
version_tmp="$(mktemp "$AGENT_VERSION_FILE.tmp.XXXXXX")"
printf '%s\n' "$RT" > "$version_tmp"
chmod 600 "$version_tmp"
mv -f "$version_tmp" "$AGENT_VERSION_FILE"
fi
echo "==> handing off to the update watchdog for restart and health verification"
systemd-run --user --unit=archied-update-restart --collect --quiet \
--setenv=ARCHIE_BIN_DIR="$BIN_DIR" \
--setenv=ARCHIE_HEALTH_URL="${ARCHIE_HEALTH_URL:-}" \
--setenv=ARCHIE_UPDATE_REPORT_PATH="${ARCHIE_UPDATE_REPORT_PATH:-}" \
--setenv=ARCHIE_UPDATE_CHANNEL="${ARCHIE_UPDATE_CHANNEL:-}" \
--setenv=ARCHIE_UPDATE_CHAT_ID="${ARCHIE_UPDATE_CHAT_ID:-0}" \
--setenv=ARCHIE_UPDATE_THREAD_ID="${ARCHIE_UPDATE_THREAD_ID:-0}" \
--setenv=ARCHIE_UPDATE_COMPONENTS="$components" \
--setenv=ARCHIE_UPDATE_UNITS="$GATEWAY_SERVICES" \
--setenv=ARCHIE_UPDATE_BINARIES="$built" \
--setenv=ARCHIE_UPDATE_PREVIOUS_GATEWAY="$PREV_GW" \
--setenv=ARCHIE_UPDATE_PREVIOUS_RUNTIME="$PREV_RT" \
--setenv=ARCHIE_UPDATE_INSTALLED_GATEWAY="$GW" \
--setenv=ARCHIE_UPDATE_INSTALLED_RUNTIME="$RT" \
--setenv=ARCHIE_AGENT_IMAGE="$AGENT_IMAGE" \
--setenv=ARCHIE_AGENT_IMAGE_BACKUP="$AGENT_IMAGE_BACKUP" \
--setenv=ARCHIE_AGENT_VERSION_FILE="$AGENT_VERSION_FILE" \
--setenv=ARCHIE_AGENT_VERSION_BACKUP="$AGENT_VERSION_BACKUP" \
--setenv=ARCHIE_AGENT_VERSION_PREVIOUS_EXISTS="${AGENT_VERSION_PREVIOUS_EXISTS:-0}" \
--setenv=ARCHIE_DB_SNAPSHOT="$DB_SNAPSHOT" \
--setenv=ARCHIE_CONFIG_PATH="$CONFIG_PATH" \
--setenv=ARCHIE_UPDATE_STATE_STORE_TARGET="$STATE_STORE_TARGET" \
"$BIN_DIR/archie-update-watchdog"
case "$components" in
daemon)
previous="{\"daemon\":\"$(json_escape "$PREV_GW")\"}"
installed="{\"daemon\":\"$(json_escape "$GW")\"}"
results='[{"id":"daemon","label":"daemon","status":"updated"}]'
;;
agent)
previous="{\"agent\":\"$(json_escape "$PREV_RT")\"}"
installed="{\"agent\":\"$(json_escape "$RT")\"}"
results='[{"id":"agent","label":"agent","status":"updated"}]'
;;
daemon,agent)
previous="{\"daemon\":\"$(json_escape "$PREV_GW")\",\"agent\":\"$(json_escape "$PREV_RT")\"}"
installed="{\"daemon\":\"$(json_escape "$GW")\",\"agent\":\"$(json_escape "$RT")\"}"
results='[{"id":"daemon","label":"daemon","status":"updated"},{"id":"agent","label":"agent","status":"updated"}]'
;;
esac
echo "ARCHIE_UPDATE_RESULT {\"previous\":$previous,\"installed\":$installed,\"components\":$results,\"restart_requested\":true}"