백엔드 스터디 Day 8: 배포와 운영 환경 읽기

./gradlew bootRun

로컬에서 잘 돌아가는 코드가 있다
어딘가 서버에 올린다
서버에서 실행한다
끝

누가 실행해도 같은 방식으로 실행되는가?
서버가 재부팅돼도 다시 살아나는가?
환경별 설정이 분리되어 있는가?
비밀값이 코드에 들어가지 않았는가?
DB 연결 실패를 빨리 알아차릴 수 있는가?
로그를 보고 장애 원인을 추적할 수 있는가?
새 버전을 올릴 때 기존 기능이 깨지지 않는가?

- application.yml 안에 실제 DB 비밀번호가 들어 있다
- 로컬 H2 DB만 쓰도록 되어 있다
- Dockerfile이 없다
- 로그 설정이 없다
- 테스트 없이 바로 main에 배포한다
- 헬스체크 API가 없다
- 운영과 개발 설정이 섞여 있다

- 개발/dev, 운영/prod 프로필이 분리되어 있다
- 비밀값은 환경 변수로 주입한다
- Dockerfile이 있고 빌드 단계가 명확하다
- docker-compose로 앱과 DB를 함께 띄울 수 있다
- /actuator/health 같은 헬스체크가 있다
- CI에서 테스트와 빌드를 통과해야 배포한다
- 로그에 요청/에러 추적 정보가 남는다

