Files
clean-architecture-backend-…/docs/runbooks/management-actuator-forbidden.md
T
DongHyeonka 0fded57cb3
pr / done (pull_request) Canceled after 0s
docs(runbooks): runbook 신호를 지금 코드가 내는 응답·로그·지표로 고친다
runbook이 코드가 내지 않는 신호로 장애를 찾게 한다. actuator·cross-tenant
runbook은 아무 코드도 내지 않는 ACTUATOR_FORBIDDEN·AUTHZ_TENANT_MISMATCH를
증상으로 적고, 없는 경보·지표·로그 칸을 적는다. auth runbook은 로그에서
token payload·Authorization 원문을 보라고 하고(남지도 않고 남겨서도 안
된다), 없는 JWKS 캐시 손잡이와 decoder가 읽지 않는 Spring issuer 키를
적는다. rate-limit·dependency runbook은 없는 gateway 지표·헤더·
CACHE_UNAVAILABLE·dependency_name 칸을, web runbook은 연산마다의 TTL,
시험 도구 GracefulShutdownProbe, 없는 tag routeTemplate, 기동이 거부하는
CORS 설정을 「기동은 된다」고 적는다. job runbook은 내는 코드가 없는
JOB_DEAD_LETTER·JOB_TIMEOUT과 job.* 지표에 경보를 걸게 한다.

각 runbook을 지금 코드가 내는 신호로 다시 쓴다: 응답 코드·헤더, 보안
로그 줄 `security failure: code=… path=…`, 요청 로그 줄, ServerFailureLog
의 고정 문구(`dependency failure classified as … dependency=<이름>`,
`persistence failure classified as …`), 실제 설정 키
APP_SECURITY_JWT_ISSUER, registry에 있는 지표. 이 템플릿에 경보 규칙이
없다는 것, 내는 코드가 없는 코드·지표는 서비스가 낼 때만 있다는 것을
적는다. 진단 순서도 고친다: actuator 노출은 관리 포트 9001로 가르고,
INTERNAL_AUTH_MISCONFIGURATION은 issuer discovery(4xx·issuer 불일치·
jwks_uri 없음은 500, 연결 실패·5xx·JSON 아님은 503)부터, 종료 예산은
웹 drain 30s + async 19s + preStop의 합으로 본다. 같은 원인의 다른
자리(경보 이름을 지어 적은 job·outbox·internal-error-spike, traceId로
적은 칸, 지적 밖 auth·dependency·db·outbox runbook, error-codes.yaml 주석,
같은 틀린 신호를 적은 shared-contract README·web README·
DependencyFailureException Javadoc)도 고치고, 본문의 리뷰 ID는 지운다.

버린 안: 선언만 있는 두 코드를 내는 WARN·counter를 새로 만들기. actuator
노출 밖 경로는 메인 chain이 401 AUTH_TOKEN_MISSING(익명)·404(인증됨)로
답해 403 상황이 없고, cross-tenant는 정한 규칙(남의 것은 404)이라 판정
자리가 서비스 코드에 있다. 새 신호는 서비스가 더할 일로 runbook에 적는다.

위험: 문서만 바뀐다. runbook은 모두 status 초안으로 둔다.
dependency-unavailable이 적은 hikaricp.connections.pending·timeout 행과
job.* 행의 emitted_when은 관측 registry 변경(같은 묶음의 다른 PR)이
더하고, auth-jwks-unavailable의 「캐시가 지난 뒤 503」은 인증 PR의 JWKS
재조회 분류 수정이 만든다. 세 PR을 함께 병합한다.

검증: python3 scripts/check-docs.py·check-work-docs.py OK, desktop
:app-bootstrap:documentContractTest :app-bootstrap:repositoryContractTest,
scripts/verify.sh pr rc=0.

Refs: RR9-02-04, RR9-02-24, RR9-04-34, RR9-04-37
2026-11-13 09:35:50 +09:00

3.0 KiB

title, category, error_codes, severity, owner, last_updated, status
title category error_codes severity owner last_updated status
Runbook — ACTUATOR_FORBIDDEN (Actuator 접근 거부) AUTHZ
ACTUATOR_FORBIDDEN
P2 oncall 2026-11-13 초안

Runbook: ACTUATOR_FORBIDDEN (runbook://management/actuator-forbidden)

증상

  • ACTUATOR_FORBIDDEN은 enum 상수(OperationalError)와 registry 행(docs/registries/error-codes.yaml)이 있지만 내는 코드가 없다.
  • 실제 신호: 노출한 actuator(health·info·prometheus) 밖의 경로(env·configprops·heapdump·threaddump·shutdown·loggers)는 actuator chain이 잡지 않아 메인 보안 chain으로 간다. token이 없으면 401 AUTH_TOKEN_MISSING(Envelope, WWW-Authenticate: Bearer)과 WARN 줄 security failure: code=AUTH_TOKEN_MISSING category=AUTH method=… path=/actuator/…(logger AuthErrorResponseWriter)이다. 인증된 호출자는 mapping이 없어 404다(config/observability.yml의 management.endpoints.web.exposure).
  • 서비스가 노출 목록을 넓혀 health·info·prometheus 밖의 endpoint를 더하면, 그 endpoint는 actuator chain이 잡고 본문 없는 401로 답한다. 그 chain에는 인증 수단이 없다(ManagementSecurityConfig). 이 401과 인증된 호출자의 404는 보안 로그 줄을 남기지 않는다.

진단

  • 관리 포트 노출은 포트로 가른다. 클러스터 밖에서 curl -s -o /dev/null -w '%{http_code}' http://<host>:9001/actuator/health가 200이면 관리 포트(MANAGEMENT_SERVER_PORT, 기본 9001, bind 주소 MANAGEMENT_SERVER_ADDRESS, 기본 127.0.0.1)가 클러스터 밖에 노출된 것이다. kubelet·Prometheus가 pod IP로 읽도록 0.0.0.0에 묶은 배포에서 클러스터 안의 200은 정상이다. 401·404만으로는 가를 수 없다: actuator가 없는 메인 포트의 /actuator/env도 메인 chain이 같은 401·WARN 줄·404로 답한다.
  • 앱 로그에서 path=/actuator가 든 security failure 줄을 찾는다(token 없는 시도). 그 줄에는 포트가 없다. 인증된 호출자의 404는 보안 로그 줄이 없다. 앞단 프록시·ingress 접근 로그로 어느 포트를 누가 불렀는지 찾는다.

조치

  • 관리 포트를 클러스터 밖으로 열지 않는다. kubelet 프로브와 Prometheus는 pod IP로 붙으므로 둘 중 하나를 고른다(src/bootstrap/service-runtime/README.md 「ManagementSecurityConfig」): MANAGEMENT_SERVER_ADDRESS를 0.0.0.0으로 두고 NetworkPolicy로 클러스터 안의 그 둘만 들이거나, 같은 pod의 sidecar가 loopback으로 읽는다. 기본값(loopback) 그대로면 liveness가 실패한다.
  • heapdump·threaddump는 노출 목록에서 빠져 있다. 꼭 필요하면 운영 조직의 break-glass 절차를 따른다. 이 저장소에는 그 절차 문서가 없다.

에스컬레이션

  • 관리 포트가 밖에 열려 있고(위 curl이 200) 외부에서 actuator를 두드린 흔적이 있으면 P1. 메인 포트의 /actuator/… 시도만 있으면 보통 스캐너다.

초안: 서비스가 도메인을 채운 뒤 본문을 쓴다.