Containerize Application via Dockerfile by hepheir · Pull Request #1 · tle-ko/auth-service

hepheir · 2025-11-26T06:17:34Z

향후 애플리케이션 배포 및 개발환경 재현을 위한 컨테이너화를 수행합니다.

컨테이너 이미지 빌드를 위한 Dockerfile 을 작성했으며,
컨테이너 상태 검사를 위한 /health 엔드포인트 구현 및 Dockerfile 의 HEALTHCHECK 옵션을 사용하도록 구성하였습니다.

개발환경 재현을 위한 Docker Compose 설정도 구성해두었으며, 기본 DB로 PostgreSQL을 사용합니다.

- Implement GET /health - Add Dockerfile HEALTHCHECK Reason: 컨테이너 생존 여부를 검사하기 위한 수단이 필요하여 구현.

Copilot

Pull request overview

This PR containerizes a Django REST Framework application by adding a Dockerfile, health check endpoint, and container startup scripts. The implementation enables deployment via Docker containers and provides container health monitoring capabilities.

Key Changes

Added Dockerfile with Python 3.9 base image, environment configuration, and health check support
Implemented /health/ endpoint for container health monitoring with Swagger documentation
Created entrypoint and healthcheck scripts for container lifecycle management

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
Dockerfile	Defines container image build with Python environment, dependencies installation, and health check configuration
healthcheck.sh	Shell script that curls the health endpoint to verify container status
entrypoint.sh	Container startup script that runs migrations and starts Django development server
app/views.py	Adds health check view function with HTTP 200 response and Swagger documentation
app/urls.py	Registers `/health/` URL route for container health checks

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Dockerfile

entrypoint.sh

Dockerfile

app/views.py

healthcheck.sh

Dockerfile

…ommand in Dockerfile

Copilot

Pull request overview

Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-27T04:18:47Z

Dockerfile

+RUN /app/manage.py migrate --no-input
+ENTRYPOINT ["gunicorn", "app.wsgi:application", "--bind", "0.0.0.0:8000"]


Running migrations during the image build (at RUN time) is incorrect. Migrations should be run when the container starts (at runtime), not during the build process, because:

The database may not be available during build time

The same image should be deployable to different environments with different database states

This will cause the build to fail if no database is accessible

Move this to a startup script or use CMD instead. For example:

CMD python manage.py migrate --no-input && gunicorn app.wsgi:application --bind 0.0.0.0:8000

Or create a separate entrypoint script that runs migrations before starting gunicorn.

Suggested change

RUN /app/manage.py migrate --no-input

ENTRYPOINT ["gunicorn", "app.wsgi:application", "--bind", "0.0.0.0:8000"]

CMD python manage.py migrate --no-input && gunicorn app.wsgi:application --bind 0.0.0.0:8000

로컬 SQLite DB를 사용하는 동안에만 필요한 커맨드이므로 지금은 유지하고, 추후 DB 컨테이너 분리시에 migrate 명령을 제거하도록 조치하겠습니다.

85acb0d 커밋에서 마이그레이션 로직을 조건부로 수행하도록 조치하였습니다.

app/views.py

Dockerfile

Copilot · 2025-11-27T05:04:31Z

@hepheir I've opened a new pull request, #2, to work on those changes. Once the pull request is ready, I'll request review from you.

.gitignore 파일의 내용과 1줄을 제외하고 동일합니다. 해당 1개 줄은 .gitignore에 .dockerignore를 무시하지 않도록 추가하는 한 줄입니다.

Swagger UI, Admin 페이지 편의를 위하여 추가

…록 변경

…ests

잠재적 DB garbage connection 이슈 보완

…ment variable 잠재적 설정 타입오류는 Django 의 ImproperlyConfigured 오류에 의존하도록 함

Copilot

Pull request overview

Copilot reviewed 10 out of 12 changed files in this pull request and generated 12 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

app/env.py

app/views.py

Dockerfile

entrypoint.sh

docker-compose.develop.yml

