dockerization and separation of redis and postress fron the app itself, and creation of docker-compose file for te deploy of development environment

Author: Acosta Nicolás Gabriel

Dockerfile

@@ -1,27 +1,24 @@
-FROM ubuntu:16.04
+FROM python:3.8-alpine
 
-#MAINTANER Your Name "[email protected]"
 
+# Packages required for psycopg2
+RUN apk update && apk add postgresql-dev gcc python3-dev musl-dev
+
+#MAINTANER Your Name "[email protected]"
 ENV [email protected]
 ENV MAIL_PASSWORD=testpass
 ENV SECRET_KEY=SuperRandomStringToBeUsedForEncryption
-
-RUN apt-get update -y && \
-    apt-get install -y python3-pip python3-dev
-RUN apt-get install -y ruby-dev
-RUN gem install foreman
 # We copy just the requirements.txt first to leverage Docker cache
 COPY ./requirements.txt /app/requirements.txt
 
-
-RUN apt-get install -y redis-server
 WORKDIR /app
-RUN apt-get install -y build-essential libpq-dev
-RUN pip3 install -r requirements.txt
+RUN pip3 install -r requirements.txt 
 ENV PYTHONIOENCODING=UTF-8
 RUN pip3 install sqlalchemy_utils flask_dance flask_caching python-gitlab
+
 COPY . /app
-RUN python3 manage.py recreate_db && python3 manage.py setup_dev && python3 manage.py add_fake_data
 
-CMD ["foreman", "start" ,"-f", "Local"]
+#RUN python3 manage.py recreate_db && python3 manage.py setup_dev && python3 manage.py add_fake_data
+
+ENTRYPOINT ["python3", "-u" ,"manage.py", "runserver"]
 

Dockerfile.worker

@@ -0,0 +1,22 @@
+FROM python:3.8-alpine
+
+
+# Packages required for psycopg2
+RUN apk update && apk add postgresql-dev gcc python3-dev musl-dev
+
+#MAINTANER Your Name "[email protected]"
+ENV [email protected]
+ENV MAIL_PASSWORD=testpass
+ENV SECRET_KEY=SuperRandomStringToBeUsedForEncryption
+# We copy just the requirements.txt first to leverage Docker cache
+COPY ./requirements.txt /app/requirements.txt
+
+WORKDIR /app
+RUN pip3 install -r requirements.txt 
+ENV PYTHONIOENCODING=UTF-8
+RUN pip3 install sqlalchemy_utils flask_dance flask_caching python-gitlab
+
+COPY . /app
+
+ENTRYPOINT ["python3", "-u" ,"manage.py", "run_worker"]
+

Local

@@ -41,6 +41,33 @@ Admin Editing Users:
 
 ![edit user](readme_media/edituser.gif "edituser")
 
+## Gettin up and running with Docker and docker-compose:
+
+##### Clone the repository 
+```
+$ git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
+$ cd REPO_NAME
+```
+##### Create and run the images:
+
+```
+$ docker-compose up
+```
+
+##### Create database and initial data for development:
+
+```
+$ docker-compose exec server ./init_database.sh
+```
+
+It will deploy 5 docker images:
+
+- server: Flask app running in [http://localhost:5000](http://localhost:5000).
+- worker: Worker ready to get tasks.
+- postgres: Postgres SQL isolated from the app.
+- adminer: Web client for database management, running in [http://localhost:8080](http://localhost:8080).
+- redis: Redis SQL isolated from the app
+
 
 ## Setting up
 
@@ -191,23 +218,6 @@ $ honcho start -e config.env -f Local
 
 For Windows users having issues with binding to a redis port locally, refer to [this issue](https://github.com/hack4impact/flask-base/issues/132).
 
-
-## Gettin up and running with Docker
-
-Currently we have a `Dockerfile` intended for testing purposes and it automates the whole cycle of running the application, setting up the database and redis. 
-
-
-##### How to use the docker file 
-In only three simple steps :
-- change the variables `MAIL_USERNAME` , `MAIL_PASSWORD` and `SECRET_KEY`
-- `docker build -t <image_name> . 
-- `docker run -it -d -p 5000:5000 --name <container name> <image_name> /bin/bash`
-- To run in foreground mode `docker run -it -p 5000:5000 --name <container name> <image_name> /bin/bash`
-
-##### Note
-
-A more robust version with docker-compose is being developed to separate redis in separate container and allow the deployment of production-level applications automatically without the need of manual provisioning
-
 ## Formatting code
 
 Before you submit changes to flask-base, you may want to autoformat your code with `python manage.py format`.

README.md

@@ -21,7 +21,6 @@
 
 class Config:
     APP_NAME = os.environ.get('APP_NAME', 'Flask-Base')
-
     if os.environ.get('SECRET_KEY'):
         SECRET_KEY = os.environ.get('SECRET_KEY')
     else:

config.py

@@ -0,0 +1,49 @@
+version: '3.4'
+services:
+  server:
+    build:
+      context: .
+    ports:
+      - '5000:5000'
+    volumes: 
+      - './:/app'
+    environment: 
+      # set environment variables
+      REDISTOGO_URL: http://redis:6379
+      DEV_DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+      TEST_DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+      DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+  
+  worker:
+    build:
+      dockerfile: Dockerfile.worker
+      context: .
+    volumes: 
+      - './:/app'
+    environment: 
+      # set environment variables
+      REDISTOGO_URL: http://redis:6379
+      DEV_DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+      TEST_DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+      DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+
+  postgres:
+    image: postgres
+    environment:
+      POSTGRES_USER: admin
+      POSTGRES_PASSWORD: example
+      POSTGRES_DB: mydatabase
+    volumes:
+    - db-data:/var/lib/postgresql/data
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - 8080:8080
+
+  redis:
+    image:
+      redis:6-alpine
+
+volumes:
+  db-data:

docker-compose.yml

@@ -0,0 +1,5 @@
+#! /usr/bin/env sh
+
+python3 manage.py recreate_db
+python3 manage.py setup_dev
+python3 manage.py add_fake_data

init_database.sh

@@ -3,14 +3,14 @@
 import subprocess
 
 from flask_migrate import Migrate, MigrateCommand
-from flask_script import Manager, Shell
+from flask_script import Manager, Shell, Server
 from redis import Redis
 from rq import Connection, Queue, Worker
 
 from app import create_app, db
 from app.models import Role, User
 from config import Config
-
+import os
 app = create_app(os.getenv('FLASK_CONFIG') or 'default')
 manager = Manager(app)
 migrate = Migrate(app, db)
@@ -22,6 +22,7 @@ def make_shell_context():
 
 manager.add_command('shell', Shell(make_context=make_shell_context))
 manager.add_command('db', MigrateCommand)
+manager.add_command('runserver', Server(host="0.0.0.0"))
 
 
 @manager.command