Ft/deployment setup

.github/workflows/docker-release.yml

@@ -2,22 +2,24 @@ name: Build Docker Image for Every Tag
 
 on:
   push:
+    branches:
+      - 'staging'
     tags:
       - '**'
+env:
+    IMAGE_NAME: "mcsystems/news-search-api"
+    BETA_VERSION: "b1"
 
 jobs:
 
   build:
-
     runs-on: ubuntu-latest
-
     steps:
-
       - name: Checkout Version
         uses: actions/checkout@v4
 
       - name: Dump tag name
-        run: echo "Building tag ${{github.ref_name}}"
+        run: echo "Building ${{ github.ref_type }} ${{ github.ref_name }}"
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -31,10 +33,25 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=tag
+            type=sha
+            type=raw,value=staging-${{ env.BETA_VERSION }},enable=${{ endsWith(github.ref, 'staging') }}
+
       - name: Build and push Docker image
         uses: docker/build-push-action@v5
         with:
           context: .
           platforms: linux/amd64,linux/arm64
           push: true
-          tags: mcsystems/news-search-api:${{github.ref_name}}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          #registry defaults to dockerhub
+          cache-from: type=registry,ref=${{ env.IMAGE_NAME }}:buildcache
+          cache-to: type=registry,ref=${{ env.IMAGE_NAME }}:buildcache,mode=max

Makefile

@@ -0,0 +1,16 @@
+.PHONY: build up down
+
+build:
+	docker-compose build
+
+up:
+	docker-compose up -d
+
+down:
+	docker-compose down
+
+publish:
+	docker push mcsystems/news-search-api:staging
+
+bash:
+	docker-compose exec api bash

deploy.sh

@@ -0,0 +1,118 @@
+#!/bin/bash
+# deploy.sh - Deployment script for News Search API and UI
+
+# Environment variables
+
+IMAGE_TAG="latest"  # Change this based on deployment (staging, production, v1.0)
+INDEXES="mc_search"
+ESHOSTS="http://ramos.angwin:9200,http://woodward.angwin:9200,http://bradley.angwin:9200"
+ESOPTS="{'timeout': 60, 'max_retries': 3}" # 'timeout' parameter is deprecated
+ELASTICSEARCH_INDEX_NAME_PREFIX="mc_search-*"
+TERMFIELDS="article_title,text_content"
+TERMAGGRS="top,significant,rare"
+APP_NAME="news-search-api"
+
+# Check if running as root
+is_root() {
+    if [ $(whoami) != "root" ]; then
+        echo "This script must be run as root."
+        exit 1
+    fi
+}
+
+is_root
+echo "Running as root"
+
+LOGIN_USER=$(who am i | awk '{ print $1 }')
+if [ "x$LOGIN_USER" = x ]; then
+    # XXX fall back to whoami (look by uid)
+    echo could not find login user 1>&2
+    exit 1
+fi
+
+run_as_login_user() {
+    is_root
+	su $LOGIN_USER -c "$*"
+}
+
+help()
+{
+    echo "Usage: ./deploy.sh [options]"
+    echo "Options:"
+    echo "-h show help message"
+    echo "-t specify the image tag (staging, release, v1.3.1 e.t.c)"
+}
+
+log()
+{
+    echo "$1"
+}
+
+zzz() {
+    echo $1 | tr 'A-Za-z' 'N-ZA-Mn-za-m'
+}
+
+# Parse command-line options
+while getopts :h:t optname; do
+    log "Option $optname set with value ${OPTARG}"
+    case $optname in
+        t)
+            IMAGE_TAG=${OPTARG}
+            ;;
+        h)
+            help
+            exit 2
+            ;;
+        \?)
+            echo "Invalid option: $1"
+            help
+            exit 2
+            ;;
+    esac
+done
+
+# Create a directory for private configuration
+PRIVATE_CONF_DIR="news_search_api_config"
+rm -rf "$PRIVATE_CONF_DIR"
+mkdir -p "$PRIVATE_CONF_DIR"
+chmod go-rwx "$PRIVATE_CONF_DIR"
+CONFIG_REPO_PREFIX=$(zzz tvg@tvguho.pbz:zrqvnpybhq)
+CONFIG_REPO_NAME=$(zzz arjf-frnepu-ncv-pbasvt)
+echo cloning $CONFIG_REPO_NAME repo 1>&2
+if ! run_as_login_user "git clone $CONFIG_REPO_PREFIX/$CONFIG_REPO_NAME.git" >/dev/null 2>&1; then
+echo "FATAL: could not clone config repo" 1>&2
+exit 1
+fi
+PRIVATE_CONF_REPO=$(pwd)/$CONFIG_REPO_NAME
+PRIVATE_CONF_FILE=$PRIVATE_CONF_REPO/$APP_NAME.sh
+cd ..
+
+if [ ! -f $PRIVATE_CONF_FILE ]; then
+    echo "FATAL: could not access $PRIVATE_CONF_FILE" 1>&2
+    exit 1
+fi
+#source private conf to load SENTRY_DSN
+. $PRIVATE_CONF_FILE
+
+
+INSTALL_DIR="news_search_api"
+mkdir -p "$INSTALL_DIR"
+
+GH_REPO_PREFIX="https://github.com/mediacloud"
+GH_REPO_NAME="news-search-api"
+DOCKER_COMPOSE_FILE="docker-compose.yml"
+echo "Fetching $DOCKER_COMPOSE_FILE from $GH_REPO_NAME repo..."
+if ! curl -sSfL "$GH_REPO_PREFIX/$GH_REPO_NAME/raw/$IMAGE_TAG/$DOCKER_COMPOSE_FILE" -o "$INSTALL_DIR/$DOCKER_COMPOSE_FILE"; then
+    echo "FATAL: Could not fetch $DOCKER_COMPOSE_FILE from config repo"
+    exit 1
+
+fi
+
+# Deploy services using Docker Compose
+echo "Deploying services with image tag: $IMAGE_TAG"
+docker-compose -f "$INSTALL_DIR/$DOCKER_COMPOSE_FILE" up -d
+
+# Additional steps (e.g., database migrations, cache clearing, etc.)
+# ...
+
+echo "Deployment completed successfully!"

docker-compose.yml

@@ -1,30 +1,29 @@
 services:
   api:
-    image: mcsystems/news-search-api
+    image: mcsystems/news-search-api:${IMAGE_TAG}
     build: .
     ports:
       - 8000:8000
     networks:
-      - story-indexer
+      - new-search-api
     volumes:
       - .:/app
 
   ui:
-    image: mcsystems/news-search-api
+    image: mcsystems/news-search-api:${IMAGE_TAG}
     build: .
     environment:
       APIURL: http://api:8000/v1
     ports:
-      - 8001:8501
+      - 8501:8501
     networks:
-      - story-indexer
+      - new-search-api
     volumes:
       - .:/app
     depends_on:
       - api
     command: streamlit run ui.py
 
 networks:
-  story-indexer:
-    name: story-indexer
-    external: true
+  new-search-api:
+    name: new-search-api