HYPERFLEET-1232 - docs: trim sentinel.md to high-level design document

[rafabene]

Summary

• Trim hyperfleet/components/sentinel/sentinel.md from ~1220 lines to ~250 lines, keeping only the high-level design document (What/Why, Architecture diagrams, Decision Logic concept, Trade-offs, Alternatives Considered, Post-MVP)
• Remove detailed operational/reference content that now lives in the sentinel repo (hyperfleet-sentinel#222): Message Decision details, CEL Function Reference, Adapter Status Update Contract, Status Tracking, Service Components, Decision Engine Test Scenarios, configuration YAML examples
• Update cross-references in condition-mapping-design.md, glossary.md, and v0.2.0-to-v1.0.0-upgrade-guide.md to point to the sentinel repo for detailed content
• Add links at the top of sentinel.md pointing to the sentinel repo docs (config, operator guide, decision engine reference, multi-instance deployment)

Per Angel Marin's review comment on PR #154: "IMO all this information belongs to the sentinel repository, and we keep only high level information in this one."

Test plan

• Verify sentinel.md retains all required component doc sections (What/Why, How, Trade-offs, Alternatives Considered)
• Verify cross-references to sentinel repo resolve correctly
• Verify no broken internal links (./hack/linkcheck.sh)
• Confirm companion PR hyperfleet-sentinel#222 contains all moved content

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation-only changes update four Markdown files. The Sentinel design document was condensed, its decision logic and resource filtering sections were revised, and an inline multi-instance YAML example was replaced with a documentation link. Related references in the API service design, glossary, and upgrade guide now point to the Sentinel Decision Engine Reference.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 11

✅ Passed checks (11 passed)

Check name	Status	Explanation
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.
Sec-02: Secrets In Log Output	✅ Passed	Only markdown changed; no slog/logr/zap/fmt.Print* calls with token/password/credential/secret fields or interpolations. CWE-532 not present.
No Hardcoded Secrets	✅ Passed	PASS: No CWE-798/CWE-321 indicators in the PR docs; scans found no secret assignments, embedded creds, or long base64, only documentation samples/links.
No Weak Cryptography	✅ Passed	Only Markdown docs changed; no code touched and no banned crypto primitives or secret comparisons were found in modified files (CWE-327/CWE-208).
No Injection Vectors	✅ Passed	Markdown-only changes; no exec.Command, template.HTML, yaml.Unmarshal, or query fmt.Sprintf patterns found (CWE-89/78/79/502).
No Privileged Containers	✅ Passed	PASS: PR only changes Markdown docs; no Kubernetes/Helm/Dockerfile changes or privilege flags found, so no CWE-284/CWE-269 exposure.
No Pii Or Sensitive Data In Logs	✅ Passed	Only Markdown docs changed; no slog/logr/zap/fmt.Print logging statements or PII-bearing log payloads were added. CWE-532 not implicated.
Title check	✅ Passed	The title clearly matches the main change: trimming sentinel.md to a high-level design document.
Description check	✅ Passed	The description is directly related to the documented doc trim and link updates in this changeset.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

_{Comment @coderabbitai help to get the list of available commands.}

[tirthct]

Hmm, seems like this section is still there: https://github.com/rafabene/hyperfleet-architecture/blob/99ad8f7217c5dafe9d115a02068efd7389a06200/hyperfleet/components/sentinel/sentinel.md#advanced-alerting

[rafabene]

Good catch — Post-MVP Enhancements is design/roadmap content, so it stays here in the architecture repo. I only removed the sub-section of it from the TOC.

[rafabene]

/retest

[rafabene]

/retest

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tirthct

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [tirthct]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment