From 808bb2e9ea8096d350e713f83b569ed116eb509c Mon Sep 17 00:00:00 2001 From: Yoann Schneider <yschneider@teklia.com> Date: Thu, 16 Feb 2023 15:42:44 +0100 Subject: [PATCH] small warning about user config --- docs/contents/implem/configure.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/contents/implem/configure.md b/docs/contents/implem/configure.md index ed86f3d7..37068608 100644 --- a/docs/contents/implem/configure.md +++ b/docs/contents/implem/configure.md @@ -66,6 +66,10 @@ The details of a worker execution (what is called a **WorkerRun**) on Arkindex a This step shows that there are a lot of sources for the actual configuration that the worker can use. Nothing is overridden by default, the worker has to do it in its overridden version of the configure method. In the end, any parameter set by the user **must** be applied over other known configurations. +!!! warning + + The convention is to always give the final word to the user. This means that when the user configuration is filled, its values must be the last to override the worker's `config` attribute. If a model configuration was set, its values must override this attribute before the user configuration's. + The worker configuration may specify default values for some parameters (see [this section](../workers/yaml.md#setting-up-user-configurable-parameters) for more details about worker configuration). These default values are stored in the `user_configuration` dictionary attribute. This is also when the secrets (see [this section](../secrets/usage.md#declaring-secrets-in-workers) to learn more about secrets) are actually downloaded. They are stored in the `secrets` dictionary attribute. -- GitLab