chart-seafile: improve documentation

charts/seafile/README.md

@@ -28,20 +28,16 @@ An open-source, cross-platform file-hosting software system.
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` | affinity |
-| autoscaling | object | `{"enabled":false,"maxReplicas":100,"minReplicas":1,"targetCPUUtilizationPercentage":80}` | autoscaling settings |
 | autoscaling.enabled | boolean | `false` | whether autoscaling should be enabled |
 | autoscaling.maxReplicas | int | `100` | maximum number of replicas |
 | autoscaling.minReplicas | int | `1` | minimum number of replicas |
 | autoscaling.targetCPUUtilizationPercentage | int | `80` | try to utilize this much CPU [%] |
 | fullnameOverride | string | `""` | override the fullname of the entire chart |
-| global | object | `{"storageClass":""}` | global settings |
 | global.storageClass | string | `""` | global storage class for PVCs |
-| image | object | `{"pullPolicy":"IfNotPresent","repository":"seafileltd/seafile-mc","tag":""}` | seafile image configuration |
 | image.pullPolicy | string | `"IfNotPresent"` | when to pull the image |
 | image.repository | string | `"seafileltd/seafile-mc"` | what seafile image to use |
 | image.tag | string | `""` | override image tag; default is the chart appVersion |
 | imagePullSecrets | list | `[]` | secrets used to pull the image |
-| ingress | object | `{"annotations":{},"className":"","enabled":false,"hosts":[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[]}` | ingress setup |
 | ingress.annotations | object | `{}` | additional ingress annotations |
 | ingress.className | string | `""` | override ingress class name |
 | ingress.enabled | boolean | `false` | whether an ingress should be generated |
@@ -49,14 +45,13 @@ An open-source, cross-platform file-hosting software system.
 | ingress.tls | list | `[]` | TLS setup |
 | livenessProbe.httpGet.path | string | `"/"` |  |
 | livenessProbe.httpGet.port | string | `"http"` |  |
-| mariadb | object | `{"auth":{"rootPassword":"changeme"},"persistence":{"enabled":true,"size":"1Gi","storageClass":""}}` | mariadb subchart configuration |
 | mariadb.auth | object | `{"rootPassword":"changeme"}` | auth settings |
 | mariadb.auth.rootPassword | string | `"changeme"` | root user password; DO NOT FORGET TO CHANGE THIS VALUE |
 | mariadb.persistence | object | `{"enabled":true,"size":"1Gi","storageClass":""}` | DB persistence settings |
-| memcached | object | `{"extraEnvVars":[{"name":"MEMCACHED_CACHE_SIZE","value":"256M"}]}` | memcached subchart configuration |
+| memcached.extraEnvVars[0].name | string | `"MEMCACHED_CACHE_SIZE"` |  |
+| memcached.extraEnvVars[0].value | string | `"256M"` |  |
 | nameOverride | string | `""` | override the name of the entire chart |
 | nodeSelector | object | `{}` | node selectors |
-| persistence | object | `{"accessModes":["ReadWriteOnce"],"annotations":{},"create":true,"enabled":true,"labels":{},"size":"16Gi","storageClass":""}` | persistence settings |
 | persistence.accessModes | list | `["ReadWriteOnce"]` | PVC access modes |
 | persistence.annotations | object | `{}` | additional PVC annotations |
 | persistence.create | boolean | `true` | whether to create PVCs |
@@ -71,12 +66,10 @@ An open-source, cross-platform file-hosting software system.
 | readinessProbe.httpGet.port | string | `"http"` |  |
 | replicaCount | int | `1` | number of seafile replicas to run (only tested with 1) |
 | resources | object | `{}` | custom resources |
-| seafile | object | `{"admin_email":"admin@hostname.tld","admin_password":"changeme2","timezone":"Europe/Berlin"}` | seafile app configuration |
 | seafile.admin_email | string | `"admin@hostname.tld"` | email address of the admin user |
 | seafile.admin_password | string | `"changeme2"` | password of the admin user; DO NOT FORGET TO CHANGE THIS VALUE |
 | seafile.timezone | string | `"Europe/Berlin"` | [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
 | securityContext | object | `{}` | custom security context |
-| service | object | `{"port":80,"type":"ClusterIP"}` | service setup |
 | service.port | int | `80` | service port |
 | service.type | string | `"ClusterIP"` | service type |
 | serviceAccount.annotations | object | `{}` | service account annotations |

charts/seafile/values.yaml

@@ -2,12 +2,10 @@
 # -- (int) number of seafile replicas to run (only tested with 1)
 replicaCount: 1
 
-# -- global settings
 global:
   # -- global storage class for PVCs
   storageClass: ''
 
-# -- seafile image configuration
 image:
   # -- what seafile image to use
   repository: seafileltd/seafile-mc
@@ -49,14 +47,12 @@ securityContext: {}
   # runAsNonRoot: true
   # runAsUser: 1000
 
-# -- service setup
 service:
   # -- service type
   type: ClusterIP
   # -- (int) service port
   port: 80
 
-# -- ingress setup
 ingress:
   # -- (boolean) whether an ingress should be generated
   enabled: false
@@ -97,7 +93,6 @@ readinessProbe:
     path: /
     port: http
 
-# -- autoscaling settings
 autoscaling:
   # -- (boolean) whether autoscaling should be enabled
   enabled: false
@@ -109,7 +104,6 @@ autoscaling:
   targetCPUUtilizationPercentage: 80
   # targetMemoryUtilizationPercentage: 80
 
-# -- persistence settings
 persistence:
   # -- (boolean) whether to handle persistence at all
   enabled: true
@@ -135,7 +129,6 @@ tolerations: []
 # -- affinity
 affinity: {}
 
-# -- seafile app configuration
 seafile:
   # -- [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
   timezone: Europe/Berlin
@@ -144,7 +137,6 @@ seafile:
   # -- password of the admin user; DO NOT FORGET TO CHANGE THIS VALUE
   admin_password: changeme2
 
-# -- mariadb subchart configuration
 mariadb:
   # -- auth settings
   auth:
@@ -156,7 +148,6 @@ mariadb:
     storageClass: ''
     size: 1Gi
 
-# -- memcached subchart configuration
 memcached:
   extraEnvVars:
     - name: MEMCACHED_CACHE_SIZE