generate helm docs

charts/tandoor-recipes/README.md

@@ -0,0 +1,66 @@
+# tandoor-recipes
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.5.11](https://img.shields.io/badge/AppVersion-1.5.11-informational?style=flat-square)
+
+A Helm chart for Tandoor Recipes, a digital recipe manager
+
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.bitnami.com/bitnami | postgresql | ^12.12.10 |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| externalPostgresql.database | string | `"recipes"` |  |
+| externalPostgresql.enabled | bool | `false` | Use an external PostgreSQL database |
+| externalPostgresql.port | int | `5432` |  |
+| externalPostgresql.username | string | `"recipes"` |  |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"ghcr.io/tandoorrecipes/recipes"` |  |
+| image.tag | string | `""` |  |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"recipes.local"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| persistence.media.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.media.annotations | object | `{}` |  |
+| persistence.media.enabled | bool | `false` | Enable persistence for media files |
+| persistence.media.existingClaim | string | `""` |  |
+| persistence.media.size | string | `"1Gi"` |  |
+| persistence.media.storageClass | string | `""` |  |
+| persistence.static.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.static.annotations | object | `{}` |  |
+| persistence.static.enabled | bool | `false` | Enable persistence for static files |
+| persistence.static.existingClaim | string | `""` |  |
+| persistence.static.size | string | `"1Gi"` |  |
+| persistence.static.storageClass | string | `""` |  |
+| podAnnotations | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| postgresql.auth.database | string | `"recipes"` |  |
+| postgresql.auth.password | string | `"recipes"` |  |
+| postgresql.auth.username | string | `"recipes"` |  |
+| postgresql.enabled | bool | `true` | Deploy Bitnami PostgreSQL sub-chart |
+| recipes.secretKey | string | `""` | Secret key used by Djano - see https://docs.tandoor.dev/system/configuration/#secret-key |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.port | int | `8080` |  |
+| service.type | string | `"ClusterIP"` |  |
+| 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 |
+| tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)

charts/tandoor-recipes/values.yaml

@@ -15,12 +15,11 @@ nameOverride: ""
 fullnameOverride: ""
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template
-  # If not set and create is true, a name is generated using the fullname template
   name: ""
 
 podAnnotations: {}
@@ -41,6 +40,7 @@ service:
   port: 8080
 
 externalPostgresql:
+  # -- Use an external PostgreSQL database
   enabled: false
   # host: postgres
   port: 5432
@@ -51,6 +51,7 @@ externalPostgresql:
   # existingSecretPasswordKey: password
 
 postgresql:
+  # -- Deploy Bitnami PostgreSQL sub-chart
   enabled: true
   auth:
     database: recipes
@@ -59,10 +60,12 @@ postgresql:
 
 
 recipes:
+  # -- Secret key used by Djano - see https://docs.tandoor.dev/system/configuration/#secret-key
   secretKey: ""
 
 persistence:
   static:
+    # -- Enable persistence for static files
     enabled: false
     existingClaim: ""
     annotations: {}
@@ -70,6 +73,7 @@ persistence:
     storageClass: ""
     size: 1Gi
   media:
+    # -- Enable persistence for media files
     enabled: false
     existingClaim: ""
     annotations: {}