generated from coulomb/repo-seed
tegwick
cc43881565
Updated by fix-consistency on 2026-05-07: - update .custodian-brief.md for open-cmis-tck
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# Service And Retention Integration
|
|
|
|
Status: draft
|
|
Created: 2026-05-07
|
|
|
|
## Local Service
|
|
|
|
`open-cmis-tck` does not run its own service. It plugs into the guide-board
|
|
local API as an external extension:
|
|
|
|
```sh
|
|
cd ../guide-board
|
|
PYTHONPATH=src python3 -m guide_board \
|
|
--extension-dir ../open-cmis-tck \
|
|
serve --host 127.0.0.1 --port 8080
|
|
```
|
|
|
|
The guide-board service can then:
|
|
|
|
- list `open-cmis-tck` from `GET /extensions`,
|
|
- build CMIS run plans with `POST /assessments/plan`,
|
|
- start CMIS runs with `POST /runs`,
|
|
- inspect jobs with `GET /runs/{job_id}`,
|
|
- fetch reports with `GET /runs/{job_id}/reports`.
|
|
|
|
CLI execution remains the primary and most transparent path. The service is a
|
|
transport and job-tracking layer over the same runner contracts.
|
|
|
|
## Retention
|
|
|
|
CMIS runs use the guide-board run directory contract. Each run writes:
|
|
|
|
- `run.json`
|
|
- `retention-summary.json`
|
|
- `plan.json`
|
|
- `normalized/evidence.json`
|
|
- `normalized/findings.json`
|
|
- `normalized/mappings.json`
|
|
- `reports/assessment-package.json`
|
|
- `reports/report.md`
|
|
|
|
The sample assessment profile keeps summaries for 365 days and raw artifacts for
|
|
30 days:
|
|
|
|
```json
|
|
{
|
|
"retention_policy": {
|
|
"summary_days": 365,
|
|
"raw_artifact_days": 30
|
|
}
|
|
}
|
|
```
|
|
|
|
Compact `retention-summary.json` files are suitable for guide-board trend
|
|
summaries and downstream CMIS capability scorecards without retaining unbounded
|
|
raw TCK logs.
|