initial commit

Author: bearddan2000

README.md

@@ -0,0 +1,34 @@
+# python-web-api-flask-traefic-postgres-pop
+
+## Description
+Creates an api of `pop` for a flask project.
+Has the ability to query by parameters.
+If path is not found, will default to 404 error.
+Uses self-signed ssl.
+
+## Tech stack
+- python
+- flask
+- postgres
+- reverse proxy
+- ssl
+
+## Docker stack
+- alpine:edge
+- python:latest
+- postgresql
+- traefik:v2.4
+
+## To run
+`sudo ./install.sh -u`
+- Endpoint
+  - [Availble](https://myapi.docker.localhost/pop)
+  
+## To stop (optional)
+`sudo ./install.sh -d`
+
+## For help
+`sudo ./install.sh -h`
+
+## Credit
+- https://stackabuse.com/using-sqlalchemy-with-flask-and-postgresql/

db/sql/00-create-table.sql

@@ -0,0 +1,7 @@
+CREATE SEQUENCE pop_id_seq INCREMENT 1 MINVALUE 1 MAXVALUE 2147483647 START 1;
+
+CREATE TABLE "public"."pop" (
+    "id" integer DEFAULT nextval('pop_id_seq') NOT NULL,
+    "name" text NOT NULL,
+    "color" text NOT NULL
+) WITH (oids = false);

db/sql/01-insert-table.sql

@@ -0,0 +1,6 @@
+INSERT INTO "public"."pop" (name, color)
+VALUES
+('RC Cola', 'brown'),
+('Sprite', 'clear'),
+('Verners', 'brown'),
+('Mt. Lightening', 'green');

docker-compose.yml

@@ -0,0 +1,38 @@
+version: "3"
+
+services:
+  db:
+    image: postgres:alpine
+    environment:
+      - POSTGRES_DB=beverage
+      - POSTGRES_USER=maria
+      - POSTGRES_HOST_AUTH_METHOD=trust
+    volumes:
+      - ./db/sql:/docker-entrypoint-initdb.d
+
+  py-srv:
+    build: py-srv
+    command: python app.py
+    ports:
+      - "5000"
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.myapp.tls=true
+      - traefik.http.routers.myapp.rule=Host("myapi.docker.localhost")
+
+  traefik:
+    image: "traefik:v2.4"
+    container_name: "traefik"
+    labels:
+     - "traefik.enable=true"
+     - "traefik.http.routers.traefik=true"
+    ports:
+      # HTTPS / SSL port
+      - "443:443"
+      # The Traefik Web UI port (enabled by api:insecure: true in traefik.yml)
+      - "8080:8080"
+    volumes:
+     - ./traefik/traefik.yml:/etc/traefik/traefik.yml:ro
+     - ./traefik/config.yml:/etc/traefik/config.yml:ro
+     - ./traefik/cert:/etc/certs:ro
+     - /var/run/docker.sock:/var/run/docker.sock:ro

general.log

@@ -0,0 +1,6 @@
+[2021-05-14 10:31:53 INFO]: install::setup-logging ended
+================
+[2021-05-14 10:31:53 INFO]: install::start-up started
+[2021-05-14 10:31:53 INFO]: install::start-up running image
+[2021-05-14 10:31:53 INFO]: install::start-up ended
+================

openssl-srv/Dockerfile

@@ -0,0 +1,17 @@
+FROM alpine:edge
+
+WORKDIR /cert
+
+RUN apk upgrade --update-cache --available && \
+    apk add openssl && \
+    rm -rf /var/cache/apk/*
+
+RUN openssl req -new -text -passout pass:abcd -subj /CN=localhost -out server.req -keyout privkey.pem
+
+RUN openssl rsa -in privkey.pem -passin pass:abcd -out server.key
+
+RUN openssl req -x509 -in server.req -text -key server.key -out server.crt
+
+RUN chmod -R +x * && ls
+
+CMD ["pwd"]

py-srv/Dockerfile

@@ -0,0 +1,8 @@
+
+FROM python:latest
+
+COPY bin/ /app
+
+WORKDIR /app
+
+RUN pip install -r requirements.txt

py-srv/bin/app.py

@@ -0,0 +1,37 @@
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+
+app = Flask(__name__)
+app.config['SQLALCHEMY_DATABASE_URI'] = "postgresql://maria:pass@db:5432/beverage"
+app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+db = SQLAlchemy(app)
+
+class PopModel(db.Model):
+    __tablename__ = 'pop'
+
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String())
+    color = db.Column(db.String())
+
+    def __init__(self, name, color):
+        self.name = name
+        self.color = color
+
+@app.route('/pop')
+def handle_beverage():
+        pops = PopModel.query.all()
+        results = [
+            {
+                "name": pop.name,
+                "color": pop.color
+            } for pop in pops]
+
+        return {"count": len(results), "pop": results, "message": "success"}
+
+
+@app.errorhandler(404)
+def page_not_found(e):
+    return "<h1>404</h1><p>The resource could not be found.</p>", 404
+
+if __name__ == "__main__":
+    app.run(host ='0.0.0.0', port = 5000, debug = True)

py-srv/bin/requirements.txt

@@ -0,0 +1,3 @@
+Flask
+Flask-SQLAlchemy
+psycopg2

traefik/config.yml

@@ -0,0 +1,18 @@
+http:
+  routers:
+    traefik:
+      rule: "Host(`traefik.docker.localhost`)"
+      service: "api@internal"
+      tls:
+        domains:
+          - main: "docker.localhost"
+            sans:
+              - "*.docker.localhost"
+          - main: "domain.local"
+            sans:
+              - "*.domain.local"
+
+tls:
+  certificates:
+    - certFile: "/etc/certs/server.crt"
+      keyFile: "/etc/certs/server.key"

traefik/traefik.yml

@@ -0,0 +1,31 @@
+global:
+  sendAnonymousUsage: false
+
+api:
+  dashboard: true
+  insecure: true
+
+providers:
+  docker:
+    endpoint: "unix:///var/run/docker.sock"
+    watch: true
+    exposedByDefault: false
+
+  file:
+    filename: /etc/traefik/config.yml
+    watch: true
+
+log:
+  level: INFO
+  format: common
+
+entryPoints:
+  http:
+    address: ":80"
+    http:
+      redirections:
+        entryPoint:
+          to: https
+          scheme: https
+  https:
+    address: ":443"