feat(helm): Add docs for more variables (#13224)

Author: kiblik

helm/defectdojo/README.md

@@ -612,6 +612,7 @@ A Helm chart for Kubernetes to install DefectDojo
 | django.service.type | string | `""` |  |
 | django.strategy | object | `{}` |  |
 | django.tolerations | list | `[]` |  |
+| django.uwsgi.appSettings.maxFd | int | `0` |  |
 | django.uwsgi.appSettings.processes | int | `4` |  |
 | django.uwsgi.appSettings.threads | int | `4` |  |
 | django.uwsgi.certificates.certFileName | string | `"ca.crt"` |  |
@@ -644,7 +645,9 @@ A Helm chart for Kubernetes to install DefectDojo
 | django.uwsgi.startupProbe.successThreshold | int | `1` |  |
 | django.uwsgi.startupProbe.timeoutSeconds | int | `1` |  |
 | extraConfigs | object | `{}` |  |
+| extraEnv | list | `[]` |  |
 | extraLabels | object | `{}` |  |
+| extraSecrets | object | `{}` |  |
 | gke.useGKEIngress | bool | `false` |  |
 | gke.useManagedCertificate | bool | `false` |  |
 | gke.workloadIdentityEmail | string | `""` |  |
@@ -667,6 +670,7 @@ A Helm chart for Kubernetes to install DefectDojo
 | initializer.run | bool | `true` |  |
 | initializer.staticName | bool | `false` |  |
 | initializer.tolerations | list | `[]` |  |
+| localsettingspy | string | `""` |  |
 | monitoring.enabled | bool | `false` |  |
 | monitoring.prometheus.enabled | bool | `false` |  |
 | monitoring.prometheus.image | string | `"nginx/nginx-prometheus-exporter:1.4.2"` |  |
@@ -722,6 +726,7 @@ A Helm chart for Kubernetes to install DefectDojo
 | tests.unitTests.resources.limits.memory | string | `"512Mi"` |  |
 | tests.unitTests.resources.requests.cpu | string | `"100m"` |  |
 | tests.unitTests.resources.requests.memory | string | `"128Mi"` |  |
+| trackConfig | string | `"disabled"` |  |
 
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

helm/defectdojo/templates/configmap.yaml

@@ -48,7 +48,9 @@ data:
   DD_UWSGI_PASS: unix:///run/defectdojo/uwsgi.sock
   DD_UWSGI_NUM_OF_PROCESSES: '{{ .Values.django.uwsgi.appSettings.processes | default 4 }}'
   DD_UWSGI_NUM_OF_THREADS: '{{ .Values.django.uwsgi.appSettings.threads | default 4 }}'
+  {{- if  .Values.django.uwsgi.appSettings.maxFd }}
   DD_UWSGI_MAX_FD: '{{ .Values.django.uwsgi.appSettings.maxFd }}'
+  {{- end }}
   DD_DJANGO_METRICS_ENABLED: '{{ .Values.monitoring.enabled }}'
   NGINX_METRICS_ENABLED: '{{ .Values.monitoring.enabled }}'
   METRICS_HTTP_AUTH_USER: {{ .Values.monitoring.user | default "monitoring" }}

helm/defectdojo/values.schema.json

@@ -432,6 +432,9 @@
                         "appSettings": {
                             "type": "object",
                             "properties": {
+                                "maxFd": {
+                                    "type": "integer"
+                                },
                                 "processes": {
                                     "type": "integer"
                                 },
@@ -569,9 +572,15 @@
         "extraConfigs": {
             "type": "object"
         },
+        "extraEnv": {
+            "type": "array"
+        },
         "extraLabels": {
             "type": "object"
         },
+        "extraSecrets": {
+            "type": "object"
+        },
         "gke": {
             "type": "object",
             "properties": {
@@ -666,6 +675,9 @@
                 }
             }
         },
+        "localsettingspy": {
+            "type": "string"
+        },
         "monitoring": {
             "type": "object",
             "properties": {
@@ -986,6 +998,9 @@
                     }
                 }
             }
+        },
+        "trackConfig": {
+            "type": "string"
         }
     }
 }

helm/defectdojo/values.yaml

@@ -10,7 +10,7 @@ createPostgresqlSecret: false
 # can be:
 # - disabled, default
 # - enabled, enables tracking configuration changes based on SHA256
-# trackConfig: disabled
+trackConfig: disabled
 
 # Avoid using pre-install hooks, which might cause issues with ArgoCD
 disableHooks: false
@@ -328,7 +328,7 @@ django:
     appSettings:
       processes: 4
       threads: 4
-      # maxFd: 102400 # Uncomment to set the maximum number of file descriptors. If not set will be detected by uwsgi
+      maxFd: 0  # 102400 # Use this value to set the maximum number of file descriptors. If set to 0 will be detected by uwsgi
     enableDebug: false  # this also requires DD_DEBUG to be set to True
     certificates:
     # includes additional CA certificate as volume, it refrences REQUESTS_CA_BUNDLE env varible
@@ -490,20 +490,19 @@ redis:
 
 # To add extra variables not predefined by helm config it is possible to define in extraConfigs block, e.g. below:
 # NOTE  Do not store any kind of sensitive information inside of it
-# extraConfigs:
+extraConfigs: {}
 #   DD_SOCIAL_AUTH_AUTH0_OAUTH2_ENABLED: 'true'
 #   DD_SOCIAL_AUTH_AUTH0_KEY: 'dev'
 #   DD_SOCIAL_AUTH_AUTH0_DOMAIN: 'xxxxx'
 
 # Extra secrets can be created inside of extraSecrets block:
 # NOTE  This is just an exmaple, do not store sensitive data in plain text form, better inject it during the deployment/upgrade by --set extraSecrets.secret=someSecret
-# extraSecrets:
+extraSecrets: {}
 #   DD_SOCIAL_AUTH_AUTH0_SECRET: 'xxx'
-extraConfigs: {}
 
 # To add (or override) extra variables which need to be pulled from another configMap, you can
 # use extraEnv. For example:
-# extraEnv:
+extraEnv: []
 # - name: DD_DATABASE_HOST
 #   valueFrom:
 #     configMapKeyRef:
@@ -513,6 +512,7 @@ extraConfigs: {}
 # To add code snippet which would extend setting functionality, you might add it here
 # It will be stored as ConfigMap and mounted `dojo/settings/local_settings.py`.
 # For more see: https://documentation.defectdojo.com/getting_started/configuration/
+localsettingspy: ""
 # For example:
 # localsettingspy: |
 #   INSTALLED_APPS += (