jecklgamis/flask-app-example

An example Flask app using Python 3 and Docker.

flask-app-example

An example webapp using Flask.

Run example from Docker Hub:

docker run -p 8080:8080 -it jecklgamis/flask-app-example:main

What's In The Box?

• Ubuntu Docker image
• Gunicorn WSGI server
• Build info, liveness and readiness probe endpoints
• PyTest unit tests
• HTTP/HTTPS listeners
• Kubernetes deployment (Helm chart)

Requirements

• Python 3
• Docker
• Helm
• Make (optional)

Building

Install dependencies (make install-deps)

pip install -r requirements.txt

Build Docker image (make all)

./generate-ssl-certs.sh
./generate-build-info.sh
pytest -s
docker build -t flask-app-example:main .  

Running

Run the app in Docker (make run)

docker run -it flask-app-example:main

Run the app directly (./run-app.sh)

FLASK_DEBUG=true
flask run --host 0.0.0.0 --port 8080

Run the app directly using HTTPS (USE_SSL=true ./run-app.sh)

FLASK_DEBUG=true
flask run --cert  server.crt --key server.key --host 0.0.0.0 --port 8443

Testing

Run unit tests

pytest

Run some basic endpoint tests (make smoke-tests). Ensure the app is running.

./smoke-tests.py

Deploying

• This assumes you can deploy to a Kubernetes cluster from your machine.
• Ensure you have helm and yq installed.

For all the operations below, change directory to deployment/k8s/helm.

Create Helm chart (make package):

helm package ./chart

Install Helm chart (make install):

helm install flask-app-example flask-app-example-v1.0.0-rc.1.tgz

Delete Helm chart (make uninstall):

helm uninstall flask-app-example

Contributing

Please raise issue or pull request? Thanks.

Have fun!