From 6a207c881f4e3d8151615f87b9cb56303989cad3 Mon Sep 17 00:00:00 2001 From: AhmedGrati Date: Wed, 23 Aug 2023 15:19:22 +0100 Subject: [PATCH] kep: add config file format and structure notes Signed-off-by: AhmedGrati --- .../enhancements/5700-nanny-configuration-reload/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/addon-resizer/enhancements/5700-nanny-configuration-reload/README.md b/addon-resizer/enhancements/5700-nanny-configuration-reload/README.md index 5d9bc7e5b5d6..c661c57f36a1 100644 --- a/addon-resizer/enhancements/5700-nanny-configuration-reload/README.md +++ b/addon-resizer/enhancements/5700-nanny-configuration-reload/README.md @@ -50,6 +50,7 @@ The proposed solution involves updating the addon-resizer with the following ste - In the main function, we create a new `FsWatcher` and then we wait in an infinite loop to receive events indicating filesystem changes. Based on these changes, we re-execute `loadNannyConfiguration` function. +> **Note:** The expected configuration file format is YAML. It has the same structure as the NannyConfiguration CRD. ### Test Plan To ensure the proper functioning of the enhanced addon-resizer, the following test plan should be executed: