fix(deploy): Setup now runs in background process after dependency installation steps

Author: lorenjohnson

deploy/setup/setup.sh

@@ -1,32 +1,70 @@
 #!/usr/bin/env bash
 set -e
 
-# --- Global Config ---
+# -- Constants --
 
+CERT_EMAIL="[email protected]"
+REPO_URL="https://github.com/wmde/wikibase-release-pipeline.git"
 WBS_DIR="/opt/wbs"
 LOG_PATH="$WBS_DIR/setup.log"
+DEPLOY_DIR="$WBS_DIR/wikibase-release-pipeline/deploy"
+SETUP_DIR="$DEPLOY_DIR/setup"
+ENV_FILE_PATH="$DEPLOY_DIR/.env"
+
+# --- CLI related ---
 
-# CLI options (can be overridden by env or args)
+CLOUD_INIT="${CLOUD_INIT:-false}"
+DEV="${DEV:-false}"
+LAUNCH_MODE=false
+SKIP_DEPENDENCY_INSTALLS="${SKIP_DEPENDENCY_INSTALLS:-false}"
 VERBOSE="${VERBOSE:-false}"
-SKIP_DOCKER_INSTALL="${SKIP_DOCKER_INSTALL:-false}"
-CERT_EMAIL="${CERT_EMAIL:-wbs-setup@wikimedia.de}"
 
-# CLI overrides
 for arg in "$@"; do
   case "$arg" in
-    --verbose)
-      VERBOSE=true
+    --cloud-init)
+      CLOUD_INIT=true
       ;;
-    --skip-docker-install)
-      SKIP_DOCKER_INSTALL=true
+    --dev)
+      DEV=true
+      SKIP_DEPENDENCY_INSTALLS=true
+      WBS_DIR=../../..
+      LOG_PATH="$WBS_DIR/setup.log"
+      DEPLOY_DIR="$WBS_DIR/wikibase-release-pipeline/deploy"
+      SETUP_DIR="$DEPLOY_DIR/setup"
+      SETUP_HOST=localhost
       ;;
-    --cert-email=*)
-      CERT_EMAIL="${arg#*=}"
+    --launch)
+      LAUNCH_MODE=true
+      ;;
+    --skip-depedency-installs)
+      SKIP_DEPENDENCY_INSTALLS=true
+      ;;
+    --verbose)
+      VERBOSE=true
       ;;
   esac
 done
 