README.md
build.gradle 또는 build.gradle.kts
settings.gradle
Dockerfile
docker-compose.yml
.github/workflows/*.yml
src/main/resources/application.yml
src/main/resources/application-dev.yml
src/main/resources/application-prod.yml

## Run locally

```bash
./gradlew bootRun
```

## Run with Docker

```bash
docker compose up --build
```

문서에 적힌 실행 방법이 실제 파일 구조와 맞는가?
로컬 실행만 있고 운영 실행 방법은 없는가?
DB, Redis, 외부 API 같은 의존 서비스는 어떻게 준비하는가?
환경 변수 목록이 문서화되어 있는가?

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/app
    username: app
    password: example-secret-placeholder
  jpa:
    hibernate:
      ddl-auto: update
server:
  port: 8080

DB는 어디에 있는가?
서버 포트는 몇 번인가?
JPA가 테이블을 자동으로 바꾸는가?
외부 API 키는 어디서 읽는가?
로그 레벨은 어떻게 되어 있는가?

spring:
  datasource:
    password: do-not-commit-password-placeholder
jwt:
  secret: do-not-commit-jwt-secret-placeholder

spring:
  datasource:
    url: ${DATABASE_URL}
    username: ${DATABASE_USERNAME}
    password: ${DATABASE_PASSWORD}
jwt:
  secret: ${JWT_SECRET}

필요한 환경 변수 목록이 README나 배포 문서에 적혀 있는가?
로컬 개발용 예시 값은 .env.example 같은 파일에 안전하게 제공되는가?
실제 비밀값이 git에 들어가 있지 않은가?

DATABASE_URL=jdbc:postgresql://localhost:5432/app
DATABASE_USERNAME=app
DATABASE_PASSWORD=example-password
JWT_SECRET=example-secret-placeholder

로컬 개발:
- 내 컴퓨터에서 실행
- 테스트용 DB 사용
- 로그를 자세히 출력
- 실패해도 사용자 영향이 작음

운영:
- 실제 서버에서 실행
- 실제 DB 사용
- 비밀값 관리 필요
- 장애가 사용자에게 바로 영향

application.yml
application-dev.yml
application-prod.yml

spring:
  profiles:
    active: dev
server:
  port: 8080

spring:
  datasource:
    url: jdbc:h2:mem:testdb
  jpa:
    hibernate:
      ddl-auto: create-drop
logging:
  level:
    com.example.app: DEBUG

spring:
  datasource:
    url: ${DATABASE_URL}
    username: ${DATABASE_USERNAME}
    password: ${DATABASE_PASSWORD}
  jpa:
    hibernate:
      ddl-auto: validate
logging:
  level:
    com.example.app: INFO

create-drop: 실행할 때 테이블을 만들고 종료할 때 지움. 테스트용.
update: Entity에 맞춰 테이블을 자동 변경. 편하지만 운영에서는 위험할 수 있음.
validate: Entity와 DB 스키마가 맞는지만 확인. 운영에서 더 안전한 편.
none: 자동으로 아무것도 하지 않음.

운영 DB 구조 변경은 자동으로 조용히 일어나면 위험하다.
변경 이력이 남고, 되돌릴 수 있고, 배포 전에 확인 가능해야 한다.

FROM eclipse-temurin:21-jdk AS build
WORKDIR /app
COPY gradlew .
COPY gradle gradle
COPY build.gradle settings.gradle ./
COPY src src
RUN ./gradlew bootJar

FROM eclipse-temurin:21-jre
WORKDIR /app
COPY --from=build /app/build/libs/*.jar app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "app.jar"]

1단계 build:
- JDK가 있는 이미지에서 코드를 복사한다
- Gradle로 jar 파일을 만든다

2단계 runtime:
- 더 가벼운 JRE 이미지에서 jar만 복사한다
- 8080 포트를 연다
- java -jar app.jar로 실행한다

빌드 단계와 실행 단계가 분리되어 있는가?
소스 전체와 비밀 파일을 이미지에 복사하지 않는가?
실행 포트가 application.yml과 맞는가?
운영 프로필은 어떻게 지정하는가?
컨테이너가 죽었을 때 다시 시작되는 설정은 어디에 있는가?

COPY . .

.env
.git
build
.idea
node_modules

Spring Boot 앱
PostgreSQL DB
Redis
메시지 큐
검색 엔진

services:
  app:
    build: .
    ports:
      - "8080:8080"
    environment:
      SPRING_PROFILES_ACTIVE: prod
      DATABASE_URL: jdbc:postgresql://db:5432/app
      DATABASE_USERNAME: app
      DATABASE_PASSWORD: example-password
    depends_on:
      - db

  db:
    image: postgres:16
    environment:
      POSTGRES_DB: app
      POSTGRES_USER: app
      POSTGRES_PASSWORD: example-password
    ports:
      - "5432:5432"
    

DATABASE_URL: jdbc:postgresql://db:5432/app

volumes:
  - postgres_data:/var/lib/postgresql/data

앱 프로세스가 살아 있는가?
DB 연결이 가능한가?
필수 외부 의존성이 동작하는가?

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
}

management:
  endpoints:
    web:
      exposure:
        include: health,info
  endpoint:
    health:
      probes:
        enabled: true

GET /actuator/health

{
  "status": "UP"
}

헬스체크가 인증 없이 너무 많은 정보를 노출하지 않는가?
운영에서 필요한 endpoint만 열려 있는가?
DB 연결 상태도 반영되는가?
배포 플랫폼이 이 endpoint를 실제로 쓰는가?

management:
  endpoints:
    web:
      exposure:
        include: "*"

요청이 들어왔는가?
어떤 사용자/요청 ID였는가?
어떤 예외가 발생했는가?
DB 오류인지 외부 API 오류인지 구분되는가?
비밀번호/토큰 같은 민감 정보가 로그에 찍히지 않는가?

ERROR orderId=123 userId=45 requestId=abc-123 message="Payment approval failed" reason="timeout"

ERROR failed

Authorization: Bearer ***
password=***

log.info("login request: {}", request);
log.error("payment failed", exception);

name: CI

on:
  pull_request:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: "21"
      - run: ./gradlew test
      - run: ./gradlew bootJar

PR에서 테스트가 도는가?
main에 push할 때 빌드가 도는가?
테스트 실패해도 배포가 진행되지는 않는가?
비밀값을 로그로 출력하지 않는가?
배포 대상 환경이 명확한가?
캐시나 의존성 설치가 과하게 복잡하지 않은가?

- run: ./gradlew bootJar -x test

- run: echo $DATABASE_PASSWORD

README에 로컬 실행 방법이 있는가?
Docker 실행 방법이 있는가?
필요한 환경 변수 목록이 있는가?
DB나 Redis 같은 의존 서비스 준비 방법이 있는가?

application.yml, application-dev.yml, application-prod.yml이 분리되어 있는가?
운영 비밀값이 환경 변수로 주입되는가?
운영에서 ddl-auto가 update/create-drop로 되어 있지는 않은가?
서버 포트, CORS, 로그 레벨이 환경별로 맞는가?

Dockerfile이 실제로 jar를 빌드하고 실행하는가?
빌드 단계와 실행 단계가 분리되어 있는가?
.dockerignore가 있는가?
이미지에 .env나 불필요한 파일이 들어가지 않는가?
컨테이너 포트와 앱 포트가 맞는가?

DB 연결 설정이 환경 변수 기반인가?
로컬 DB와 운영 DB가 분리되어 있는가?
스키마 변경 방식이 명확한가?
Flyway/Liquibase 같은 마이그레이션 도구를 쓰는가, 아니면 수동 관리인가?

/actuator/health 같은 헬스체크가 있는가?
운영에서 너무 많은 actuator endpoint를 열지 않는가?
에러 로그가 원인을 추적할 수 있을 만큼 남는가?
민감 정보가 로그에 찍히지 않는가?

PR 또는 push 때 테스트와 빌드가 도는가?
테스트를 기본으로 건너뛰지 않는가?
배포 전에 실패를 막는 단계가 있는가?
비밀값을 안전하게 주입하는가?

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/app

jwt:
  secret: do-not-commit-jwt-secret-placeholder

jwt:
  secret: ${JWT_SECRET:example-secret-placeholder}

- run: ./gradlew bootJar -x test

management:
  endpoints:
    web:
      exposure:
        include: "*"

log.info("request={}", request);

빌드 명령어가 무엇인가?
환경 변수는 어디서 주입되는가?
API base URL은 환경별로 다른가?
정적 파일이 어디로 배포되는가?

서버 프로세스가 계속 살아 있는가?
DB 연결이 유지되는가?
마이그레이션이 안전한가?
로그와 헬스체크가 있는가?
비밀값이 안전하게 주입되는가?

프론트엔드가 https://api.example.com 을 호출한다
백엔드는 8080 포트에서 뜬다
프록시나 로드밸런서가 443 -> 8080으로 연결한다
CORS가 프론트엔드 도메인을 허용한다
헬스체크가 통과해야 트래픽을 받는다

Dockerfile
docker-compose.yml
src/main/resources/application.yml
.github/workflows/ci.yml
README.md

로컬 실행 명령어는?
Docker 실행 명령어는?
필수 환경 변수는?

DB URL은 어디서 오나?
비밀번호가 코드에 있나?
dev/prod 프로필이 분리되어 있나?
운영 ddl-auto가 안전한가?

Dockerfile이 jar를 만드는가?
.dockerignore가 있는가?
docker-compose에서 app과 db가 연결되는가?
volume이 있는가?

health endpoint가 있는가?
로그에 민감 정보가 남지 않는가?
CI에서 테스트와 빌드가 도는가?

운영 DB 스키마 변경은 어떻게 관리하나요?
비밀값은 어디에서 주입하나요?
장애가 나면 어떤 로그로 추적하나요?
배포 실패 시 롤백 방법이 있나요?
헬스체크 실패 시 자동 재시작되나요?

배포 = 코드를 서버에 올리는 행위가 아니라,
같은 조건으로 안전하게 실행되도록 만드는 구조

실행 문서
환경 변수
프로필 분리
Dockerfile
Docker Compose
DB 마이그레이션
헬스체크
로그
CI/CD

이 설정은 로컬 전용인가, 운영도 고려했는가?
비밀값이 코드나 로그에 남지 않는가?
서버가 죽거나 DB 연결이 실패했을 때 알아차릴 수 있는가?
배포 전에 테스트와 빌드가 자동으로 검증되는가?
DB 변경이 통제 가능한가?