public_git
/
freenas-proxmox
mirror of https://github.com/TheGrandWazoo/freenas-proxmox.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
freenas-proxmox/.claude/cos/adrs
History
Kevin Adams 4e621a215c docs: ADR-009 draft + versioning strategy — v3.1 PVE 9 only, v4.0 WebSocket 
ADR-009 (draft) supersedes ADR-008 with confirmed PVE 9 support, the lun
integer fix approach, and a clear version→PVE support mapping:
- v3.0.x: PVE 8 + PVE 9, REST API
- v3.1.x: PVE 9 only, REST API, api() bump, snapshots
- v4.0.x: WebSocket JSON-RPC 2.0 — genuine architectural change, major version

ROADMAP: v3.2.0 renamed to v4.0.0 for WebSocket milestone; v3.1 scope updated
to document PVE 8 drop and reasons.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
 		2026-05-31 23:13:21 -04:00
..
ADR-001-consolidate-build-into-main-repo.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-002-ui-strategy.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-003-apt-repo-hosting.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-004-cleanup-on-failure.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-005-bearer-token-authentication.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-006-versioning-strategy.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-007-freenas-vs-truenas-naming.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00
ADR-008-pve-version-support-matrix.md docs: add PVE 8.4/9.0/9.1 research brief and ADR-008 version support matrix 2026-05-19 13:05:08 -04:00
ADR-009-pve-version-support-v3.md docs: ADR-009 draft + versioning strategy — v3.1 PVE 9 only, v4.0 WebSocket 2026-05-31 23:13:21 -04:00
README.md docs: finalize ADR statuses to Accepted; add ADR README and KSA scaffold 2026-05-19 11:07:49 -04:00

README.md

Architecture Decision Records

ADRs document significant decisions made about this project. They follow an RFC-style lifecycle.

Lifecycle

Status Meaning
Draft Being written or discussed. Not yet binding. May change freely.
Accepted Agreed upon and in effect. Guides implementation.
Superseded Replaced by a newer ADR. The old record is preserved as history. The header notes which ADR supersedes it.
Rejected Proposed but explicitly decided against. Preserved so we remember why.
Deprecated Was accepted but no longer applicable (e.g., a feature was dropped). Not replaced.

Rules

  • Never edit the Decision section of an Accepted ADR. If the decision changes, write a new ADR and mark the old one Superseded by ADR-XXX.
  • Draft ADRs can be edited freely — they are working documents.
  • Numbering is sequential and permanent. A superseded ADR keeps its number; the new one gets the next number.
  • Context and Consequences sections may be lightly edited for clarity even after acceptance (fix typos, add links), but the decision itself is immutable.

Index

ADR Title Status
ADR-001 Consolidate Build Pipeline into Main Repo Accepted
ADR-002 UI Integration Strategy Accepted
ADR-003 APT Repository Hosting Accepted
ADR-004 Transactional Cleanup on API Operation Failure Accepted
ADR-005 Bearer Token Authentication as Primary Auth Method Accepted
ADR-006 Package Versioning Strategy Accepted
ADR-007 FreeNAS vs TrueNAS Module Naming Accepted