From 8cc9956bb05d1a3ae67fe65e806a4c7880fb7608 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Mon, 21 Feb 2022 19:47:52 +0100 Subject: [PATCH] Partial design doc for configuration handling --- CONFIG_DESIGN.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONFIG_DESIGN.md diff --git a/CONFIG_DESIGN.md b/CONFIG_DESIGN.md new file mode 100644 index 00000000..7e5c24c7 --- /dev/null +++ b/CONFIG_DESIGN.md @@ -0,0 +1,26 @@ +# Configuration Design + +This is just a little scratchpad / design document for figuring out how to deal +with configuration. + + +## Sources of Configuration + +1. Local config file `flamenco-manager.yaml` +2. Environment variables (for easily putting into docker) +3. CLI parameters + + +## Flow of Configuration + +1. Load at startup from `flamenco-manager.yaml` + - Nice to have: monitoring & live reloading of that configuration file. +2. Load at startup from environment variables + - Will never change. +3. Load at startup from CLI parameters + - Will also never change +4. Receive new config via API (for Lineup integration) + - Will require live adjustments of configuration. + + +## Design Questions