vela 0.10.2 → 0.10.3

package/templates/server/provision.sh

@@ -0,0 +1,153 @@
+#!/usr/bin/env bash
+#
+# Prepare a stock Ubuntu/Debian server to host vela apps.
+#
+# Idempotent: every step checks before it acts, so re-running after a CLI
+# upgrade only fills in what is missing. It never touches an app's data, and it
+# never rewrites an existing Caddyfile beyond appending one import line.
+set -euo pipefail
+
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+# shellcheck source=lib.sh
+. "$SCRIPT_DIR/lib.sh"
+
+PB_VERSION=""
+NODE_MAJOR=22
+CLI_VERSION="unknown"
+LAYOUT_VERSION=1
+
+while [ $# -gt 0 ]; do
+	case "$1" in
+		--pb-version) PB_VERSION=$2; shift 2 ;;
+		--node-major) NODE_MAJOR=$2; shift 2 ;;
+		--cli-version) CLI_VERSION=$2; shift 2 ;;
+		*) die "unknown argument: $1" ;;
+	esac
+done
+
+[ "$(id -u)" -eq 0 ] || die "provision must run as root"
+
+. /etc/os-release
+case "${ID:-}" in
+	ubuntu|debian) ;;
+	*) die "unsupported OS: ${PRETTY_NAME:-$ID}. vela provision supports Ubuntu and Debian." ;;
+esac
+
+export DEBIAN_FRONTEND=noninteractive
+APT_UPDATED=0
+apt_update_once() {
+	[ "$APT_UPDATED" -eq 1 ] && return 0
+	apt-get update -qq
+	APT_UPDATED=1
+}
+
+ensure_packages() {
+	local missing=()
+	for pkg in "$@"; do
+		dpkg -s "$pkg" >/dev/null 2>&1 || missing+=("$pkg")
+	done
+	[ ${#missing[@]} -eq 0 ] && return 0
+	log "installing ${missing[*]}"
+	apt_update_once
+	apt-get install -y -qq --no-install-recommends "${missing[@]}" >/dev/null
+}
+
+log "checking base packages"
+ensure_packages ca-certificates curl gnupg rsync unzip tar sqlite3 jq git
+
+# Native npm modules (argon2, better-sqlite3) are compiled on the server when a
+# prebuild is unavailable, so the toolchain has to be here.
+ensure_packages build-essential python3
+
+install_node() {
+	local current=0
+	if command -v node >/dev/null 2>&1; then
+		current=$(node -p 'process.versions.node.split(".")[0]')
+	fi
+	if [ "$current" -ge 20 ] 2>/dev/null; then
+		log "node $(node -v) already installed"
+		return 0
+	fi
+	log "installing Node.js $NODE_MAJOR"
+	curl -fsSL "https://deb.nodesource.com/setup_${NODE_MAJOR}.x" -o /tmp/nodesource_setup.sh
+	bash /tmp/nodesource_setup.sh >/dev/null
+	rm -f /tmp/nodesource_setup.sh
+	apt-get install -y -qq nodejs >/dev/null
+}
+install_node
+
+install_caddy() {
+	if command -v caddy >/dev/null 2>&1; then
+		log "caddy $(caddy version | head -1) already installed"
+		return 0
+	fi
+	log "installing caddy"
+	curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' \
+		| gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
+	curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' \
+		> /etc/apt/sources.list.d/caddy-stable.list
+	apt-get update -qq
+	apt-get install -y -qq caddy >/dev/null
+	APT_UPDATED=1
+}
+install_caddy
+
+log "creating $VELA_USER user"
+if ! id -u "$VELA_USER" >/dev/null 2>&1; then
+	useradd --system --home-dir "$VELA_ROOT" --shell /usr/sbin/nologin "$VELA_USER"
+fi
+
+log "creating directory layout"
+mkdir -p "$VELA_ROOT"/{apps,runtime,state,scripts,by-name,cache}
+mkdir -p "$VELA_ETC"/{apps,caddy}
+chown -R "$VELA_USER:$VELA_USER" "$VELA_ROOT/apps" "$VELA_ROOT/state" "$VELA_ROOT/by-name" "$VELA_ROOT/cache"
+chmod 0755 "$VELA_ROOT" "$VELA_ROOT/apps"
+chown root:root "$VELA_ETC" "$VELA_ETC/apps"
+# Env files hold production secrets; only root reads them, systemd included.
+chmod 0755 "$VELA_ETC"
+chmod 0700 "$VELA_ETC/apps"
+
+log "installing PocketBase $PB_VERSION"
+"$SCRIPT_DIR/pocketbase.sh" "$PB_VERSION"
+
+log "installing systemd unit templates"
+install -m 0644 "$SCRIPT_DIR/systemd/vela-web@.service" /etc/systemd/system/vela-web@.service
+install -m 0644 "$SCRIPT_DIR/systemd/vela-pb@.service" /etc/systemd/system/vela-pb@.service
+systemctl daemon-reload
+
+log "wiring caddy"
+# An import glob that matches nothing is a hard error in Caddy, so keep a
+# comment-only file in place before the first app is deployed.
+if [ ! -f "$VELA_ETC/caddy/00-vela.caddy" ]; then
+	printf '# Managed by vela. App snippets are written alongside this file.\n' \
+		> "$VELA_ETC/caddy/00-vela.caddy"
+fi
+CADDYFILE=/etc/caddy/Caddyfile
+mkdir -p /etc/caddy
+[ -f "$CADDYFILE" ] || printf '' > "$CADDYFILE"
+if ! grep -q 'import /etc/vela/caddy/\*.caddy' "$CADDYFILE"; then
+	{
+		printf '\n# Added by vela provision - app routes are generated into /etc/vela/caddy.\n'
+		printf 'import /etc/vela/caddy/*.caddy\n'
+	} >> "$CADDYFILE"
+fi
+caddy validate --config "$CADDYFILE" --adapter caddyfile >/dev/null 2>&1 \
+	|| die "existing /etc/caddy/Caddyfile is not valid after adding the vela import"
+systemctl enable --now caddy >/dev/null 2>&1 || true
+systemctl reload caddy 2>/dev/null || systemctl restart caddy
+
+log "recording provisioning marker"
+jq -c -n \
+	--arg cli "$CLI_VERSION" \
+	--arg pb "$PB_VERSION" \
+	--arg at "$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
+	--argjson layout "$LAYOUT_VERSION" \
+	'{cliVersion: $cli, pocketbaseVersion: $pb, provisionedAt: $at, layoutVersion: $layout}' \
+	> "$VELA_ETC/provisioned"
+chmod 0644 "$VELA_ETC/provisioned"
+
+emit_result \
+	--arg node "$(node -v)" \
+	--arg caddy "$(caddy version | head -1 | awk '{print $1}')" \
+	--arg pocketbase "$PB_VERSION" \
+	'{node: $node, caddy: $caddy, pocketbase: $pocketbase}'

package/templates/server/rollback.sh

@@ -0,0 +1,88 @@
+#!/usr/bin/env bash
+#
+# Put the previous release back for one instance.
+#
+# usage: rollback.sh <instance> [--to <release>]
+set -Eeuo pipefail
+
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+# shellcheck source=lib.sh
+. "$SCRIPT_DIR/lib.sh"
+
+require_provisioned
+[ "$(id -u)" -eq 0 ] || die "rollback must run as root"
+
+INSTANCE=${1:-}; shift || true
+[ -n "$INSTANCE" ] || die "usage: rollback.sh <instance> [--to <release>]"
+
+TARGET=""
+while [ $# -gt 0 ]; do
+	case "$1" in
+		--to) TARGET=$2; shift 2 ;;
+		*) die "unknown argument: $1" ;;
+	esac
+done
+
+# Commands that drop to the app user inherit this working directory, and the
+# directory the CLI happened to invoke from is usually one it cannot stat.
+cd "$VELA_ROOT"
+
+APP=$(app_dir "$INSTANCE")
+[ -f "$(state_file "$INSTANCE")" ] || die "no instance $INSTANCE on this server"
+
+CURRENT=$(state_get "$INSTANCE" activeRelease || echo "")
+[ -n "$TARGET" ] || TARGET=$(state_get "$INSTANCE" previousRelease || echo "")
+[ -n "$TARGET" ] || die "no previous release recorded for $INSTANCE"
+[ -d "$APP/releases/$TARGET" ] || die "release $TARGET is no longer on disk"
+[ "$TARGET" != "$CURRENT" ] || die "$TARGET is already the active release"
+
+BACKEND=$(state_get "$INSTANCE" backend 2>/dev/null || echo "true")
+HEALTH_PATH=$(state_get "$INSTANCE" healthCheckPath 2>/dev/null || echo "/")
+WEB_PORT=$(state_get "$INSTANCE" webPort)
+PB_PORT=$(state_get "$INSTANCE" pbPort)
+WEB_UNIT=$(unit_web "$INSTANCE")
+PB_UNIT=$(unit_pb "$INSTANCE")
+
+log "rolling back to $TARGET"
+systemctl stop "$WEB_UNIT" >/dev/null 2>&1 || true
+if [ "$BACKEND" = "true" ]; then
+	systemctl stop "$PB_UNIT" >/dev/null 2>&1 || true
+	# Down migrations belong to the release being left behind, so they run from
+	# the current release's migration set before the symlink moves.
+	if [ -n "$CURRENT" ] && [ -d "$APP/releases/$CURRENT/migrations" ]; then
+		AHEAD=$(migrations_ahead "$APP/releases/$CURRENT/migrations" "$APP/releases/$TARGET/migrations")
+		if [ "$AHEAD" -gt 0 ]; then
+			log "reverting $AHEAD migration(s) introduced after $TARGET"
+			runuser -u "$VELA_USER" -- "$APP/bin/pocketbase" \
+				--dir "$APP/shared/pb_data" \
+				--migrationsDir "$APP/releases/$CURRENT/migrations" \
+				migrate down "$AHEAD" >&2 \
+				|| die "down migrations failed - the app is still stopped"
+		fi
+	fi
+fi
+
+ln -sfn "$APP/releases/$TARGET" "$APP/.current.tmp"
+mv -Tf "$APP/.current.tmp" "$APP/current"
+
+# The running release is part of the instance's environment, so it has to move
+# with the symlink.
+ETC=$(etc_dir "$INSTANCE")
+if [ -f "$ETC/runtime.env" ]; then
+	sed -i "s|^VELA_RELEASE=.*|VELA_RELEASE=$TARGET|" "$ETC/runtime.env"
+fi
+
+if [ "$BACKEND" = "true" ]; then
+	systemctl restart "$PB_UNIT"
+	wait_for_http "http://127.0.0.1:$PB_PORT/api/health" 60 0.5 \
+		|| die "PocketBase did not become healthy after rollback"
+fi
+systemctl restart "$WEB_UNIT"
+wait_for_http "http://127.0.0.1:$WEB_PORT$HEALTH_PATH" 60 0.5 \
+	|| die "app did not become healthy after rollback"
+
+state_merge "$INSTANCE" "$(jq -c -n --arg t "$TARGET" --arg c "$CURRENT" \
+	--arg at "$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
+	'{activeRelease: $t, previousRelease: $c, rolledBackAt: $at}')"
+
+emit_result --arg release "$TARGET" --arg from "$CURRENT" '{release: $release, from: $from}'

