chore: build docker image ourselves (#3)

bf4 · web-flow · commit a5fd84287fef · 2024-02-05T11:24:10.000-06:00
* chore: build docker image ourselves see https://community.fly.io/t/adding-pgvector-to-fly-postgres/12202 * test: re-run actions * chore: extract the script * feat: specify this targets 13 * test: fix typo * chore: limit test pg * fix: platforms * chore: remove terminal stuff * chore: fix shell script usage * test: linux install requires sudo * fix: build image * test: exclude pg 13 * fix: pg image reference (bump minor)
diff --git a/.github/workflows/build-image.yml b/.github/workflows/build-image.yml
@@ -29,11 +29,11 @@ jobs:
           context: .
           file: ./Dockerfile
           # platforms: ${{ matrix.platforms }}
-          platforms: linux/amd64
+          platforms: linux/amd64,linux/arm64/v8
           push: true
-          tags: ghcr.io/x-b-e/server-pg:latest
+          tags: ghcr.io/x-b-e/server-pg:13
           build-args: |
             PG_MAJOR=13
-            PG_TAG=13-13.3
+            PG_IMAGE=postgis/postgis:13-3.4
           # outputs: type=image,name=target,annotation-index.org.opencontainers.image.description=XBE server pg
           # cache-from: ghcr.io/x-b-e/server-pg
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,29 +12,20 @@ jobs:
             os: ubuntu-22.04
           - postgres: 14
             os: ubuntu-22.04
-          - postgres: 13
-            os: ubuntu-20.04
-          - postgres: 12
-            os: ubuntu-20.04
-          - postgres: 11
-            os: ubuntu-18.04
+          # - postgres: 13
+          #   os: ubuntu-20.04
+          # - postgres: 12
+          #   os: ubuntu-20.04
+          # - postgres: 11
+          #   os: ubuntu-18.04
     steps:
       - uses: actions/checkout@v3
       - uses: ankane/setup-postgres@v1
         with:
           postgres-version: ${{ matrix.postgres }}
           dev-files: true
-      - run: make
       - run: |
-          export PG_CONFIG=`which pg_config`
-          sudo --preserve-env=PG_CONFIG make install
-      - run: make installcheck
-      - if: ${{ failure() }}
-        run: cat regression.diffs
-      - run: |
-          sudo apt-get update
-          sudo apt-get install libipc-run-perl
-      - run: make prove_installcheck
+          sudo script/install_pgvector install 0.4.1 pgvector
   mac:
     runs-on: macos-latest
     if: ${{ !startsWith(github.ref_name, 'windows') }}
@@ -43,17 +34,8 @@ jobs:
       - uses: ankane/setup-postgres@v1
         with:
           postgres-version: 14
-      - run: make
-      - run: make install
-      - run: make installcheck
-      - if: ${{ failure() }}
-        run: cat regression.diffs
       - run: |
-          brew install cpanm
-          cpanm --notest IPC::Run
-          wget -q https://github.com/postgres/postgres/archive/refs/tags/REL_14_5.tar.gz
-          tar xf REL_14_5.tar.gz
-      - run: make prove_installcheck PROVE_FLAGS="-I ./postgres-REL_14_5/src/test/perl" PERL5LIB="/Users/runner/perl5/lib/perl5"
+          script/install_pgvector install 0.4.1 pgvector
   windows:
     runs-on: windows-latest
     if: ${{ !startsWith(github.ref_name, 'mac') }}
diff --git a/Dockerfile b/Dockerfile
@@ -1,30 +1,41 @@
 # syntax=docker/dockerfile:1
 
 ARG PG_MAJOR="13"
-ARG PG_TAG="13-13.3"
+# see https://hub.docker.com/r/postgis/postgis for valid images
+ARG PG_IMAGE="postgis/postgis:13-3.4"
 
-FROM postgis/postgis:13-3.3
-# FROM postgis/postgis:${PG_TAG}
+FROM $PG_IMAGE
 
 LABEL org.opencontainers.image.source "https://github.com/x-b-e/pgvector"
 LABEL org.opencontainers.image.description "XBE server postgres with postgis, pgvector"
 LABEL org.opencontainers.image.licenses "PostgreSQL License"
 
 # ARG PG_MAJOR
 # ENV PG_MAJOR=${PG_MAJOR}
-ENV PG_MAJOR=13
-
-COPY . /tmp/pgvector
+# ENV PG_MAJOR=13
 
 RUN apt-get update && \
-		apt-get install -y --no-install-recommends build-essential postgresql-server-dev-${PG_MAJOR} && \
-		cd /tmp/pgvector && \
-		make clean && \
-		make OPTFLAGS="" && \
-		make install && \
-		mkdir /usr/share/doc/pgvector && \
-		cp LICENSE README.md /usr/share/doc/pgvector && \
-		rm -r /tmp/pgvector && \
-		apt-get remove -y build-essential postgresql-server-dev-${PG_MAJOR} && \
-		apt-get autoremove -y && \
-		rm -rf /var/lib/apt/lists/*
+    apt-get install -y --no-install-recommends \
+    build-essential \
+    curl \
+    postgresql-server-dev-all
+
+# Set the pgvector version
+ARG PGVECTOR_VERSION=0.4.1
+ARG PGVECTOR_BUILD_DIR="pgvector"
+
+COPY script/install_pgvector /tmp/install_pgvector
+
+# Download and extract the pgvector release, build the extension, and install it
+RUN /tmp/install_pgvector install "${PGVECTOR_VERSION}" "${PGVECTOR_BUILD_DIR}" && \
+    rm -rf /tmp/*
+
+# Clean up build dependencies and temporary files
+RUN apt-get remove -y \
+    build-essential \
+    curl \
+    postgresql-server-dev-all && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/* && \
+    rm -rf "$PGVECTOR_BUILD_DIR"
diff --git a/script/install_pgvector b/script/install_pgvector
@@ -0,0 +1,86 @@
+#!/bin/bash
+#
+# Usage:
+#  script/pgvector install PGVECTOR_VERSION PGVECTOR_BUILD_DIR
+#  script/pgvector help
+
+set -euo pipefail
+IFS=$'\n\t'
+unset CDPATH
+
+# Influenced by https://dev.to/thiht/shell-scripts-matter
+# And see https://github.com/bf4/Notes/wiki/Shell-Scripting
+
+# Log errors, if any, bash pseudo-signal: ERR
+# Usage:
+#   trap 'finish_error $LINENO' ERR
+finish_error()  {
+  errcode=$?
+  echo "       END ERROR Running script: ${0##*/}:$1: exited with '${errcode}'." >&2
+}
+
+trap 'finish_error $LINENO' ERR
+
+readonly DEBUG="${DEBUG:-}"
+# shellcheck disable=SC2155
+readonly TIMEZONE="${TZ:-America/Chicago}"
+logstamp() { printf "[%s]" "$(TZ="'${TIMEZONE}'" date +'%Y-%m-%d %H:%M:%S')" ; }
+topic()    { echo "-----> $(logstamp) $*" >&2 ; }
+info()     { echo "       $*" >&2 ; }
+debug()    { if [ "$DEBUG" = "true" ]; then echo -e "[DEBUG]       $*" >&2 ; fi ; }
+indent()   { sed -u 's/^/       /' ; } # it always runs on linux. on darwin is 'sed -l'
+warn()     { info "WARNING - ${*}" ; }
+error()    { info "ERROR - ${*}" ;  }
+fail()     { error "$*" ; exit 1 ; }
+
+abort=0
+help() {
+  sed -ne '/^#/!q;s/.\{1,2\}//;1d;p' < "$0" >&$((abort+1))
+  exit "$abort"
+}
+
+# $1 is the PGVECTOR_VERSION
+readonly PGVECTOR_VERSION="${2:-}"
+readonly PGVECTOR_BUILD_DIR="${3:-pgvector-${PGVECTOR_VERSION}}"
+if [ "$DEBUG" = "true" ]; then set -x ; fi
+
+validate_env_vars() {
+  if [ -z "${PGVECTOR_VERSION}" ]; then
+    info "PGVECTOR_VERSION not set"
+    exit 1
+  fi
+  if [ -z "${PGVECTOR_BUILD_DIR}" ]; then
+    info "PGVECTOR_BUILD_DIR not set"
+    exit 1
+  fi
+}
+
+run_cmd() {
+  local cmd
+  cmd="$*"
+  debug "cmd: $cmd"
+  eval "$cmd"
+}
+
+install() {
+  # Download and extract the pgvector release, build the extension, and install it
+  mkdir "${PGVECTOR_BUILD_DIR}"
+  (
+    cd "${PGVECTOR_BUILD_DIR}"
+    curl -L -o pgvector.tar.gz "https://github.com/pgvector/pgvector/archive/refs/tags/v${PGVECTOR_VERSION}.tar.gz" && \
+        tar -xzf pgvector.tar.gz && \
+        cd "pgvector-${PGVECTOR_VERSION}" && \
+        make && \
+        make install
+  )
+}
+
+case "${1:-}" in
+  help) help ;;
+  install) install ;;
+  *)
+    abort=1
+    error "Unknown command: $*"
+    help
+  ;;
+esac
