Repository navigation
Decision: How do we keep a shared decision register? #11
Closed
RaithHandac
started this conversation in
Ideas
Replies: 1 comment
|
During the hackathon it was decided to move forward with this proposal. |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Context
To build the Kubernetes cluster and the workloads on top of it, we need one shared source of truth for what we have decided, and for what is still open. Today, choices and options are spread across the docs (for example "Keycloak or authentik" in
docs/content/architecture/identity.md), and research such assrc/authentik/authentik-research.mdhas nowhere to land as a decision.Options
A. Architecture Decision Records (ADRs). One Markdown file per decision in
docs/content/decisions/, with statuses Proposed → Accepted → Superseded. Room for context and options in each file, but many small files, and open questions become "Proposed" records.B. A single decision register. Inspired by it-ops-model. One
register.mdwith a table per area:idn-q1) and decisions (idn-d1), numbered per area and never reused.Example:
idn-d1src/authentik/authentik-research.mdProposal
Option B. Most of what we have now are open questions, not decisions, and a single register keeps them visible in one place. Suggested areas: identity (
idn), platform (plt), network (net), data and backup (dr), engineering (eng), operations (ops).The register lives in
docs/content/decisions/and is published with the docs. Changes go through the usual issue → branch → PR flow, and merging a PR is what makes a decision official.Initial open questions to seed the register
Input wanted
All reactions