Files
portfolio-hub/docs/srs/Documentation/req-003_local-db-operations-runbook-and-baseline-updates.md
T
genichin 9f4a88bef8 docs(dcy/srs): add DCY-001 discovery and REQ-001/002/003 requirements
Introduces discovery for real DB migration validation and operations readiness:
- dcy-001_20260430_real-db-migration-validation-and-operations-readiness.md
- REQ-001: Local DB validation scenarios (Testing)
- REQ-002: Alembic runtime schema ownership (Migration)
- REQ-003: Local DB operations runbook and baseline updates (Documentation)

Updates discovery and SRS indexes to include new documents.
2026-04-30 14:20:11 +00:00

4.9 KiB

req-003: 로컬 DB 운영 runbook 및 baseline 문서 갱신

  • Status: Approved
  • Type: Documentation
  • Priority: Medium
  • Owner: repository-maintainers

Intent

  • 이 요구사항은 로컬 docker compose 기반 DB 검증 결과를 운영자가 반복 사용할 수 있는 runbook과 baseline 문서로 정리하기 위한 문서화 backlog를 정의한다.
  • README, docs/runtime-flows.md, docs/project-structure.md에 로컬 DB 준비 절차, release gate 기준, rollback 또는 재시도 판단 기준을 반영하는 것이 목표다.

Requirement

  • 프로젝트는 로컬 docker compose 기반 DB 검증 범위를 반영해 README, docs/runtime-flows.md, docs/project-structure.md를 갱신해야 하며, init-db와 migrate-db 실행 흐름, release gate 증거, rollback 또는 재시도 판단 기준을 운영자가 추적 가능한 runbook 형태로 정리해야 한다.

Acceptance Criteria

  1. Given 로컬 DB validation 범위가 확정되어 있을 때, When README를 갱신하면, Then docker compose 기반 준비 절차, init-db와 migrate-db 실행 순서, health-check 및 smoke flow 검증 기준이 포함되어 있어야 한다.
  2. Given Alembic와 runtime ownership 경계가 정리될 때, When docs/project-structure.md와 docs/runtime-flows.md를 갱신하면, Then 구조 제약과 실행 흐름 제약이 baseline 문서에 반영되어 있어야 한다.
  3. Given 이번 Discovery의 release gate가 로컬 DB validation 기준으로 확정되어 있을 때, When 운영 runbook을 작성하면, Then rollback 또는 재시도 판단 기준과 남겨야 할 검증 로그가 문서에 명시되어 있어야 한다.

Impacted Area

  • Docs: README.md, docs/project-structure.md, docs/runtime-flows.md, docs/discovery/dcy-001_20260430_real-db-migration-validation-and-operations-readiness.md
  • Modules: app/cli/commands/health.py, app/db/migrations.py, app/repositories/postgres.py
  • Tests: 문서 기반 수동 검증 체크리스트와 release gate evidence review 절차

Notes

  • 이 요구사항은 dcy-001의 FR-3 일부, FR-4, NFR-3, S-3을 구현 가능한 Documentation 단위로 정규화한 것이다.
  • baseline 문서 전체를 복제하지 않고, 로컬 DB 검증과 직접 관련된 구조 제약과 흐름 제약만 업데이트 대상으로 삼는다.
  • 성공 지표의 세부 artifact 위치는 REQ 승인 또는 batch planning에서 확정할 수 있다.

Change Log

CHG-20260430-02

  • Date: 2026-04-30
  • Author: GitHub Copilot

Change Summary

  • confirm-req 승인 게이트를 통과해 이 REQ를 Approved로 전환했다.

Intent

  • dcy-001의 delivery input으로 사용할 수 있는 확정 requirement로 승격하기 위해 상태를 변경했다.

Acceptance Criteria Delta

  • Added:
    • none
  • Updated:
    • none
  • Removed:
    • none

Impacted Area Delta

  • Docs:
    • docs/srs/index.md
  • Modules:
    • none
  • Tests:
    • none

Delivery Trace Delta

  • Batches:
    • none
  • Releases:
    • none

Revalidation Impact

  • Reverification Needed: no
  • Existing Implementation Invalidated: no
  • Status Recommendation: approved
  • Follow-up Action: suggest-batch-reqs 또는 draft-batch 단계에서 REQ-003의 runbook 산출물 범위를 delivery scope로 연결한다.

Validation Plan

  • REQ 본문 필수 섹션, Acceptance Criteria 구체성, docs/srs/index.md 상태 동기화를 확인한다.

CHG-20260430-01

  • Date: 2026-04-30
  • Author: GitHub Copilot

Change Summary

  • dcy-001에서 로컬 DB 운영 runbook 및 baseline 문서 갱신 요구사항을 신규 Proposed REQ로 생성했다.

Intent

  • 운영 준비 산출물과 baseline 문서 갱신 요구를 독립 Documentation backlog로 관리하기 위해 생성했다.

Acceptance Criteria Delta

  • Added:
    • README 로컬 DB 검증 절차 갱신 기준 정의
    • docs/project-structure.md와 docs/runtime-flows.md baseline 갱신 기준 정의
    • rollback 또는 재시도 판단 기준과 로그 수집 기준 정의
  • Updated:
    • none
  • Removed:
    • none

Impacted Area Delta

  • Docs:
    • README.md
    • docs/project-structure.md
    • docs/runtime-flows.md
    • docs/discovery/dcy-001_20260430_real-db-migration-validation-and-operations-readiness.md
  • Modules:
    • app/cli/commands/health.py
    • app/db/migrations.py
    • app/repositories/postgres.py
  • Tests:
    • 문서 기반 수동 검증 체크리스트와 release gate evidence review 절차

Delivery Trace Delta

  • Batches:
    • none
  • Releases:
    • none

Revalidation Impact

  • Reverification Needed: no
  • Existing Implementation Invalidated: no
  • Status Recommendation: keep-current
  • Follow-up Action: confirm-req 단계에서 baseline 문서 갱신 범위와 runbook 산출물 위치를 검토하고 승인한다.

Validation Plan

  • confirm-req 전까지 Acceptance Criteria가 dcy-001의 FR-3 일부, FR-4, NFR-3, S-3와 일치하는지 검토하고, 이후 batch 단계에서 README 및 baseline 문서 갱신안을 작성한다.