Docker+Flask+PostgresでDocker環境を構築

概要

• Docker
• Flask
• Postgres

を使ってコンテナ環境を構築する方法について解説します
また、コンテナを起動させる際にヘルスチェックを行います

前提

• Docker、Flask、Postgres、Poetryに関する基礎知識を有している
• Flaskのプロジェクトを作成済み
• コンテナ環境を構築する方法について説明するのでDBとの接続方法については本記事では解説しません

ディレクトリ構成

tree
.
├── application
│   ├── main.py
│   ├── poetry.lock
│   └── pyproject.toml
├── containers
│   ├── flask
│   │   ├── Dockerfile
│   │   └── entrypoint.sh
│   └── postgres
│       └── Dockerfile
├── .gitignore
├── .env
└── docker-compose.yml

実装

• pyproject.toml
• FlaskのDockerfile
• PostgresのDockerfile
• .env
• docker-compose.yml
• entrypoint.sh

の順に作成していきます

pyproject.toml

Poetryを使ったPythonのパッケージの管理をする際にpyproject.tomlファイルが必要になります
今回は

• python
• flask
• psycopg2

が必要なので以下のように記載します

application/pyproject.toml

[tool.poetry]
name = "flask-practice"
version = "0.1.0"
description = ""
authors = ["shun198 <[e-mail]>"]
readme = "README.md"
packages = [{include = "flask_practice"}]

[tool.poetry.dependencies]
python = "3.12.8"
flask = "^3.1.0"
psycopg2 = "^2.9.10"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

FlaskのDockerfile

containers/flask/Dockerfile

FROM python:3.12.8
ENV PYTHONDONTWRITEBYTECODE=1
ENV PYTHONUNBUFFERED=1
WORKDIR /code
COPY application/pyproject.toml /code/
RUN pip install --upgrade pip && \
    pip install poetry
RUN poetry install
COPY ./containers/flask/entrypoint.sh /usr/local/bin/entrypoint.sh
RUN chmod +x /usr/local/bin/entrypoint.sh

PostgresのDockerfile

containers/postgres/Dockerfile

FROM postgres:16.2

.env

.env

POSTGRES_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres

docker-compose.yml

docker-compose.yml

version: "3.9"

services:
  db:
    container_name: db
    build:
      context: .
      dockerfile: containers/postgres/Dockerfile
    volumes:
      - db_data:/var/lib/postgresql/data
    # ヘルスチェックを使ってPostgresのコンテナより先にFlaskが起動しないようにする
    healthcheck:
      test: pg_isready -U "${POSTGRES_USER:-postgres}" || exit 1
      interval: 10s
      timeout: 5s
      retries: 5
    environment:
      - POSTGRES_NAME
      - POSTGRES_USER
      - POSTGRES_PASSWORD
    ports:
      - "5432:5432" # デバッグ用
  app:
    container_name: app
    build:
      context: .
      dockerfile: containers/flask/Dockerfile
    volumes:
      - ./application:/code
    ports:
      - "8000:8000"
    command: sh -c "/usr/local/bin/entrypoint.sh"
    env_file:
      - .env
    depends_on:
      db:
        condition: service_healthy
volumes:
  db_data:

entrypoint.shを使ってFlaskのアプリケーションを起動させます
コンテナ内のFlaskを起動させるため、-h 0.0.0.0、今回は8000番ポートで起動させたいので-p 8000を指定します

entrypoint.sh

#!/bin/sh
set -eu

poetry run flask --app main run --debug -h 0.0.0.0 -p 8000

main.py

main.pyを使ってFlaskのアプリケーションを起動します
今回はヘルスチェック用のAPIを作成します

main.py

from flask import Flask

app = Flask(__name__)

@app.route("/api/health")
def health():
    return {"msg": "pass"}

コンテナの設定およびAPIの作成が完了したら以下のコマンドでDockerfileのbuildとコンテナの起動を実現します

docker compose up -d --build

127.0.0.1:8000/api/healthへアクセスし、以下のようにヘルスチェックが正常に実行できたら成功です

参考