Copilot · 2025-11-29T07:02:53Z

app/settings.py

 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+DEBUG = env.get_bool('DEBUG', default=False)



The default ALLOWED_HOSTS configuration only includes localhost and 127.0.0.1, but in containerized environments, requests may come from different hostnames (e.g., the service name tle-auth-service, or external load balancers). Consider documenting this limitation in the README or adding a note that ALLOWED_HOSTS should be configured via the ALLOWED_HOSTS environment variable for production deployments.

Suggested change

# WARNING: The default ALLOWED_HOSTS is only suitable for local development.

# In production or containerized environments, you MUST set the ALLOWED_HOSTS environment variable

# to include all hostnames and domains that will access this service (e.g., service names, load balancers, external domains).

README.md

app/views.py

docker-compose.develop.yml

Copilot · 2025-11-29T07:02:54Z

app/env.py

+    if value is not None:
+        retval = value.strip()


[nitpick] The environment variable stripping in the get() function could remove intentional whitespace. While stripping is generally desirable for most configuration values, there might be edge cases where leading/trailing whitespace is intentional (e.g., formatted strings). Consider documenting this behavior in the function's docstring to make it explicit that values are stripped.

… files

…록 수정

…eError` in `HealthCheckAPIView`

…ead of specific `DatabaseError`

hepheir added 5 commits November 25, 2025 13:11

chore: initialize Django project

a1b252c

chore: install DRF and Swagger

7db2ad1

feat(swagger): add /swagger/ endpoint for Swagger support

0f2be0f

build(docker): add Dockerfile

5f7eb5b

feat: add /health endpoint and Docker HEALTHCHECK

3314675

- Implement GET /health - Add Dockerfile HEALTHCHECK Reason: 컨테이너 생존 여부를 검사하기 위한 수단이 필요하여 구현.

hepheir requested a review from Copilot November 26, 2025 06:17

Copilot started reviewing on behalf of hepheir November 26, 2025 06:17 View session

Copilot finished reviewing on behalf of hepheir November 26, 2025 06:20

Copilot AI reviewed Nov 26, 2025

View reviewed changes

hepheir added 7 commits November 26, 2025 16:13

build(docker): change image python:3.9 to python:3.11-slim

c5ba2b4

fix(docker): improve Dockerfile structure and healthcheck configuration

7082a8d

fix(views): add /health endpoint가 GET 요청만 처리하도록 수정

3f35757

fix(entrypoint): ensure script exits on error by adding set -e

3944e80

build(docker): use gunicorn to run server & removed entrypoint.sh

c4359e8

fix(docker): add RUN command to install curl

b2ff57d

build(docker): replace healthcheck script with inline HEALTHCHECK c…

6848d6d

…ommand in Dockerfile

hepheir requested a review from Copilot November 27, 2025 04:15

Copilot started reviewing on behalf of hepheir November 27, 2025 04:15 View session

Copilot finished reviewing on behalf of hepheir November 27, 2025 04:17

Copilot AI reviewed Nov 27, 2025

View reviewed changes

build(docker): gunicorn 이 멀티스레드로 동작하도록 변경 (4 workers, 2 threads)

22f6ee5

Copilot AI mentioned this pull request Nov 27, 2025

Remove unused swagger_auto_schema import and decorator #2

Closed

hepheir added 4 commits November 27, 2025 14:24

build(docker): use non-root user for security best practices

8578187

chore(docker): migrate 명령을 제거하라는 TODO 메시지 삽입

c30f0e1

chore(gitignore): 최상위 경로의 .으로 시작하는 파일/폴더를 무시하도록 변경

b078b7e

chore: add .dockerignore

f8a2311

.gitignore 파일의 내용과 1줄을 제외하고 동일합니다. 해당 1개 줄은 .gitignore에 .dockerignore를 무시하지 않도록 추가하는 한 줄입니다.

hepheir force-pushed the feature/dockerize branch from 77a36ed to f8a2311 Compare November 27, 2025 05:31

hepheir added 2 commits November 27, 2025 20:29

settings: SECRET_KEY, DEBUG, ALLOWED_HOSTS 속성을 환경변수에서 불러오도록 변경

24dab47

feat: static 경로 추가

52d0d66

Swagger UI, Admin 페이지 편의를 위하여 추가

hepheir added 10 commits November 29, 2025 11:40

refactor(settings): enforce non-empty ALLOWED_HOSTS configuration

0204747

refactor(app.env): 환경변수 파싱 로직에서 early return 지양

3ae8000

refactor(app.env): get_array()의 인자명 변경 allow_empty -> empty

4cbca7e

feat(app.env): add get_json() support JSON parsed value

da574ea

test(app.env): add JSON parsing tests for environment variables

8f4b0d0

refactor(app.settings): ALLOWED_HOSTS 환경변수를 env.get_json()으로 불러오도…

09d90a2

…록 변경

refactor(app.env): remove unused get_array() function and related t…

1b22925

…ests

fix(app.views): health check시 DB 커넥션 연결 확인 후 커넥션을 종료하도록 수정

1fd668a

잠재적 DB garbage connection 이슈 보완

refactor(app.settings): remove validation for ALLOWED_HOSTS environ…

63b9cd1

…ment variable 잠재적 설정 타입오류는 Django 의 ImproperlyConfigured 오류에 의존하도록 함

refactor(entrypoint.sh): collectstatic 오류 발생시 무시하지 않도록 수정하고 주석에 이유를 명시

8720421

hepheir force-pushed the feature/dockerize branch from 624fe16 to 8720421 Compare November 29, 2025 06:56

hepheir requested a review from Copilot November 29, 2025 06:57

Copilot started reviewing on behalf of hepheir November 29, 2025 06:57 View session

Copilot finished reviewing on behalf of hepheir November 29, 2025 07:01

Copilot AI reviewed Nov 29, 2025

View reviewed changes

hepheir added 12 commits November 29, 2025 16:25

refactor(entrypoint.sh): main 함수가 최상단으로 가도록 수정

d89f9d4

feat(entrypoint.sh): DB가 ready 될 때까지 기다리는 로직 추가

3353f2f

feat(app.env): 파일 콘텐츠를 읽어올 때 strip 하도록 변경

9e78309

test(app.env): 파일 콘텐츠를 읽어올 때 strip 하는지 검사하는 단위테스트 작성

8b870dd

build(docker): update develop sync configuration to ignore additional…

0698fa0

… files

build(docker): Dockerfile 최적화 - 의존성 설치 과정을 병합하여 이미지 레이어 개수 감소

966dd8d

chore(app.env): get_json() 함수에 대한 docstring 추가

2e2f272

docs: 환경변수 설명에 ALLOWED_HOSTS 추가

506a12f

fix(app.views): HealthCheckAPIView 에서 연결오류 외의 DatabaseError 도 다루도…

c0519cc

…록 수정

test(app.tests): add tests for handling DatabaseError and `Interfac…

5abc80d

…eError` in `HealthCheckAPIView`

fix(app.views): handle unexpected errors in HealthCheckAPIView inst…

211ee01

…ead of specific `DatabaseError`

build(docker-compose): ensure tle-auth-service always restarts

e9818f5

hepheir force-pushed the develop branch 3 times, most recently from f40bf03 to 1b8433a Compare December 4, 2025 17:43

		RUN /app/manage.py migrate --no-input
		ENTRYPOINT ["gunicorn", "app.wsgi:application", "--bind", "0.0.0.0:8000"]

+# WARNING: The default ALLOWED_HOSTS is only suitable for local development.
+# In production or containerized environments, you MUST set the ALLOWED_HOSTS environment variable
+# to include all hostnames and domains that will access this service (e.g., service names, load balancers, external domains).

Conversation

hepheir commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

hepheir Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

hepheir Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Nov 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hepheir commented Nov 26, 2025 •

edited

Loading

hepheir Nov 27, 2025 •

edited

Loading