docs

docs/common/values/certificates.md

@@ -1,6 +1,8 @@
 # Certificates
 
-## scaleCerts
+## Key: scaleCerts
+
+Info:
 
 - Type: `dict`
 - Default: `{}`
@@ -8,6 +10,12 @@
   - certPath: ✅
   - keyPath: ✅
 
+Can be defined in:
+
+- `.Values`.scaleCerts
+
+---
+
 Before taking any action, it will check if middleware have populated
 the `ixCertificates` list, and that the `id` is included.
 
@@ -20,7 +28,7 @@ container as files.
 Examples:
 
 ```yaml
-scaleCerts: {}
+scaleCerts:
   some_cert_name:
     # ID Comes from the definitions on the GUI
     id: 1
@@ -36,7 +44,12 @@ scaleCerts: {}
     useExpired: false
 ```
 
-## scaleCertsList
+---
+---
+
+## Key: scaleCertsList
+
+Info:
 
 - Type: `list`
 - Default: `[]`
@@ -44,6 +57,12 @@ scaleCerts: {}
   - certPath: ✅
   - keyPath: ✅
 
+Can be defined in:
+
+- `.Values`.scaleCertsList
+
+---
+
 Anything that applies to `scaleCerts` applies here too.
 
 The only difference is that this is a `list` instead of `dict`
@@ -53,7 +72,7 @@ This list can used for Scale GUI as it's easier to build lists.
 Example:
 
 ```yaml
-scaleCertsList: []
+scaleCertsList:
   - name: some_cert_name
     id: 1
     # Optional

library/common/1.0.0/values.yaml

@@ -2,60 +2,103 @@
 # All values can be overridden per chart, in their values.yaml
 # For Examples and Explanation view the "Values.yaml Explained" markdown file
 
+# Defines image info
 image:
   repository: repo
   tag: tag
   pullPolicy: IfNotPresent
 
+# Defines the image that will be used
 imageSelector: ""
 
+# Defines the imagePullSecrets
 imagePullCredentials: []
 
-command: []
-
-args: []
-
-extraArgs: []
-
+# Defines environment variables
 env: {}
 
+# SCALE / GUI Focused
 envList: []
 
+# Defines the environment variables from a secret or configmap
 envFrom: []
 
-configmap: {}
-
-secret: {}
-
+# Defines the timezone for the container
 TZ: UTC
 
-lifecycle: {}
+# Default Security values for main container
+security:
+  PUID: 568
+  UMASK: "002"
 
+# Nvidia Caps will be assigned via environment variable
+# If empty, global defaults will be used
+nvidiaCaps: []
+
+stdin: false
+
+tty: false
+
+# Overrides the default entrypoint
+command: []
+
+# Overrides the default args
+args: []
+
+# Appends to args
+extraArgs: []
+
+# Adds hosts to /etc/hosts
+hostAliases: []
+
+# Binds to host network
+hostNetwork: false
+
+# Creates a service account
+serviceAccount:
+  main:
+    enabled: false
+    primary: true
+    automountServiceAccountToken: true
+
+# Creates Role and RoleBinding
+# (or ClusterRole and ClusterRoleBinding if clusterWide is true)
 rbac:
   main:
     enabled: false
     primary: true
     clusterWide: false
 
-serviceAccount:
-  main:
-    enabled: false
-    primary: true
+# Creates a configmap
+configmap: {}
 
+# Creates a secret
+secret: {}
+
+# Defines lifecycle hooks
+lifecycle: {}
+
+# Used for SCALE / GUI Focused
+scaleGPU: {}
+
+# Adds annotations to the pod
+podAnnotations: {}
+
+# Adds annotations to the service
 addAnnotations:
   traefik: true
   metallb: true
 
-hostAliases: []
+# Used for SCALE
+scaleCerts: {}
 
-hostNetwork: false
+# Used for SCALE / GUI Focused
+scaleCertsList: []
+
+# - Everything bellow needs documentation
 
 hostname: ""
 
-tty: false
-
-stdin: false
-
 probes:
   liveness:
     enabled: true
@@ -64,18 +107,9 @@ probes:
   startup:
     enabled: true
 
-# Used for SCALE / GUI Focused
-scaleGPU: {}
-
 # Used for SCALE / GUI Focused
 externalInterfaces: []
 
-# Used for SCALE
-scaleCerts: {}
-
-# Used for SCALE / GUI Focused
-scaleCertsList: []
-
 # Injected from middleware
 ixExternalInterfacesConfiguration: []
 # Injected from middleware
@@ -88,8 +122,6 @@ ixVolumes: []
 portal:
   enabled: true
 
-# - Everything bellow needs documentation
-
 global:
   nameOverride: ""
   fullnameOverride: ""
@@ -218,10 +250,7 @@ podSecurityContext:
   fsGroup: 568
   supplementalGroups: []
   fsGroupChangePolicy: OnRootMismatch
-# Default Security values for main container
-security:
-  PUID: 568
-  UMASK: "002"
+
 # Default securityContext for main container
 securityContext:
   runAsNonRoot: true
@@ -247,8 +276,6 @@ nameOverride: ""
 
 fullnameOverride: ""
 
-podAnnotations: {}
-
 podLabels: {}
 
 enableServiceLinks: false