Skip to content

미니PC 운영 런북 추가#20

Merged
SmileJune merged 1 commit into
mainfrom
ai/mini-pc-operations-runbook
Jun 1, 2026
Merged

미니PC 운영 런북 추가#20
SmileJune merged 1 commit into
mainfrom
ai/mini-pc-operations-runbook

Conversation

@SmileJune

@SmileJune SmileJune commented Jun 1, 2026

Copy link
Copy Markdown
Owner

승인된 내용

사용자가 다음 작업 진행을 요청했고, 직전 추천 작업이었던 mini PC 운영 런북 정리를 진행했습니다.

변경 사항

  • docs/mini-pc-operations.md를 추가했습니다.
  • README 관련 문서 목록에 운영 런북 링크를 추가했습니다.
  • 개발 로그에 78. Mini PC 운영 런북 정리 항목을 추가했습니다.
  • 런북에 PR #19의 웹 배포 스크립트(scripts/deploy/mini-pc-web.sh)와 --smoke-only 확인 절차를 연결했습니다.

의도적으로 제외한 것

  • 운영 설정, 비밀값, Caddy 설정, systemd unit, Docker compose 설정은 변경하지 않았습니다.
  • 기존 ai/mini-pc-ops-runbook 브랜치에 있던 infra/docker-compose.yml 포트 바인딩 변경은 이번 PR에서 제외했습니다.
  • API 재시작, 수동 ingest 실행처럼 운영 상태를 바꾸는 런북 명령은 검증 중 실행하지 않았습니다.

검증

  • rg -n "<<<<<<<|=======|>>>>>>>" README.md docs/mini-pc-operations.md docs/development-log.md -> conflict marker 없음
  • test -f docs/mini-pc-web-deploy.md && test -f docs/mini-pc-operations.md
  • scripts/deploy/mini-pc-web.sh --smoke-only -> 성공
  • ssh home-2 'systemctl --user status techcase-api.service --no-pager' -> active
  • ssh home-2 'docker ps --filter name=techcase ...' -> PostgreSQL/Elasticsearch healthy, Caddy/Kibana running
  • PostgreSQL article count 2196, Elasticsearch articles _count 2196
  • RAG 관련도순 검색 total 41

사람이 확인할 방법

  1. docs/mini-pc-operations.md의 운영 절차가 실제 운영 경로와 맞는지 확인합니다.
  2. scripts/deploy/mini-pc-web.sh --smoke-only를 실행해 공개 엔드포인트를 확인합니다.
  3. 필요하면 런북의 읽기 전용 SSH/Docker 확인 명령을 mini PC에서 실행합니다.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Mini PC operations runbook covering web deployment procedures, smoke checks, service status verification, data consistency checks, and log inspection guidance. Includes procedures for manual task execution, HTTPS certificate validation, and service restarts with health verification.

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2369e9c6-5ee1-4d5d-86a3-5cf8ba084391

📥 Commits

Reviewing files that changed from the base of the PR and between c5abd6b and 5ed1eb1.

📒 Files selected for processing (3)
  • README.md
  • docs/development-log.md
  • docs/mini-pc-operations.md

📝 Walkthrough

Walkthrough

This PR adds a new mini PC operations runbook documenting deployment, health verification, service status checks, data consistency validation, log inspection, configuration management, and API restart procedures. The runbook is registered in the README and development log with scope boundaries.

Changes

Mini PC Operations Runbook

Layer / File(s) Summary
Documentation index and scope
README.md, docs/development-log.md
README links to the new runbook; development-log documents the runbook scope including deployment procedures, smoke checks, service/data verification, logs, scheduler checks, HTTPS validation, port exposure checks, and API restart, explicitly excluding infrastructure changes such as local Docker port bindings.
Runbook introduction and web deployment
docs/mini-pc-operations.md
Runbook title, operational purpose, secret-handling guidelines, documented public endpoints, runtime/service directory expectations, and web deployment procedures using the mini-pc-web.sh script with smoke-only invocation.
Health verification and service status checks
docs/mini-pc-operations.md
External smoke-check commands for /, /health, /api/search, and /api/suggest endpoints with expected normal-state responses, plus systemd user service/timer status inspection and docker container runtime/status verification.
Data consistency and operational monitoring
docs/mini-pc-operations.md
PostgreSQL to Elasticsearch article count consistency checks, search API total response guidance, log inspection via journalctl and docker compose, and ingest scheduler check workflow with manual trigger instructions and follow-up verification.
Configuration validation and API service restart
docs/mini-pc-operations.md
Caddy configuration validation and reloading procedures, HTTPS certificate verification via external curl requests for service redirects, port exposure verification ensuring 5432/9200/5601 are not externally reachable, and API service restart via systemd followed by health and search smoke-check re-verification.

🎯 1 (Trivial) | ⏱️ ~3 minutes

📚 A runbook for ops so fine,
With deployment steps laid out in line,
From health checks to Caddy's HTTPS glow,
We verify that services flow and flow,
Mini PC operations now run aglow! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title '미니PC 운영 런북 추가' (Mini PC Operations Runbook Added) directly and clearly describes the main change: addition of operational runbook documentation for mini PC. It is concise, specific, and accurately reflects the primary objective of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ai/mini-pc-operations-runbook

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@SmileJune SmileJune marked this pull request as ready for review June 1, 2026 07:20
@SmileJune SmileJune merged commit ff44339 into main Jun 1, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant