From 4274298f8eb818350a3ee545b54a09b2f1844643 Mon Sep 17 00:00:00 2001 From: Mattia Fumo Date: Wed, 3 Jul 2024 11:11:38 +0200 Subject: [PATCH 1/5] doc --- .../development_suite/api-console/api-design/services.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/development_suite/api-console/api-design/services.md b/docs/development_suite/api-console/api-design/services.md index eede04de5d..e9316b64cf 100644 --- a/docs/development_suite/api-console/api-design/services.md +++ b/docs/development_suite/api-console/api-design/services.md @@ -188,6 +188,11 @@ Currently, the following types exist: * **Plain Text**: values belonging to this type are strings that define the value that we want to associate to that specific environment variable key. For this type it is necessary to specify the **Value** that we want to link to that specific environment variable. **Value** can also be an interpolated string, to do so the value to interpolate needs to be enclosed by two pairs of curly braces, for example `{{VALUE_TO_INTERPOLATE}}`. * **From Secret**: this type represents a value that is obtained from a Kubernetes Secret. For this type, it is necessary to specify the **Secret Name** and the **Secret Key** from which this value can be retrieved. +* **From ConfigMap**: use this type to load a file of a ConfigMap into an environment variable, the **ConfigMap Name** and the **ConfigMap File Name** must be provided. + +:::warning +We always advise mounting ConfigMaps on the files system, and using environment variables *From ConfigMap* only with small-sized files. +::: :::info If you want more information about adding Kubernetes secrets to a microservice visit the following [link](/development_suite/api-console/api-design/services.md#secrets). @@ -205,6 +210,10 @@ Therefore, for each variable, you have to define: * **Secret Key** (*present and required only if **Value Type** is From Secret*) +* **ConfigMap Name** (*present and required only if **Value Type** is From ConfigMap*) + +* **ConfigMap File Name** (*present and required only if **Value Type** is From ConfigMap*) + * **Description** It is also possible to import multiple **Plain Text** variables from a `.env` file by using the dedicated button. From d40c458a089fbb6c29be80fdbbb7ead80eed117c Mon Sep 17 00:00:00 2001 From: Mattia Fumo Date: Wed, 3 Jul 2024 11:33:32 +0200 Subject: [PATCH 2/5] links --- docs/development_suite/api-console/api-design/services.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/development_suite/api-console/api-design/services.md b/docs/development_suite/api-console/api-design/services.md index e9316b64cf..c8e38fd6f2 100644 --- a/docs/development_suite/api-console/api-design/services.md +++ b/docs/development_suite/api-console/api-design/services.md @@ -191,11 +191,11 @@ Currently, the following types exist: * **From ConfigMap**: use this type to load a file of a ConfigMap into an environment variable, the **ConfigMap Name** and the **ConfigMap File Name** must be provided. :::warning -We always advise mounting ConfigMaps on the files system, and using environment variables *From ConfigMap* only with small-sized files. +We always advise mounting ConfigMaps on the files system, and using environment variables *From ConfigMap* when necessary and only with small-sized files. ::: :::info -If you want more information about adding Kubernetes secrets to a microservice visit the following [link](/development_suite/api-console/api-design/services.md#secrets). +Please refer to the dedicated [ConfigMaps](/development_suite/api-console/api-design/services.md#configmaps) and [Secrets](/development_suite/api-console/api-design/services.md#secrets) sections for more information about how to manage them using the Console. ::: Therefore, for each variable, you have to define: From 503a71ccf1d6f67b0999cc91a327e855422b9709 Mon Sep 17 00:00:00 2001 From: Mattia Fumo Date: Wed, 3 Jul 2024 11:51:06 +0200 Subject: [PATCH 3/5] rm required --- docs/development_suite/api-console/api-design/services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development_suite/api-console/api-design/services.md b/docs/development_suite/api-console/api-design/services.md index c8e38fd6f2..4bdfde134b 100644 --- a/docs/development_suite/api-console/api-design/services.md +++ b/docs/development_suite/api-console/api-design/services.md @@ -320,7 +320,7 @@ There are two kinds of custom configurations: **ConfigMaps** and **Secrets**. * **Configuration Name** (*required*): This is the name of your configuration. -* **Runtime Mount Path** (*required*): Path inside the service where you want to mount the directory. +* **Runtime Mount Path**: Path inside the service where you want to mount the directory. Moreover, you can decide to preserve files and directories already existing in the Runtime Mount Path directory, by activating the related checkbox. From 1ff4e121d0cf5d06631cd9b467ad7cb2a2ada1a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniele=20Cin=C3=A0?= Date: Mon, 8 Jul 2024 14:28:24 +0200 Subject: [PATCH 4/5] Update docs/development_suite/api-console/api-design/services.md --- docs/development_suite/api-console/api-design/services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development_suite/api-console/api-design/services.md b/docs/development_suite/api-console/api-design/services.md index 4bdfde134b..17895a2d5a 100644 --- a/docs/development_suite/api-console/api-design/services.md +++ b/docs/development_suite/api-console/api-design/services.md @@ -191,7 +191,7 @@ Currently, the following types exist: * **From ConfigMap**: use this type to load a file of a ConfigMap into an environment variable, the **ConfigMap Name** and the **ConfigMap File Name** must be provided. :::warning -We always advise mounting ConfigMaps on the files system, and using environment variables *From ConfigMap* when necessary and only with small-sized files. +We always suggest using ConfigMaps on the files system and using environment variables *From ConfigMap* when necessary and only with small-sized files. ::: :::info From de856b8d8c5175a4ddb2d1d5e7fed7d31751bf65 Mon Sep 17 00:00:00 2001 From: Mattia Date: Mon, 8 Jul 2024 14:33:40 +0200 Subject: [PATCH 5/5] Update docs/development_suite/api-console/api-design/services.md --- docs/development_suite/api-console/api-design/services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development_suite/api-console/api-design/services.md b/docs/development_suite/api-console/api-design/services.md index 17895a2d5a..891e332141 100644 --- a/docs/development_suite/api-console/api-design/services.md +++ b/docs/development_suite/api-console/api-design/services.md @@ -191,7 +191,7 @@ Currently, the following types exist: * **From ConfigMap**: use this type to load a file of a ConfigMap into an environment variable, the **ConfigMap Name** and the **ConfigMap File Name** must be provided. :::warning -We always suggest using ConfigMaps on the files system and using environment variables *From ConfigMap* when necessary and only with small-sized files. +We always suggest mounting ConfigMaps on the files system and using environment variables *From ConfigMap* when necessary and only with small-sized files. ::: :::info