Document ClamAV chart settings

charts/sddi-ckan/charts/ckan/README.md

@@ -49,11 +49,11 @@ A Helm chart for SDDI enabled CKAN.
 | autoscaling.targetCPUUtilizationPercentage | string | `nil` | [HorizontalPodAutoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/). |
 | autoscaling.targetMemoryUtilizationPercentage | string | `nil` | [HorizontalPodAutoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/). |
 | backgroundImage | string | `"../base/images/hero.jpg"` | Set URL or path to [CKAN SDDI background image](https://github.com/tum-gis/ckanext-grouphierarchy-sddi#personalisation). |
-| clamav.enabled | bool | `true` |  |
-| clamav.host | string | `"clamav"` |  |
-| clamav.port | int | `3310` |  |
-| clamav.timeout | int | `360` |  |
-| clamav.uploadUnscanned | string | `"False"` |  |
+| clamav.enabled | bool | `true` | [CKAN config enable ClamAV] |
+| clamav.host | string | `"clamav"` | [CKAN config ClamAV host] |
+| clamav.port | int | `3310` | [CKAN config ClamAV port] |
+| clamav.timeout | int | `360` | [CKAN config ClamAV connection timeout] |
+| clamav.uploadUnscanned | string | `"False"` | [CKAN config ClamAV upload unscanned files] |
 | component | string | `"ckan"` | Role of CKAN in this chart |
 | datapusher.apiToken | string | `nil` | Datapusher API token, see [CKAN Datapusher settings](https://docs.ckan.org/en/latest/maintaining/configuration.html#datapusher-settings) |
 | datapusher.callback_url_base | string | `"http://ckan:5000/"` | This should be set to cluster internal ckan service domain. [CKAN DataPusher settings](https://docs.ckan.org/en/latest/maintaining/configuration.html#ckan-datapusher-callback-url-base) |
@@ -137,7 +137,6 @@ A Helm chart for SDDI enabled CKAN.
 | readiness.timeoutSeconds | int | `10` | Timeout interval for the liveness probe |
 | redis.url | string | `"redis://redis-hl:6379/0"` | Redis endpoint for CKAN. This should be set to cluster internal Redis service domain. [CKAN configuration Redis](https://docs.ckan.org/en/latest/maintaining/configuration.html#redis-settings) |
 | replicaCount | int | `1` | Number of replicas. Only used if `autoscaling.enabled = false`. **Note:** Running multiple replicas requires to enable persistent data storage (`persistence.enabled = true`) and, if Pods run on different nodes, a storage that supports RWX. |
-| resources | object | `{}` | [k8s: Resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) |
 | resources.limits.cpu | string | `"500m"` | [k8s: Resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) |
 | resources.limits.memory | string | `"1Gi"` | [k8s: Resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) |
 | resources.requests.cpu | string | `"250m"` | [k8s: Resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) |

charts/sddi-ckan/charts/ckan/values.yaml

@@ -499,10 +499,15 @@ activityStreams:
   emailNotifications: True
 
 clamav:
+  # -- [CKAN config enable ClamAV]
   enabled: true
+  # -- [CKAN config ClamAV upload unscanned files]
   uploadUnscanned: "False"
+  # -- [CKAN config ClamAV host]
   host: clamav
+  # -- [CKAN config ClamAV port]
   port: 3310
+  # -- [CKAN config ClamAV connection timeout]
   timeout: 360
 
 resources:
@@ -517,8 +522,6 @@ resources:
     # -- [k8s: Resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
     memory: 256Mi
 
-# -- [k8s: Resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
-resources: {}
 # -- [k8s: Assign pods to nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/)
 nodeSelector: {}
 # -- [k8S: Taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)