From 65dee0cbabbcca47a4ce2d237afdc3aa190a78ab Mon Sep 17 00:00:00 2001
From: Stavros kois <s.kois@outlook.com>
Date: Fri, 20 Jan 2023 18:12:46 +0200
Subject: [PATCH] doccs

---
 docs/common-library/values/gpu.md             | 32 -------------
 .../values/configmap.md                       | 13 ++++-
 docs/common/values/gpu.md                     | 48 +++++++++++++++++++
 .../values/hostname.md                        |  8 ++++
 .../values/secret.md                          | 12 ++++-
 5 files changed, 77 insertions(+), 36 deletions(-)
 delete mode 100644 docs/common-library/values/gpu.md
 rename docs/{common-library => common}/values/configmap.md (82%)
 create mode 100644 docs/common/values/gpu.md
 rename docs/{common-library => common}/values/hostname.md (86%)
 rename docs/{common-library => common}/values/secret.md (83%)

diff --git a/docs/common-library/values/gpu.md b/docs/common-library/values/gpu.md
deleted file mode 100644
index 3b874ea8..00000000
--- a/docs/common-library/values/gpu.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# GPU
-
-## key: scaleGPU
-
-- Type: `dict`
-- Default: `{}`
-- Helm Template: ❌
-
-It's used in SCALE GUI. Configuration is parsed by the Chart,
-and each key/value pair, is added in `deployment.spec.template.container.resources.limits`
-
-Example:
-
-```yaml
-scaleGPU:
-  gpu.intel.com/i915: "1"
-
-resources:
-  limits:
-    cpu: 4000m
-```
-
-Will result in:
-
-```yaml
-resources:
-  limits:
-    gpu.intel.com/i915: "1"
-    cpu: 4000m
-```
-
-`gpu.intel.com/i915` and it's value, are generated from the SCALE GUI.
diff --git a/docs/common-library/values/configmap.md b/docs/common/values/configmap.md
similarity index 82%
rename from docs/common-library/values/configmap.md
rename to docs/common/values/configmap.md
index ea3a36a4..c7d7f74e 100644
--- a/docs/common-library/values/configmap.md
+++ b/docs/common/values/configmap.md
@@ -2,13 +2,21 @@
 
 ## key: configmap
 
+Info:
+
 - Type: `dict`
 - Default: `{}`
 - Helm Template:
   - content.KEY: ❌
   - content.KEY.value: ✅
 
-`configmap` dict creates a configmap based on the `content`
+Can be defined in:
+
+- `.Values`.configmap
+
+---
+
+Creates a configmap based on the `content`
 
 Options:
 
@@ -22,9 +30,10 @@ configmap:
     annotations: {}
     # Optional
     nameOverride: ""
-    # Tells to common that this contains environment variables
+    # Tells to common library that this contains environment variables.
     # So it wil be checked for duplicates among `env`, `envList`, `fixedEnvs`
     # and other `secrets` / `configmaps` (with parseAsEnv set)
+    # Optional
     parseAsEnv: true
     # Key/Value
     content:
diff --git a/docs/common/values/gpu.md b/docs/common/values/gpu.md
new file mode 100644
index 00000000..bec7e2ba
--- /dev/null
+++ b/docs/common/values/gpu.md
@@ -0,0 +1,48 @@
+# GPU
+
+## key: scaleGPU
+
+Info:
+
+- Type: `dict`
+- Default: `{}`
+- Helm Template: ❌
+
+Can be defined in:
+
+- `.Values`.scaleGPU
+- `.Values.additionalContainers.[container-name]`.scaleGPU
+- `.Values.initContainers.[container-name]`.scaleGPU
+- `.Values.installContainers.[container-name]`.scaleGPU
+- `.Values.upgradeContainers.[container-name]`.scaleGPU
+- `.Values.systemContainers.[container-name]`.scaleGPU
+- `.Values.jobs.[job-name].podSpec.containers.[container-name].[container-name]`.scaleGPU
+
+---
+
+It's used in SCALE GUI. Configuration is parsed by the Chart,
+and each key/value pair, is added in the Pod's `spec.template.container.resources.limits`.
+
+> If a GPU is passed through, it will automatically append the group `44` in `supplementalGroups`.
+
+Example:
+
+```yaml
+scaleGPU:
+  gpu.intel.com/i915: "1"
+
+resources:
+  limits:
+    cpu: 4000m
+```
+
+Will result in:
+
+```yaml
+resources:
+  limits:
+    gpu.intel.com/i915: "1"
+    cpu: 4000m
+```
+
+`gpu.intel.com/i915` and it's value, are generated from the SCALE GUI and middleware.
diff --git a/docs/common-library/values/hostname.md b/docs/common/values/hostname.md
similarity index 86%
rename from docs/common-library/values/hostname.md
rename to docs/common/values/hostname.md
index 29552bee..3c08208f 100644
--- a/docs/common-library/values/hostname.md
+++ b/docs/common/values/hostname.md
@@ -2,10 +2,18 @@
 
 ## key: hostname
 
+Info:
+
 - Type: `string`
 - Default: `""`
 - Helm Template: ✅
 
+Can be defined in:
+
+- `.Values`.hostname
+
+---
+
 Specifies pod's hostname
 
 Examples:
diff --git a/docs/common-library/values/secret.md b/docs/common/values/secret.md
similarity index 83%
rename from docs/common-library/values/secret.md
rename to docs/common/values/secret.md
index 80dcc24a..5c300f25 100644
--- a/docs/common-library/values/secret.md
+++ b/docs/common/values/secret.md
@@ -2,6 +2,8 @@
 
 ## key: secret
 
+Info:
+
 - Type: `dict`
 - Default: `{}`
 - Helm Template:
@@ -9,7 +11,12 @@
   - content.KEY: ❌
   - content.KEY.value: ✅
 
-`secret` dict creates a secret based on the `content`
+Can be defined in:
+
+- `.Values`.secret
+
+---
+Creates a secret based on the `content`
 
 Options:
 
@@ -25,9 +32,10 @@ secret:
     nameOverride: ""
     # Optional - Defaults to Opaque
     secretType: ""
-    # Tells to common that this contains environment variables
+    # Tells to common library that this contains environment variables.
     # So it wil be checked for duplicates among `env`, `envList`, `fixedEnvs`
     # and other `secrets` / `configmaps` (with parseAsEnv set)
+    # Optional
     parseAsEnv: true
     # Key/Value
     content: