🔖 (v0.9.0): add docker support (#21)

Added docker support

## Commits

* ✨ (Dockerfile): add Dockerfile

* ✨ (docker-compose.yml): add docker-compose with configs

* 🔧 (run.sh): webserver listen all ips

* ✨ (Makefile): add build & push

Image name is based on current dir name.

* 🐛 (src/app.py): fix hardcoded vault's ip

No more hardcoded vault's ip.
Now Vault's ip is retrieved from VAULT_CONF_URL.

* ⁉️ (Makefile): change image name

Changed image name from '<harborurl>/<dirname>' to '<dirname>' for
testings purpose.

* 🔧 (docker-compose): update container's ip

Updated container's ip from hardcoded to readable from `.env` file.

* 🔥 (Makefile): removed build & push targets

* ✨ (docker/): add docker folder for images repo

* 🤖 (ci/cd): docker build image workflow

.github/workflows/docker-build.yml

@@ -0,0 +1,15 @@
+name: Build Docker Image
+
+on:
+  push:
+    branches: [ "main" ]
+    pull_request: [ "main" ]
+
+jobs:
+  build:
+    runs-on: self-hosted
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build the Docker image
+      run: cd docker && make build

Makefile

@@ -1,4 +1,3 @@
 .PHONY: lint
-
 lint:
 	poetry run pylint $(shell git ls-files '*.py')

docker/Dockerfile

@@ -0,0 +1,24 @@
+FROM python:3.12
+MAINTAINER Nicolò Vescera <[email protected]>
+
+RUN pip install poetry
+
+RUN mkdir /project
+COPY . /project
+
+WORKDIR /project
+
+# set envs to activate poetry env
+ENV POETRY_NO_INTERACTION=1 \
+    POETRY_VIRTUALENVS_IN_PROJECT=1 \
+    POETRY_VIRTUALENVS_CREATE=1 \
+    POETRY_CACHE_DIR=/tmp/poetry_cache
+
+RUN poetry install
+
+ENV VIRTUAL_ENV=/project/.venv \
+    PATH="/project/.venv/bin:$PATH"
+
+EXPOSE 5000
+
+CMD ["./run.sh"]

docker/Makefile

@@ -0,0 +1,28 @@
+include buildinfo.mk
+
+.PHONY: all
+all: check build push tag
+
+.PHONY: check
+check:
+ifeq ($(IMAGE),)
+    $(error "Missing IMAGE")
+endif
+ifeq ($(DEPLOYED),)
+    $(error "Missing DEPLOYED")
+endif
+
+.PHONY: build
+build: check
+	cd .. && docker build -t $(IMAGE):$(shell date +%Y-%m-%d) -f docker/Dockerfile .
+
+.PHONY: push
+push: check
+	docker push $(IMAGE):$(shell date +%Y-%m-%d)
+	docker tag $(IMAGE):$(shell date +%Y-%m-%d) $(IMAGE):latest
+	docker push $(IMAGE):latest
+
+.PHONY: tag
+tag: check
+	docker tag $(IMAGE):$(DEPLOYED) $(IMAGE):deployed
+	docker push $(IMAGE):deployed

docker/buildinfo.mk

@@ -0,0 +1,3 @@
+IMAGE=harbor1.fisgeo.unipg.it/uninuvola/web
+DEPLOYED=2024-09-20
+

docker/docker-compose.yml

@@ -0,0 +1,13 @@
+services:
+    web:
+        networks:
+            uninuvola:
+                ipv4_address: $WEB_IP
+        container_name: web
+        image: web
+        build: ./
+        env_file: ../.env
+
+networks:
+  uninuvola:
+    external: true

run.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-flask --app src run --debug
+flask --app src run --debug --host 0.0.0.0

src/app.py

@@ -55,8 +55,12 @@
 oauth.register(
     name='vault',
     server_metadata_url=app.config['VAULT_CONF_URL'],
-    api_base_url='http://localhost:8200/v1/',
+    # splits CONF_URL in order to obtain <protocol>://<IP>:<PORT>
+    # split(..., 1) perform only 1 split in case of multiple occurrences
+    api_base_url=f"{app.config['VAULT_CONF_URL'].split('/v1', 1)[0]}/v1/",
     client_kwargs={
         'scope': 'openid web'
     }
 )
+
+app.logger.debug("OAUTH CONFIGS: %s", oauth._registry)