https://github.com/zardazare/flask_on_k8s

A simple Python project to run a Flask application with Gunicorn on Minikube using Docker and Kubernetes. This setup includes building a Docker image and deploying the app on Minikube.
https://github.com/zardazare/flask_on_k8s

docker flask flask-application gunicorn helm helm-chart helmfile kubernetes minikube python

Last synced: 7 months ago
JSON representation

A simple Python project to run a Flask application with Gunicorn on Minikube using Docker and Kubernetes. This setup includes building a Docker image and deploying the app on Minikube.

• Host: GitHub
• URL: https://github.com/zardazare/flask_on_k8s
• Owner: zardazare
• Created: 2024-11-13T22:37:08.000Z (11 months ago)
• Default Branch: develop
• Last Pushed: 2024-11-29T20:18:10.000Z (10 months ago)
• Last Synced: 2025-01-21T20:22:21.010Z (9 months ago)
• Topics: docker, flask, flask-application, gunicorn, helm, helm-chart, helmfile, kubernetes, minikube, python
• Language: Go
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Flask with Gunicorn in Minikube

This is a simple setup for running a Flask application with Gunicorn on Minikube and Docker.



![Mypy Type Check](https://github.com/zardazare/flask_on_k8s/actions/workflows/mypy_code_check.yml/badge.svg?branch=develop)



## Prerequisites

- [Minikube](https://minikube.sigs.k8s.io/docs/start/) installed and running.

- [Docker](https://docs.docker.com/get-docker/) installed.

## Steps

1. **Build the Docker image**

    ```bash

    docker build -f docker/Dockerfile -t flask_on_k8s:latest .

    ```

    * After building the image, add it to Minikube's cache so it’s available for deployment:

    ```bash

    minikube image load flask_on_k8s:latest 

    ``` 

    * You can verify that the image is loaded with this command:

    ```bash

    minikube image list

    ```

    *Note: Cached images will have the `docker.io/library/` prefix.*

2. **Deploy to Minikube**

    Apply the Kubernetes deployment and service:

    ```bash

    kubectl apply -f deployment/deployment.yml

    ```

    - **Hint:** Example for starting multiple nodes:

    

    ```bash

    minikube start --nodes 3 -p multinode-test

    ```

3. **Access the Application**

    Get the URL of the service:

    ```bash

    minikube service flask-test-app-service --url

    ```

    Open the URL in a browser or use curl to see the response.

4. **Cleanup**

    To delete the deployment and service, run:

    ```bash

    kubectl delete -f deployment/deployment.yml

    ```

## Run Without Kubernetes

If you’d like to run the Docker container independently (outside Kubernetes) for testing, you can run it on a different external port (e.g., `9000`).

### Run container

- **Detached mode**

    ```bash

    docker run -d -p 9000:5000 --name=flask_with_gunicorn_localhost flask_on_k8s:latest

    ```

- **Interactive mode**

    ```bash

    docker run -it -p 9000:5000 --name=flask_with_gunicorn_localhost flask_on_k8s:latest sh

    ```

## Useful commands

- **Execute commands in container/pod**

    ```bash

    kubectl exec -it  -- /bin/sh

    ```

- **Restart deployment**

    ```bash

    kubectl rollout restart deployment/flask-test-app-deployment

    ```

- **Logs from container in deployment**

    ```bash

    kubectl logs deployment/flask-test-app-deployment -c flask-test-app

    ```

## Monitoring Setup

For detailed instructions on setting up and configuring the monitoring tools, check out the [Monitoring Documentation](monitoring/README.md).