Merge pull request #2 from rplevka/containerfile

containerize the app

Author: Roman Plevka

Containerfile

@@ -0,0 +1,16 @@
+FROM quay.io/fedora/python-312:latest
+MAINTAINER https://github.com/SatelliteQE
+
+ENV REKUPER_DIR="${HOME}/rekuper"
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+USER 1001
+COPY --chown=1001:0 / ${REKUPER_DIR}
+
+WORKDIR ${REKUPER_DIR}
+RUN rm -f settings.yaml scripts/shovel/settings.yaml && \
+    git config --global --add safe.directory ${REKUPER_DIR} && \
+    uv pip install -r requirements.txt -r requirements-shovel.txt
+
+CMD flask --app rekuper run --host 0.0.0.0

README.md

@@ -8,7 +8,7 @@ graph TD;
 ```
 
 ##Setup
-This is a standard flask app that utilizes Flask-migrate (sqlalchemy + alembic).
+This is a standard flask app that utilizes [Flask-migrate](https://flask-migrate.readthedocs.io/en/latest/index.html) ([sqlalchemy](https://www.sqlalchemy.org/) + [alembic](https://alembic.sqlalchemy.org/en/latest/)).
 It requires a database to be set up.
 To set it up, use the initialization script - `scripts/db_init/init-user-db.sh`.
 For a testing setup, you can setup a postgres db container with the schema precreated by running the `scripts/db_init_setup_db.sh` script.
@@ -26,3 +26,46 @@ start the app:
 flask --app rekuper run
 ```
 The server uses port `5000` by default. The swagger UI should be accessible as a root page.
+
+## Container setup
+Assumuing the database is also going to be run as local container:
+```
+# prepare common network
+podman network create rekuper
+```
+```
+# start db (ephemeral storage) container
+podman run \
+    --name rekuper_db \
+    --network rekuper \
+    -e POSTGRES_PASSWORD=changeme \
+    -v ./init-user-db.sh:/docker-entrypoint-initdb.d/init-user-db.sh:z \
+    postgres:17
+```
+> [!IMPORTANT]
+> At this point, you started an unitialized database. You have to initialize it by running the migration scripts. For this purpose, we'll run a 1-shot `rekuper` container and override the default command
+>This should be use also on an initialized db every time there is a new migration. 
+```
+podman run \
+    --rm \
+    --name rekuper_migrate \
+    --network rekuper \
+    -p 5000:5000 \
+    -e REKUPER_DATABASE__HOST=rekuper_db:5432 \
+    -e REKUPER_DATABASE__DB=telemetry \
+    -e REKUPER_DATABASE__USERNAME=postgres \
+    -e REKUPER_DATABASE__PASSWORD=changeme \
+    localhost/rekuper:0.1 \
+    flask --app rekuper db upgrade
+```
+Run the rekuper container properly this time
+```
+podman run \
+    --network rekuper \
+    -p 5000:5000 \
+    -e REKUPER_DATABASE__HOST=rekuper_db:5432 \
+    -e REKUPER_DATABASE__DB=telemetry \
+    -e REKUPER_DATABASE__USERNAME=postgres \
+    -e REKUPER_DATABASE__PASSWORD=changeme \
+    localhost/rekuper:0.1
+```

config.py

@@ -1,7 +1,7 @@
 from dynaconf import Dynaconf
 
 settings = Dynaconf(
-    envvar_prefix="DYNACONF",
+    envvar_prefix="REKUPER",
     settings_files=['settings.yaml'],
 )
 

rekuper.py

@@ -3,8 +3,9 @@
 from flask import Flask, request, jsonify
 from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
-from flask_restx import Api, Resource, fields, Namespace
-from sqlalchemy.exc import IntegrityError
+from flask_restx import Api, Resource, fields
+from sqlalchemy import text
+from sqlalchemy.exc import IntegrityError, SQLAlchemyError
 
 app = Flask('__name__')
 if settings.database.get('connection_string') is None:
@@ -34,6 +35,19 @@
 )
 ns = api.namespace('api', description='API operations')
 
+def check_db_connection():
+    try:
+        # Execute a simple query
+        db.session.execute(text('SELECT 1'))
+        print("Database connection is valid.")
+    except SQLAlchemyError as e:
+        print(f"Database connection is not valid: {e}")
+        raise SystemExit("Exiting due to database connection failure.")
+
+# Call the function to check the database connection during startup
+with app.app_context():
+    check_db_connection()
+
 session_model = api.model('Session', {
     'id': fields.Integer(readOnly=True, description='The unique identifier of a Session'),
     'jenkins_job': fields.String(required=True, description='The Jenkins job'),

requirements.txt

@@ -2,5 +2,6 @@ dynaconf
 Flask
 Flask-SQLAlchemy
 Flask-Migrate
+flask-restx
 psycopg2-binary
 requests

scripts/db_init/setup_db.sh

@@ -1,2 +1,2 @@
 podman network create rekuper
-podman run --network rekuper --rm -e POSTGRES_PASSWORD=changeme -v ./init-user-db.sh:/docker-entrypoint-initdb.d/init-user-db.sh:z -p 25432:5432 postgres:17
+podman run --name rekuper_db --network rekuper --rm -e POSTGRES_PASSWORD=changeme -v ./init-user-db.sh:/docker-entrypoint-initdb.d/init-user-db.sh:z -p 25432:5432 postgres:17