docs: generate chart documentation

Signed-off-by: Arsène Fougerouse <[email protected]>

charts/cryptpad/Chart.yaml

@@ -21,7 +21,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.0.8
+version: 0.0.9
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/cryptpad/README.md

@@ -23,47 +23,25 @@ CryptPad is a collaboration suite that is end-to-end-encrypted and open-source.
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| affinity | object | `{}` |  |
-| apiDomain | string | `""` |  |
-| application_config | string | `nil` |  |
-| autoscaling.enabled | bool | `false` |  |
-| autoscaling.maxReplicas | int | `100` |  |
-| autoscaling.minReplicas | int | `1` |  |
-| autoscaling.targetCPUUtilizationPercentage | int | `80` |  |
-| autoscaling.targetMemoryUtilizationPercentage | int | `80` |  |
-| config.adminKeys | list | `[]` |  |
-| config.archivePath | string | `"./data/archive"` |  |
-| config.blobPath | string | `"./blob"` |  |
-| config.blobStagingPath | string | `"./data/blobstage"` |  |
-| config.blockPath | string | `"./block"` |  |
-| config.decreePath | string | `"./data/decrees"` |  |
-| config.filePath | string | `"./datastore/"` |  |
-| config.httpAddress | string | `"0.0.0.0"` |  |
-| config.installMethod | string | `"helm-docker"` |  |
-| config.logFeedback | bool | `false` |  |
-| config.logLevel | string | `"info"` |  |
-| config.logPath | string | `"./data/logs"` |  |
-| config.logToStdout | bool | `false` |  |
-| config.pinPath | string | `"./data/pins"` |  |
-| config.taskPath | string | `"./data/tasks"` |  |
-| config.verbose | bool | `false` |  |
-| cpadConfig | string | `"/cryptpad/config/config.js"` |  |
-| filesDomain | string | `""` |  |
+| affinity | object | `{}` | Values for the Affinity |
+| apiDomain | string | `""` | CryptPad API subdomain FQDN |
+| application_config | string | `nil` | Configuration of the [application](https://docs.cryptpad.org/en/admin_guide/customization.html#application-config) |
+| autoscaling.enabled | bool | `false` | Enable the Autoscaling |
+| autoscaling.maxReplicas | int | `100` | Maximum numbers of replicas |
+| autoscaling.minReplicas | int | `1` | Minimal numbers of replicas |
+| autoscaling.targetCPUUtilizationPercentage | int | `80` | Percentage of the targeted CPU Utilization |
+| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Percentage of the targeted Memory Utilization |
+| config | object | `{"adminKeys":[],"archivePath":"./data/archive","blobPath":"./blob","blobStagingPath":"./data/blobstage","blockPath":"./block","decreePath":"./data/decrees","filePath":"./datastore/","httpAddress":"0.0.0.0","installMethod":"helm-docker","logFeedback":false,"logLevel":"info","logPath":"./data/logs","logToStdout":false,"pinPath":"./data/pins","taskPath":"./data/tasks","verbose":false}` | [Configuration of Cryptpad](https://docs.cryptpad.org/en/admin_guide/installation.html#admin-cryptpad-config) |
+| cpadConfig | string | `"/cryptpad/config/config.js"` | File to mount for the CPAD Configuration (`CPAD_CONF`) |
+| filesDomain | string | `""` | CryptPad files subdomain FQDN |
 | fullnameOverride | string | `""` |  |
-| http2Disable | string | `""` |  |
-| image.pullPolicy | string | `"IfNotPresent"` |  |
-| image.repository | string | `"cryptpad/cryptpad"` |  |
-| image.tag | string | `"version-5.4.0"` |  |
+| http2Disable | string | `""` | Disable HTTP2 |
+| image | object | `{"pullPolicy":"IfNotPresent","repository":"cryptpad/cryptpad","tag":"version-5.4.0"}` | Parameters for the Cryptpad image used |
 | imagePullSecrets | list | `[]` |  |
-| ingress.annotations | object | `{}` |  |
-| ingress.className | string | `""` |  |
-| ingress.enabled | bool | `false` |  |
-| ingress.hosts[0].host | string | `"localhost"` |  |
-| ingress.hosts[0].paths[0].path | string | `"/"` |  |
-| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
-| ingress.tls | list | `[]` |  |
+| ingress | object | `{"annotations":{},"className":"","enabled":false,"hosts":[{"host":"localhost","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[]}` | Values for the ingress |
+| ingress.enabled | bool | `false` | Enable the ingress |
 | nameOverride | string | `""` |  |
-| nodeSelector | object | `{}` |  |
+| nodeSelector | object | `{}` | Values for the Node Selector |
 | persistence.cryptpad.blob.accessModes[0] | string | `"ReadWriteOnce"` |  |
 | persistence.cryptpad.blob.annotations | object | `{}` |  |
 | persistence.cryptpad.blob.dataSource | object | `{}` |  |
@@ -96,30 +74,24 @@ CryptPad is a collaboration suite that is end-to-end-encrypted and open-source.
 | persistence.cryptpad.datastore.selector | object | `{}` |  |
 | persistence.cryptpad.datastore.size | string | `"100Mi"` |  |
 | persistence.cryptpad.datastore.storageClass | string | `""` |  |
-| persistence.enabled | bool | `true` |  |
-| podAnnotations | object | `{}` |  |
-| podSecurityContext.fsGroup | int | `4001` |  |
-| realIpHeader | string | `""` |  |
-| realIpRecursive | string | `""` |  |
-| replicaCount | int | `1` |  |
-| resources | object | `{}` |  |
-| securityContext | object | `{}` |  |
-| service.externalIPs | list | `[]` |  |
-| service.externalPort | int | `80` |  |
-| service.internalPort | string | `"http"` |  |
-| service.name | string | `"http"` |  |
-| service.portName | string | `"node"` |  |
-| service.sessionAffinity | string | `"ClientIP"` |  |
-| service.type | string | `"ClusterIP"` |  |
-| serviceAccount.annotations | object | `{}` |  |
-| serviceAccount.create | bool | `true` |  |
-| serviceAccount.name | string | `""` |  |
-| tlsCert | string | `""` |  |
-| tlsDhParam | string | `""` |  |
-| tlsKey | string | `""` |  |
-| tolerations | list | `[]` |  |
-| trustedProxy | string | `""` |  |
-| workloadStateful | bool | `true` |  |
+| persistence.enabled | bool | `true` | Enable the persistence |
+| podAnnotations | object | `{}` | Annotations for the Pod |
+| podSecurityContext | object | `{"fsGroup":4001}` | Security context for the Pod |
+| realIpHeader | string | `""` | Header to get client IP from (`X-Real-IP` or `X-Forwarded-For`) |
+| realIpRecursive | string | `""` | Instruct Nginx to perform a recursive search to find client's real IP (`on`/`off`) (see [ngx_http_realip_module](https://nginx.org/en/docs/http/ngx_http_realip_module.html)) |
+| replicaCount | int | `1` | Number of replicas |
+| resources | object | `{}` | Specify default resources We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube.  |
+| securityContext | object | `{}` | Security context |
+| service | object | `{"externalIPs":[],"externalPort":80,"internalPort":"http","name":"http","portName":"node","sessionAffinity":"ClientIP","type":"ClusterIP"}` | Values for the service |
+| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| tlsCert | string | `""` | Path to TLS certificate file |
+| tlsDhParam | string | `""` | Path to Diffie-Hellman parameters file |
+| tlsKey | string | `""` | Path to TLS private key file |
+| tolerations | list | `[]` | Values for the Tolerations |
+| trustedProxy | string | `""` | Trusted proxy address or CIDR |
+| workloadStateful | bool | `true` | Enable to choose witch kind of workload will be used: (true) StatefulSet or (false) for Deployment |
 
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.11.2](https://github.com/norwoodj/helm-docs/releases/v1.11.2)

charts/cryptpad/values.yaml

@@ -150,7 +150,7 @@ ingress:
   tls: []
   #  - secretName: secret-tls
 
-# -- Specify default resources
+# -- Specify default resources.
 # We usually recommend not to specify default resources and to leave this as a conscious
 # choice for the user. This also increases chances charts run on environments with little
 # resources, such as Minikube.