package/templates/server/status.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+#
+# Print the state of one instance, or every instance on the server, as JSON.
+#
+# usage: status.sh [instance]
+set -Eeuo pipefail
+
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+# shellcheck source=lib.sh
+. "$SCRIPT_DIR/lib.sh"
+
+require_provisioned
+
+describe() {
+	local instance=$1
+	local app; app=$(app_dir "$instance")
+	local state="$app/state.json"
+	[ -f "$state" ] || return 0
+
+	local web_state pb_state releases current
+	web_state=$(systemctl is-active "$(unit_web "$instance")" 2>/dev/null || true)
+	pb_state=$(systemctl is-active "$(unit_pb "$instance")" 2>/dev/null || true)
+	current=$([ -L "$app/current" ] && basename "$(readlink -f "$app/current")" || echo "")
+	releases=$(ls -1 "$app/releases" 2>/dev/null | sort -r | jq -R . | jq -sc .)
+
+	jq -c \
+		--arg web "$web_state" --arg pb "$pb_state" --arg current "$current" \
+		--argjson releases "$releases" \
+		'. + {services: {web: $web, pocketbase: $pb}, current: $current, releases: $releases}' \
+		"$state"
+}
+
+collect() {
+	if [ $# -ge 1 ] && [ -n "$1" ]; then
+		describe "$1"
+	else
+		for dir in "$VELA_ROOT"/apps/*/; do
+			[ -d "$dir" ] || continue
+			describe "$(basename "$dir")"
+		done
+	fi
+}
+
+printf 'VELA_RESULT %s\n' "$(collect "$@" | jq -sc .)"

package/templates/server/systemd/vela-pb@.service

@@ -0,0 +1,41 @@
+[Unit]
+Description=vela PocketBase %i
+Documentation=https://docs.velastack.dev
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+User=vela
+Group=vela
+WorkingDirectory=/var/lib/vela/apps/%i
+
+EnvironmentFile=-/etc/vela/apps/%i/env
+EnvironmentFile=/etc/vela/apps/%i/runtime.env
+
+ExecStart=/var/lib/vela/apps/%i/bin/pocketbase \
+	--dir /var/lib/vela/apps/%i/shared/pb_data \
+	--migrationsDir /var/lib/vela/apps/%i/current/migrations \
+	--hooksDir /var/lib/vela/apps/%i/current/hooks \
+	serve --http=127.0.0.1:${PB_PORT}
+
+Restart=on-failure
+RestartSec=2
+TimeoutStartSec=60
+TimeoutStopSec=30
+KillSignal=SIGINT
+
+StandardOutput=journal
+StandardError=journal
+SyslogIdentifier=vela-pb-%i
+
+LimitNOFILE=65535
+
+NoNewPrivileges=true
+PrivateTmp=true
+ProtectSystem=strict
+ProtectHome=true
+ReadWritePaths=/var/lib/vela/apps/%i
+
+[Install]
+WantedBy=multi-user.target

package/templates/server/systemd/vela-web@.service

@@ -0,0 +1,39 @@
+[Unit]
+Description=vela app %i
+Documentation=https://docs.velastack.dev
+After=network-online.target vela-pb@%i.service
+Wants=network-online.target
+
+[Service]
+Type=simple
+User=vela
+Group=vela
+WorkingDirectory=/var/lib/vela/apps/%i/current
+
+# Production secrets first, vela-generated runtime settings second, so PORT and
+# POCKETBASE_URL always match what the server actually assigned.
+EnvironmentFile=-/etc/vela/apps/%i/env
+EnvironmentFile=/etc/vela/apps/%i/runtime.env
+
+ExecStart=/usr/bin/node /var/lib/vela/apps/%i/current/build/index.js
+
+Restart=on-failure
+RestartSec=2
+TimeoutStartSec=60
+TimeoutStopSec=30
+KillSignal=SIGINT
+
+StandardOutput=journal
+StandardError=journal
+SyslogIdentifier=vela-web-%i
+
+LimitNOFILE=65535
+
+NoNewPrivileges=true
+PrivateTmp=true
+ProtectSystem=strict
+ProtectHome=true
+ReadWritePaths=/var/lib/vela/apps/%i
+
+[Install]
+WantedBy=multi-user.target