Create container for migrate (#198)

* Create dockerfile for migrate container

* Update compose for new migrate image

* Update migrate readme

* Add image to ci build pipeline

* Add executable

* Remove unecesarry RUN

.github/workflows/registry_upload.yml

@@ -15,7 +15,6 @@ env:
   CPU: "arm64"
 
 jobs:
-
   on-failure:
     runs-on: ubuntu-latest
     if: ${{ github.event.workflow_run.conclusion == 'failure' }}
@@ -37,6 +36,8 @@ jobs:
             IMAGE_NAME: api
           - context: ./ingest/
             IMAGE_NAME: ingest
+          - context: ./datastore/migrate/
+            IMAGE_NAME: migrate
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

datastore/migrate/Dockerfile

@@ -0,0 +1,7 @@
+FROM migrate/migrate:4
+
+COPY data/migrations /migrations
+
+COPY ./run-migrate.sh /
+
+ENTRYPOINT [ "/run-migrate.sh" ]

datastore/migrate/README.md

@@ -1,17 +1,21 @@
 # Migration Framework
+
 To have reproducible environments, support rollbacks and that every change is only executed once, we use [Golang Migrate](https://github.com/golang-migrate/migrate/tree/master) as a migration framework.
 
 See the following URL for installation instructions and basic commands:
-https://github.com/golang-migrate/migrate/tree/master/cmd/migrate
+<https://github.com/golang-migrate/migrate/tree/master/cmd/migrate>
 
 See the following URL for the migration file format instructions:
-https://github.com/golang-migrate/migrate/blob/master/MIGRATIONS.md
+<https://github.com/golang-migrate/migrate/blob/master/MIGRATIONS.md>
 
 ## Practicalities
+
 ### Initialisation
+
 The migration framework initialises the database. Therefore, no database tables exist before running the migrate step in the docker compose.
 
 ### File name format
+
 The migration file name format follows the suggestion in [MIGRATIONS.md](https://github.com/golang-migrate/migrate/blob/master/MIGRATIONS.md) to use a timestamp as version.
 
 ```
@@ -21,8 +25,20 @@ The migration file name format follows the suggestion in [MIGRATIONS.md](https:/
 
 On Linux, you can retrieve the current timestamp by running: `date +%s`.
 
-
 ### Migration Path
-The path `./migrate/data/migrations` is mounted on the migrate container. Thus, the docker container only executes the migrations in this path.
+
+The path `./migrate/data/migrations` is copied to the migrate container. Thus, the docker container only executes the migrations in this path.
 
 The other path: `./migrate/data/not_supported_yet`, contains an example migration based on code comments about unfinished work from the initialise script. As the path is not mounted, the docker container does not execute migrations in that path. To try out the migrations move the files to `./migrate/data/migrations`.
+
+### Configure migrate image
+
+There are a few environment variables needed to run the migrate script.
+
+| Name  | Requiered | Explenation  |
+|------------|------|--------------|
+| DB_USER    | Yes  | The username for the database  |
+| DB_PASS    | Yes  | The password for the user  |
+| DB_URL     | Yes  | URL or IP to the postgis database  |
+| DB_PORT    | No   | Database port, default `5432` |
+| ENABLE_SSL | No   | Wether to use ssl for connection, defailt `disable`|

datastore/migrate/run-migrate.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exec migrate -path /migrations -database "postgres://${DB_USER}:${DB_PASS}@${DB_URL}:${DB_PORT:-5432}/data?sslmode=${ENABLE_SSL:-disable}" up

docker-compose.yml

@@ -30,17 +30,12 @@ services:
       start_period: 30s # Failures in 30 seconds do not mark container as unhealthy
 
   migrate:
-    image: migrate/migrate:4
-    volumes:
-      - ./datastore/migrate/data/migrations:/data/migrations
-    command:
-      [
-        "-path",
-        "/data/migrations",
-        "-database",
-        "postgres://postgres:mysecretpassword@db:5432/data?sslmode=disable",
-        "up",
-      ]
+    build:
+      context: datastore/migrate
+    environment:
+      - DB_USER=postgres
+      - DB_PASS=mysecretpassword
+      - DB_URL=db
     depends_on:
       db:
         condition: service_healthy