-# Logging functions
+# -- Setup host for SSL cert generation --
+
+PUBLIC_IP=$(curl --silent --show-error --fail https://api.ipify.org)
+SETUP_PORT=8888
+# Random suffix keeps Let's Encrypt from rate limiting
+# but not in CLOUD_INIT so that the setup webserver address
+# remains known (https://<SERVER-IP>.nip.io:8888) in that case. 
+if [[ "$CLOUD_INIT" = "true" ]]; then
+  SETUP_HOST=$PUBLIC_IP.nip.io
+else
+  SETUP_SUBDOMAIN=wbs-setup-$(LC_ALL=C tr -dc 'a-z0-9' </dev/urandom | head -c 6)
+  SETUP_HOST=$SETUP_SUBDOMAIN.$PUBLIC_IP.nip.io
+fi
+
+# -- Setup logging --
+
+mkdir -p "$WBS_DIR"
+touch "$LOG_PATH"
+
+
 log() {
   if $VERBOSE; then
     echo "$@"
@@ -39,149 +77,145 @@ log_cmd() {
   else
     bash -c "$@" &> /dev/null
   fi
+
   return $?
 }
 
-# --- Run detached so closing terminal will not terminate setup process---
+# --- Non-launch Mode: Run setup ---
 
-if [[ -z "$WBS_SETUP_DETACHED" ]]; then
-  export WBS_SETUP_DETACHED=1
-  mkdir -p "$WBS_DIR"
-  touch "$LOG_PATH"
-  nohup bash "$0" "$@" >> "$LOG_PATH" 2>&1 &
-  exit 0
-fi
+if ! $LAUNCH_MODE; then
+  exec > >(tee -a "$LOG_PATH") 2>&1
+  # clear || printf "\033c"
+  echo
+  echo "Wikibase Suite Deploy Setup"
+  echo
 
-# --- Begin main execution (detached) ---
+  install_git() {
+    if command -v git &>/dev/null; then
+      log "Git already installed"
+      return
+    fi
 
-exec > >(tee -a "$LOG_PATH") 2>&1
+    echo "Installing Git..."
+
+    if command -v apt-get &>/dev/null; then
+      log_cmd "apt-get update && apt-get install -y git"
+    elif command -v dnf &>/dev/null; then
+      log_cmd "dnf install -y git"
+    elif command -v yum &>/dev/null; then
+      log_cmd "yum install -y git"
+    elif command -v apk &>/dev/null; then
+      log_cmd "apk add git"
+    elif command -v pacman &>/dev/null; then
+      log_cmd "pacman -Sy --noconfirm git"
+    else
+      echo "⚠️ Unsupported package manager. Please install Git manually."
+      exit 1
+    fi
+  }
+
+  install_docker() {
+    echo "Installing Docker..."
+    log_cmd "curl -fsSL https://get.docker.com | sh"
+    log_cmd "systemctl enable --now docker"
+    echo "Installing Docker Compose plugin..."
+    mkdir -p ~/.docker/cli-plugins
+    log_cmd "curl -SL https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o ~/.docker/cli-plugins/docker-compose"
+    chmod +x ~/.docker/cli-plugins/docker-compose
+  }
+
+  clone_repo() {
+    echo "Cloning Wikibase Release Pipeline repository..."
+    cd "$WBS_DIR"
+    log_cmd "git clone $REPO_URL"
+    cd wikibase-release-pipeline
+    log_cmd "git checkout deploy-setup-script"
+  }
+
+  generate_cert_for_setup_webserver() {
+    log "Generating Let's Encrypt TLS certificate for setup page..."
+
+    log_cmd "mkdir -p $SETUP_DIR/letsencrypt $SETUP_DIR/certs"
+    log "Using domain: $SETUP_HOST"
+
+    log_cmd "docker pull certbot/certbot"
+
+    if log_cmd "docker run --rm \
+      -v $SETUP_DIR/letsencrypt:/etc/letsencrypt \
+      -v $SETUP_DIR/certs:/certs \
+      -p 80:80 \
+      certbot/certbot certonly \
+        --standalone \
+        --non-interactive \
+        --preferred-challenges http \
+        --agree-tos \
+        --email $CERT_EMAIL \
+        -d $SETUP_HOST"; then
+
+      CERT_PATH="$SETUP_DIR/letsencrypt/live/$SETUP_HOST"
+      cp "$CERT_PATH/fullchain.pem" "$SETUP_DIR/certs/cert.pem"
+      cp "$CERT_PATH/privkey.pem" "$SETUP_DIR/certs/key.pem"
 
-log "Verbose mode enabled"
+    else
+      echo "Let's Encrypt challenge failed, falling back to self-signed certificate."
 
-# --- Constants ---
+      openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
+        -out "$SETUP_DIR/certs/cert.pem" \
+        -keyout "$SETUP_DIR/certs/key.pem" \
+        -subj "/CN=$SETUP_HOST"
+    fi
+  }
 
-REPO_URL="https://github.com/wmde/wikibase-release-pipeline.git"
-DEPLOY_DIR="$WBS_DIR/wikibase-release-pipeline/deploy"
-SETUP_DIR="$DEPLOY_DIR/setup"
-ENV_FILE_PATH="$DEPLOY_DIR/.env"
+  start_setup_webserver() {
+    log "Starting setup page webserver container..."
+    cd "$SETUP_DIR"
 
-PUBLIC_IP=$(curl --silent --show-error --fail https://api.ipify.org)
-SETUP_SUBDOMAIN=wbs-setup-$(LC_ALL=C tr -dc 'a-z0-9' </dev/urandom | head -c 6)
-SETUP_HOST=$SETUP_SUBDOMAIN.$PUBLIC_IP.nip.io
-SETUP_PORT=8888
+    generate_cert_for_setup_webserver
 
-# --- Functions ---
+    # Makes compatible with environments that have Buildx installed
+    BUILDX_DRIVER=$(docker buildx inspect | grep 'Driver:' | awk '{print $2}')
+    if [ "$BUILDX_DRIVER" = "docker-container" ]; then
+      LOAD_FLAG="--load"
+    else
+      LOAD_FLAG=""
+    fi
 
-start_message() {
-  echo
-  echo "Wikibase Suite Deploy Setup"
-  echo
-}
+    log_cmd "docker build $LOAD_FLAG -t wikibase/deploy-setup-webserver ."
+    log_cmd "docker run -d \
+      -p $SETUP_PORT:443 \
+      -v $DEPLOY_DIR:/app/deploy \
+      -v $SETUP_DIR/certs:/app/certs \
+      -v $LOG_PATH:/app/setup.log \
+      wikibase/deploy-setup-webserver"
 
-install_git() {
-  if command -v git &>/dev/null; then
-    log "Git already installed"
-    return
-  fi
+    echo
+    echo "To continue setup navigate to:"
+    echo
+    echo "  https://$SETUP_HOST:$SETUP_PORT"
+    echo
+  }
 
-  echo "Installing Git..."
-
-  if command -v apt-get &>/dev/null; then
-    log_cmd "apt-get update && apt-get install -y git"
-  elif command -v dnf &>/dev/null; then
-    log_cmd "dnf install -y git"
-  elif command -v yum &>/dev/null; then
-    log_cmd "yum install -y git"
-  elif command -v apk &>/dev/null; then
-    log_cmd "apk add git"
-  elif command -v pacman &>/dev/null; then
-    log_cmd "pacman -Sy --noconfirm git"
+  if ! $SKIP_DEPENDENCY_INSTALLS; then
+    install_git
+    install_docker
   else
-    echo "⚠️ Unsupported package manager. Please install Git manually."
-    exit 1
+    echo "Skipping dependency checks and installations..."
   fi
-}
-
-install_docker() {
-  echo "Installing Docker..."
-  log_cmd "curl -fsSL https://get.docker.com | sh"
-  log_cmd "systemctl enable --now docker"
-  echo "Installing Docker Compose plugin..."
-  mkdir -p ~/.docker/cli-plugins
-  log_cmd "curl -SL https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o ~/.docker/cli-plugins/docker-compose"
-  chmod +x ~/.docker/cli-plugins/docker-compose
-}
-
-clone_repo() {
-  echo "Cloning Wikibase Release Pipeline repository..."
-  cd "$WBS_DIR"
-  log_cmd "git clone $REPO_URL"
-  cd wikibase-release-pipeline
-  log_cmd "git checkout deploy-setup-script"
-}
-
-generate_ssl_cert_for_setup_webserver() {
-  log "Generating Let's Encrypt TLS certificate for setup page..."
-
-  log_cmd "mkdir -p $SETUP_DIR/letsencrypt $SETUP_DIR/certs"
-  log "Using domain: $SETUP_HOST"
-
-  # Pre-pull certbot image to suppress output
-  log_cmd "docker pull certbot/certbot"
-
-  if log_cmd "docker run --rm \
-    -v $SETUP_DIR/letsencrypt:/etc/letsencrypt \
-    -v $SETUP_DIR/certs:/certs \
-    -p 80:80 \
-    certbot/certbot certonly \
-      --standalone \
-      --non-interactive \
-      --preferred-challenges http \
-      --agree-tos \
-      --email $CERT_EMAIL \
-      -d $SETUP_HOST"; then
-
-    CERT_PATH="$SETUP_DIR/letsencrypt/live/$SETUP_HOST"
-    cp "$CERT_PATH/fullchain.pem" "$SETUP_DIR/certs/cert.pem"
-    cp "$CERT_PATH/privkey.pem" "$SETUP_DIR/certs/key.pem"
-  else
-    echo "Let's Encrypt challenge failed, falling back to self-signed certificate."
-
-    openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
-      -out "$SETUP_DIR/certs/cert.pem" \
-      -keyout "$SETUP_DIR/certs/key.pem" \
-      -subj "/CN=$SETUP_HOST"
+  if ! $DEV; then
+    clone_repo
   fi
-}
-
-start_config_webserver() {
-  log "Starting setup page webserver container..."
-  cd "$SETUP_DIR"
-
-  generate_ssl_cert_for_setup_webserver
-  
-  # Makes compatible with environments that have Buildx installed which
-  # Add --load only if using docker-container driver
-  BUILDX_DRIVER=$(docker buildx inspect | grep 'Driver:' | awk '{print $2}')
-  if [ "$BUILDX_DRIVER" = "docker-container" ]; then
-    LOAD_FLAG="--load"
-  else
-    LOAD_FLAG=""
+  start_setup_webserver
+
+  if ! $DEV; then
+    # Launch second phase in background
+    CMD=(bash "$DEPLOY_DIR/setup/setup.sh" --launch)
+    if $VERBOSE; then CMD+=(--verbose); fi
+    setsid "${CMD[@]}" >> "$LOG_PATH" 2>&1 < /dev/null &
+    exit 0
   fi
+fi
 
-  log_cmd "docker build $LOAD_FLAG -t wikibase/deploy-setup-webserver ."
-  log_cmd "docker run -d \
-    -p $SETUP_PORT:443 \
-    -v $DEPLOY_DIR:/app/deploy \
-    -v $SETUP_DIR/certs:/app/certs \
-    -v $LOG_PATH:/app/setup.log \
-    wikibase/deploy-setup-webserver"
-  echo
-  echo "To complete setup, navigate to:"
-  echo
-  echo "https://$SETUP_HOST:$SETUP_PORT"
-  echo
-}
+# --- Launch Mode: Wait for .env and start services ---
 
 wait_for_env_file() {
   until [ -f "$ENV_FILE_PATH" ]; do
@@ -192,13 +226,13 @@ wait_for_env_file() {
 
 launch_wikibase() {
   echo "Launching Wikibase Suite Docker containers..."
-  log_cmd "cd $DEPLOY_DIR"
+  cd "$DEPLOY_DIR"
   log_cmd "docker compose up -d"
 }
 
 final_message() {
   echo
-  echo "✅ Setup is Complete!"
+  echo "Setup is Complete!"
   echo
 
   if [[ -f "$ENV_FILE_PATH" ]]; then
@@ -227,17 +261,7 @@ final_message() {
   fi
 }
 
-# --- Execution ---
-
-start_message
-install_git
-if [[ "$SKIP_DOCKER_INSTALL" != "true" ]]; then
-  install_docker
-else
-  echo "Skipping Docker installation"
-fi
-clone_repo
-start_config_webserver
+exec >> "$LOG_PATH" 2>&1
 wait_for_env_file
 launch_wikibase
 final_message