chore: adopt SIAX Golden Standard docs and configuration
siax-scaffold genererade saknade standardartefakter (arkitektur, säkerhet, ändringslogg, runbooks, CI, devcontainer, licens m.m.) ur repots faktiska filer. DOC-07 lämnas avsiktligt röd till en verklig restore bevisats.
This commit is contained in:
@@ -0,0 +1,66 @@
|
||||
# Arkitektur — 0PT
|
||||
|
||||
> **Status:** automatisk första version, genererad av `siax-scaffold` ur repots
|
||||
> faktiska filer. Den beskriver vad som finns, inte vad som är bestämt. Läs
|
||||
> igenom, rätta och fyll i avsnitten som är markerade TODO innan dokumentet
|
||||
> betraktas som en arkitekturbeskrivning (ARK-serien).
|
||||
|
||||
Senast verifierad mot kod: 2026-11-10
|
||||
|
||||
## 1. Översikt
|
||||
|
||||
| Fält | Värde |
|
||||
| --- | --- |
|
||||
| Repo | `0pt` |
|
||||
| Körtid | okänd |
|
||||
| Ramverk | okänd |
|
||||
| Paketnamn | — |
|
||||
| Domäner i `siax.config.json` | inga |
|
||||
|
||||
|
||||
## 2. Komponenter
|
||||
|
||||
Toppnivåkataloger som innehåller kod eller konfiguration (härledda ur filträdet):
|
||||
|
||||
| Katalog | Roll |
|
||||
| --- | --- |
|
||||
| `services//` | TODO: beskriv katalogens roll (services/) |
|
||||
| `docs//` | TODO: beskriv katalogens roll (docs/) |
|
||||
|
||||
Undermoduler som är deklarerade i `children[]`:
|
||||
|
||||
| Sökväg | Syfte |
|
||||
| --- | --- |
|
||||
| — | Inga undermoduler (apps/, packages/, services/) finns. |
|
||||
|
||||
## 3. Startpunkter
|
||||
|
||||
| Fil | Typ |
|
||||
| --- | --- |
|
||||
| — | Ingen startpunkt hittades i `package.json`, `pyproject.toml` eller `Dockerfile`. |
|
||||
|
||||
## 4. Språk och filfördelning
|
||||
|
||||
| Ändelse | Omfattning |
|
||||
| --- | --- |
|
||||
| .ts | 1 filer |
|
||||
|
||||
## 5. Dataflöde
|
||||
|
||||
TODO: beskriv hur data rör sig genom repot: inkommande anrop/jobb → lagring → utdata, och vilka externa system som anropas. Scaffolden kan inte härleda detta ur filerna.
|
||||
|
||||
## 6. Gränser och beroenden
|
||||
|
||||
TODO: lista vilka SIAX-komponenter repot äger respektive konsumerar (REUSE FIRST), samt vilka kontrakt som är stabila utåt. Se `siax.repo.json` → `consumes`/`consumedBy`.
|
||||
|
||||
## 7. Drift och miljöer
|
||||
|
||||
Ingen `siax.config.json` finns — repot är inte deklarerat som driftsatt. Om det driftsätts ska `siax.config.json` skapas först (REPO-06).
|
||||
|
||||
TODO: verifiera mot faktisk nod och `docker ps` (GOV-06). Ett dokument får inte påstå drift som inte är mätt.
|
||||
|
||||
## 8. Källhänvisning
|
||||
|
||||
- Genererad: 2026-11-10 av `siax-scaffold` (scaffold 2026-11-10).
|
||||
- Underlag: filträdet, `package.json`/`pyproject.toml`, `Dockerfile`, `siax.repo.json`.
|
||||
- Ändringslogg: se `CHANGELOG.md` och git-historiken.
|
||||
@@ -0,0 +1,45 @@
|
||||
# SCAFFOLD-TODO — vad som är härlett och vad som måste verifieras
|
||||
|
||||
**Genererad:** 2026-11-10 av `siax-scaffold` (siax-standard,
|
||||
`packages/scaffold`) mot Golden Standard v2.0.
|
||||
|
||||
Den här filen finns för att en mall inte får låtsas veta saker. Varje rad nedan
|
||||
är antingen **härledd ur repot** (källan står i kolumn 3) eller ett
|
||||
**konservativt defaultvärde** som en människa måste bekräfta. Radera raden när
|
||||
den är verifierad — filen ska till slut kunna tas bort helt.
|
||||
|
||||
## Härledda värden i `siax.repo.json`
|
||||
|
||||
| Fält | Värde | Härlett ur |
|
||||
|---|---|---|
|
||||
| `repo` | `0PT` | `git remote.origin.url` (VERSALER per REPO-08) |
|
||||
| `codeowners` | `["@sax3l"]` | default (organisationens ägare) |
|
||||
| `category` | `platform` | DEFAULT — ej härledbart |
|
||||
| `subcategory` | `TODO: fyll i underkategori (t.ex. compute-os, saas-ersättare)` | TODO-markör |
|
||||
| `operationalState` | `planned` | inga driftsartefakter (varken Dockerfile eller siax.config.json) |
|
||||
| `domains` | `0 st` | inga funna |
|
||||
| `children` | `1 st` | faktiska kataloger under apps/, packages/, services/ |
|
||||
|
||||
## Måste verifieras av människa
|
||||
|
||||
- [ ] Bekräfta `codeowners` — scaffolden defaultade till `@sax3l` (CI-14).
|
||||
- [ ] Verifiera `category` i `siax.repo.json` mot den kanoniska taxonomin och CL0UD APP_REGISTRY (GOV-01/REPO-05). Scaffolden defaultade till `platform` — den kan inte veta.
|
||||
- [ ] Fyll i `subcategory` i `siax.repo.json` (REPO-04).
|
||||
- [ ] Bekräfta `operationalState` — scaffolden satte `planned` eftersom repot saknar driftsartefakter (GOV-06).
|
||||
- [ ] Beskriv varje post i `children[]` — sökvägarna är härledda ur filträdet, syftet är inte (ARK-11).
|
||||
- [ ] Välj rätt devcontainer-bild — scaffolden kunde inte avgöra körtiden och valde en generisk Ubuntu-bas (DX-03).
|
||||
- [ ] Fastställ `appId` mot CL0UD APP_REGISTRY och ta bort `appIdJustification` (REPO-05).
|
||||
- [ ] Fyll i consumes[] och consumedBy[] från FAS 2-beroendekartan — de får aldrig gissas.
|
||||
- [ ] Fyll i `node` (server5–server11) i `siax.repo.json`, eller lämna `null` om repot inte driftsätts.
|
||||
- [ ] Kör återställningen skarpt och skriv in datumet i `docs/runbook/backup-restore.md` (DOC-07).
|
||||
|
||||
## Kontroller som scaffolden AVSIKTLIGT lämnar röda
|
||||
|
||||
- **REPO-05** — `appId` är `null` med motivering. Ett påhittat appId skulle se konformt ut och peka på ingenting i CL0UD APP_REGISTRY.
|
||||
- **DOC-07** — `docs/runbook/backup-restore.md` saknar datum för bevisad restore. Scaffolden skriver aldrig in ett datum: kontrollen letar efter ett datum, och ett genererat sådant skulle göra den grön utan att någon återställning ägt rum. Kör återställningen, skriv in datumet.
|
||||
|
||||
|
||||
---
|
||||
|
||||
_Genererad av `siax-scaffold` (siax-standard). Varje `TODO:` i filen måste
|
||||
fyllas i av en människa. Samlad lista: `docs/compliance/SCAFFOLD-TODO.md`._
|
||||
@@ -0,0 +1,36 @@
|
||||
# Backup & restore
|
||||
|
||||
## Vad som säkerhetskopieras
|
||||
|
||||
TODO: lista varje tillstånd repot äger — databas, volymer, objektlager,
|
||||
hemligheter. Sådant som inte står här är inte säkerhetskopierat.
|
||||
|
||||
| Tillstånd | Var | Frekvens | Retention |
|
||||
|---|---|---|---|
|
||||
| TODO | TODO | TODO | TODO |
|
||||
|
||||
## Återställning — steg
|
||||
|
||||
1. TODO: exakt kommando för att hämta senaste dumpen.
|
||||
2. TODO: exakt kommando för att läsa in den.
|
||||
3. TODO: hur du verifierar att data faktiskt är tillbaka (räkna rader, anropa
|
||||
en endpoint) — inte bara att kommandot gav exit 0.
|
||||
|
||||
## Senast bevisad restore
|
||||
|
||||
**EJ BEVISAD.**
|
||||
|
||||
TODO: kör återställningen skarpt mot en tom miljö och skriv in datumet här på
|
||||
formen ÅÅÅÅ-MM-DD tillsammans med vem som körde den och vad som verifierades.
|
||||
|
||||
> Detta fält är avsiktligt tomt. `siax-scaffold` skriver ALDRIG in ett datum
|
||||
> här: DOC-07 letar efter ett datum, och ett genererat datum skulle göra
|
||||
> kontrollen grön utan att någon återställning ägt rum. Kontrollen ska förbli
|
||||
> röd tills påståendet är sant.
|
||||
|
||||
**RTO/RPO:** TODO: mät, gissa inte.
|
||||
|
||||
---
|
||||
|
||||
_Genererad av `siax-scaffold` (siax-standard). Varje `TODO:` i filen måste
|
||||
fyllas i av en människa. Samlad lista: `docs/compliance/SCAFFOLD-TODO.md`._
|
||||
@@ -0,0 +1,26 @@
|
||||
# Deploy
|
||||
|
||||
TODO: `siax.config.json` saknas (REPO-06) — fyll i framework, build,
|
||||
start, port, healthcheck och per-miljö-domän, och spegla dem här.
|
||||
|
||||
## Steg
|
||||
|
||||
1. TODO: hur en ändring når drift (börvärde i estatet: merge till `main` →
|
||||
`.gitea/workflows/cd.yml` → Coolify-webhook på den nod repot bor på).
|
||||
Skriv det som FAKTISKT sker — inte det som borde ske (DOC-19).
|
||||
2. TODO: hur du verifierar att den nya versionen kör (healthcheck-URL, exakt
|
||||
`curl`-kommando och förväntat svar).
|
||||
3. TODO: rollback — exakt kommando/knapp och hur lång tid det tar (CD-*).
|
||||
|
||||
## Förutsättningar
|
||||
|
||||
- Hemligheter hämtas från Infisical, aldrig ur repot (AR-6, SEC-01).
|
||||
- TODO: vilka env-nycklar som måste finnas innan deploy.
|
||||
|
||||
**Runbooken ska vara körbar av någon som inte byggt systemet (DOC-06).**
|
||||
Så länge något `TODO` står kvar är den inte det.
|
||||
|
||||
---
|
||||
|
||||
_Genererad av `siax-scaffold` (siax-standard). Varje `TODO:` i filen måste
|
||||
fyllas i av en människa. Samlad lista: `docs/compliance/SCAFFOLD-TODO.md`._
|
||||
@@ -0,0 +1,35 @@
|
||||
# Incident
|
||||
|
||||
## 1. Bekräfta
|
||||
|
||||
TODO: exakt kommando/URL som visar om tjänsten lever (healthcheck, `docker ps`
|
||||
på noden, dashboard). Ett incidentsvar börjar alltid med en mätning.
|
||||
|
||||
## 2. Klassa
|
||||
|
||||
| Läge | Innebörd | Åtgärd |
|
||||
|---|---|---|
|
||||
| Nere | ingen trafik betjänas | eskalera direkt, se `oncall.md` |
|
||||
| Degraderad | fel/latens över SLO | TODO: tröskelvärden ur `docs/slo.md` (OBS-10) |
|
||||
| Kosmetiskt | ingen kundpåverkan | ärende, inte incident |
|
||||
|
||||
## 3. Vanliga orsaker (fylls på efter varje incident)
|
||||
|
||||
- TODO: känd felkälla 1 — symptom, kommando som bekräftar, åtgärd.
|
||||
- TODO: känd felkälla 2.
|
||||
|
||||
## 4. Återställ
|
||||
|
||||
1. TODO: rollback enligt `deploy.md`.
|
||||
2. TODO: om data är påverkad — följ `backup-restore.md` (och notera att
|
||||
återställningen då faktiskt är bevisad, DOC-07).
|
||||
|
||||
## 5. Efterarbete
|
||||
|
||||
Postmortem i `docs/incidents/` — orsak, tidslinje, vad som saknades i
|
||||
mätningen, vilken kontroll som skulle ha fångat det. Aldrig skuld på person.
|
||||
|
||||
---
|
||||
|
||||
_Genererad av `siax-scaffold` (siax-standard). Varje `TODO:` i filen måste
|
||||
fyllas i av en människa. Samlad lista: `docs/compliance/SCAFFOLD-TODO.md`._
|
||||
@@ -0,0 +1,21 @@
|
||||
# Oncall
|
||||
|
||||
**Jour:** TODO: vem som svarar, på vilken kanal, inom vilken tid. Står här
|
||||
"ingen jour" ska det vara ett medvetet beslut — inte en glömska.
|
||||
|
||||
**Eskalering:** TODO: namn + kontaktväg. Sista instans i estatet: Simon
|
||||
(goat@siax.io).
|
||||
|
||||
**Innan du väcker någon:**
|
||||
|
||||
1. Kör bekräftelsesteget i `incident.md` §1.
|
||||
2. Kolla om det finns en känd orsak i `incident.md` §3.
|
||||
3. TODO: länk till dashboard/larm (OBS-06/OBS-08).
|
||||
|
||||
**Larmvägar:** TODO: vilka larm som faktiskt är kopplade. Ett larm som ingen
|
||||
tar emot är inget larm.
|
||||
|
||||
---
|
||||
|
||||
_Genererad av `siax-scaffold` (siax-standard). Varje `TODO:` i filen måste
|
||||
fyllas i av en människa. Samlad lista: `docs/compliance/SCAFFOLD-TODO.md`._
|
||||
Reference in New Issue
Block a user