toki
6e2a1fc2f2
- Add edge runtime config and opsconsole package - Refactor edge console to use new runtime config - Add service source metadata support - Update CLI adapter with target terminology - Add edge operation contract and event bus replay - Update node label and command ops surface - Add E2E smoke tests and full validation - Update proto runtime definitions - Update documentation and agent-ops rules
116 lines
3.1 KiB
Text
116 lines
3.1 KiB
Text
<!-- task=09_ops_console_docs plan=0 tag=OCD -->
|
|
|
|
# 09 Ops Console Docs Plan - OCD
|
|
|
|
## 이 파일을 읽는 구현 에이전트에게
|
|
|
|
**필수: 구현 마지막에는 반드시 `CODE_REVIEW-*-G??.md`의 모든 섹션을 실제 구현 내용과 명령 출력으로 채운다.**
|
|
이 task는 docs/config 설명만 다룬다.
|
|
|
|
## 배경
|
|
|
|
문서에는 edge console이 임시 디버그 클라이언트라고 남아 있다. 이제는 HTTP/Control Plane과 별개로 edge-local ops console을 유지하는 방향이므로 문서의 역할 설명을 바꿔야 한다.
|
|
|
|
## 분석 결과
|
|
|
|
### 읽은 파일
|
|
|
|
- `agent-ops/skills/common/plan/SKILL.md`
|
|
- `agent-ops/rules/project/domain/edge/rules.md`
|
|
- `README.md`
|
|
- `docs/architecture.md`
|
|
- `apps/edge/README.md`
|
|
- `packages/config/config.go`
|
|
- `configs/edge.yaml`
|
|
|
|
### 테스트 커버리지 공백
|
|
|
|
- Docs-only change는 Go test가 직접 커버하지 않는다.
|
|
- 용어 잔여물은 deterministic `rg --sort path`로 검증한다.
|
|
|
|
### 심볼 참조
|
|
|
|
- `임시 디버그`: `apps/edge/README.md:12`, `docs/architecture.md:51`.
|
|
- `임시 수동 테스트 UI`: `README.md:199`.
|
|
- `edge-console`: service metadata task에서 별도 처리.
|
|
|
|
### 범위 결정 근거
|
|
|
|
- Config key rename은 제외한다. `console` key는 backward compatibility 때문에 유지한다.
|
|
- HTTP API 설계 문서는 이 task에서 작성하지 않는다.
|
|
|
|
### 빌드 등급
|
|
|
|
- Build `local-G03`: docs wording change.
|
|
- Review `local-G03`: wording consistency check.
|
|
|
|
### [OCD-1] console 역할 설명 갱신
|
|
|
|
#### 문제
|
|
|
|
Docs say console is temporary, conflicting with 유지 방향.
|
|
|
|
#### 해결 방법
|
|
|
|
- Console을 `edge-local ops console` 또는 `edge-local diagnostic surface`로 설명한다.
|
|
- HTTP/API와 Control Plane은 central/remote management surface로 구분한다.
|
|
|
|
#### 수정 파일 및 체크리스트
|
|
|
|
- [ ] `README.md`
|
|
- [ ] `docs/architecture.md`
|
|
- [ ] `apps/edge/README.md`
|
|
|
|
#### 테스트 작성
|
|
|
|
- Docs-only: unit test skip.
|
|
- Search verification required.
|
|
|
|
#### 중간 검증
|
|
|
|
```bash
|
|
rg --sort path -n "임시 디버그|temporary debug|임시 수동 테스트 UI" README.md docs apps/edge
|
|
```
|
|
|
|
### [OCD-2] console/cli adapter 용어 구분 문서화
|
|
|
|
#### 문제
|
|
|
|
`CLI`가 edge ops console과 node cli adapter 두 의미로 쓰일 수 있다.
|
|
|
|
#### 해결 방법
|
|
|
|
- Edge-local tool은 ops console로 부른다.
|
|
- Node execution implementation은 `cli adapter`로 부른다.
|
|
|
|
#### 수정 파일 및 체크리스트
|
|
|
|
- [ ] `README.md`
|
|
- [ ] `apps/edge/README.md`
|
|
|
|
#### 테스트 작성
|
|
|
|
- Docs-only: unit test skip.
|
|
|
|
#### 중간 검증
|
|
|
|
```bash
|
|
rg --sort path -n "ops console|cli adapter|edge-local" README.md docs apps/edge
|
|
```
|
|
|
|
## 수정 파일 요약
|
|
|
|
| 파일 | 항목 |
|
|
|---|---|
|
|
| `README.md` | OCD-1, OCD-2 |
|
|
| `docs/architecture.md` | OCD-1 |
|
|
| `apps/edge/README.md` | OCD-1, OCD-2 |
|
|
|
|
## 최종 검증
|
|
|
|
```bash
|
|
rg --sort path -n "임시 디버그|temporary debug|임시 수동 테스트 UI" README.md docs apps/edge
|
|
rg --sort path -n "ops console|cli adapter|edge-local" README.md docs apps/edge
|
|
```
|
|
|
|
모든 코드 변경 완료 후 반드시 `CODE_REVIEW-*-G??.md`의 전체 섹션을 채운다. 이 파일 작성이 구현의 마지막 단계다.
|