-
Notifications
You must be signed in to change notification settings - Fork 1
[crowdsec-manager] Document History, Config Validation/Drift Detection, and Simulation Mode #4
Copy link
Copy link
Open
Labels
enhancementNew feature or requestNew feature or requestphase:1-criticalPhase 1: Critical gapsPhase 1: Critical gapspriority:highHoch: Wichtige fehlende Features oder GuidesHoch: Wichtige fehlende Features oder Guidesproject:crowdsec-managerCrowdSec Manager DocsCrowdSec Manager Docsscope:config-validationCrowdSec Manager: Config Validation / Drift DetectionCrowdSec Manager: Config Validation / Drift Detectionscope:historyCrowdSec Manager: Decision/Alert HistoryCrowdSec Manager: Decision/Alert Historyscope:simulationCrowdSec Manager: Simulation ModeCrowdSec Manager: Simulation Modeteam:devDevelopment: Code-Analyse, API-Doku, Feature-MappingDevelopment: Code-Analyse, API-Doku, Feature-Mapping
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestphase:1-criticalPhase 1: Critical gapsPhase 1: Critical gapspriority:highHoch: Wichtige fehlende Features oder GuidesHoch: Wichtige fehlende Features oder Guidesproject:crowdsec-managerCrowdSec Manager DocsCrowdSec Manager Docsscope:config-validationCrowdSec Manager: Config Validation / Drift DetectionCrowdSec Manager: Config Validation / Drift Detectionscope:historyCrowdSec Manager: Decision/Alert HistoryCrowdSec Manager: Decision/Alert Historyscope:simulationCrowdSec Manager: Simulation ModeCrowdSec Manager: Simulation Modeteam:devDevelopment: Code-Analyse, API-Doku, Feature-MappingDevelopment: Code-Analyse, API-Doku, Feature-Mapping
Summary
Three significant features have their own navigation sections in the UI but zero corresponding documentation: Decision/Alert History, Config Validation (Drift Detection), and Simulation Mode.
Source
Gap analysis:
docs/upstream-contributions/crowdsec-manager/docs-analyse.md(Section 3.1)Feature 1: History (Decision/Alert History)
Navigation page:
History.tsx| Section: ActivityThe History service runs as a background sync every 5 minutes, handles retention cleanup, detects repeated offenders, and supports reapply operations.
Key aspects to document:
POST /crowdsec/decisions/reapply,/bulk-reapply)POST /crowdsec/decisions/import)GET /crowdsec/history/stats)GET/PUT /crowdsec/history/config)HISTORY_DATABASE_PATH(default:./data/history.db)New file:
content/docs/features/history.mdxFeature 2: Config Validation / Drift Detection
Navigation page:
ConfigValidation.tsx| Section: SystemAllows users to detect configuration drift by comparing current config against saved snapshots.
API Endpoints:
POST /config/validation/validateGET /config/validation/snapshotsPOST /config/validation/snapshotPOST /config/validation/restore/:typePUT /config/validation/accept/:typeDELETE /config/validation/snapshot/:typeNew file:
content/docs/features/config-validation.mdxFeature 3: Simulation Mode
Navigation page: implied (2 dedicated API endpoints)
CrowdSec simulation mode allows testing scenarios without applying decisions. The manager exposes this as a toggleable setting.
API Endpoints:
GET /simulation/statusPOST /simulation/toggleNew file:
content/docs/features/simulation.mdxAcceptance Criteria
features/history.mdxcreated with: retention config, repeated offender detection, reapply workflow, import workflowfeatures/config-validation.mdxcreated with: what drift detection is, snapshot workflow, restore/accept/reject flowfeatures/simulation.mdxcreated with: what simulation mode does, how to enable/disable, use casesfeatures/meta.jsonHISTORY_DATABASE_PATHenv-var referenced in history page (cross-link to env-vars issue)Effort Estimate
M (5–6 hours total across 3 pages)