Simplify defaults and link more external documentation

README.md

@@ -1,33 +1,38 @@
 Vikunja Helm Chart
 ===
 
-Deployes both frontend and backend. Also, you can deploy bitnami's PostgreSQL and Redis as subcharts if you want.
+Customizable deployment of frontend and api.
+Deploys bitnami's PostgreSQL and Redis as subcharts if you want.
 
 ## Requirements
 
-Kubernetes >= 1.19  
-Helm >= 3
+- Kubernetes >= 1.19  
+- Helm >= 3
 
 ## Quickstart
 
-Default settings should work for you and if you define ingress settings according to your controller (for both API and Frontend), you will be able to access the frontend. Anyway, it won't have any default credentials. In order to create a user, you **have to enable registration** and register a new user.
-
-```yaml
-api:
-  config:
-    service:
-      enableregistration: true
-```
-
-Once you have registered, you can disable registration back if you do not need it.
+Define ingress settings according to your controller (for both API and Frontend) to access the application.
+You can set all Vikunja API options as yaml under `api.config`: https://vikunja.io/docs/config-options
 
 ## Advanced features
 
+### Replicas
+
+Both Frontend and API can be configured to have replicas including autoscaling.
+When replicating the API, make sure to set up the redis cache as well
+by setting `api.config.keyvalue.type` to `redis`,
+configuring the redis subchart (see [values.yaml](./values.yaml))
+and the connection to Vikunja:
+https://vikunja.io/docs/config-options/#redis
+
 ### Raw resources
 
-Often happens, that you have to deploy some cloud-specific resources that are not a part of the application chart itself. You have to either create an extra chart for that, or manage them with other tools (kustomize, plain manifests etc.). That is painful. We have a solution. If you want to create anything that is not present in the chart, *just add it in raw*!
+Sometimes you have to deploy some cloud-specific resources that are not a part of the application chart itself.
+You have to either create an extra chart for that, or manage them with other tools (kustomize, plain manifests etc.).
+That is painful. We have a solution. If you want to create anything that is not present in the chart, *just add it in raw*!
 
-Let's say, you are hosted in [GKE](https://cloud.google.com/kubernetes-engine) and want to use Google-managed TLS certificates. In order to do that, you have to create a ManagedCertificate resource. It can be done this way.
+Let's say, you are hosted in [GKE](https://cloud.google.com/kubernetes-engine) and want to use Google-managed TLS certificates.
+In order to do that, you have to create a ManagedCertificate resource:
 
 ```yaml
 frontend:
@@ -131,6 +136,8 @@ This is helpful when migrating from a different k8s chart and want to re-use the
 
 ## Publishing
 
+These steps are automatically performed on a git tag.
+
 1. Pull all dependencies before packaging.
 
   ```shell

values.yaml

@@ -27,8 +27,6 @@ frontend:
   # Public API URL that client's browser will reach
   apiUrl: ""
 
-  replicaCount: 1
-
   image:
     repository: vikunja/frontend
     pullPolicy: IfNotPresent
@@ -82,6 +80,8 @@ frontend:
     #   cpu: 100m
     #   memory: 128Mi
 
+  replicaCount: 1
+
   autoscaling:
     enabled: false
     minReplicas: 1
@@ -138,39 +138,13 @@ frontend:
 #  ┘ ┘┘  ┘
 
 api:
-  # Values for this config are described here https://vikunja.io/docs/config-options/
+  # Everything under this key is loaded into a native Vikunja yaml config: https://vikunja.io/docs/config-options/
   config:
-    service:
-      JWTSecret: ""
-      interface: ":3456"
-      frontendurl: ""
-      enableregistration: false
-      timezone: GMT
     database:
       type: sqlite
       path: /sqlite/vikunja.db
-    cache:
-      enabled: true
-      type: redis
-    redis:
-      enabled: false
-      host: ""
-      password: ""
-      db: 0
-    cors:
-      enable: false
-      origins: []
-    mailer:
-      enabled: false
-    log:
-      path: null
     files:
       basepath: /files
-    defaultsettings:
-      avatar_provider: gravatar
-      discoverable_by_name: true
-      discoverable_by_email: true
-      week_start: 1
   
   persistence:
     enabled: false
@@ -186,8 +160,6 @@ api:
       #     storage: 1Gi
       # storageClassName: openebs-hostpath
 
-  replicaCount: 1
-
   image:
     repository: vikunja/api
     pullPolicy: IfNotPresent
@@ -235,6 +207,8 @@ api:
     #   cpu: 100m
     #   memory: 128Mi
 
+  replicaCount: 1
+
   autoscaling:
     enabled: false
     minReplicas: 1
@@ -289,12 +263,13 @@ api:
 
   envFrom: {}
 
-#  ┬─┐┌─┐┐─┐┌┐┐┌─┐┬─┐┬─┐┐─┐┐─┐┬  
-#  │─┘│ │└─┐ │ │ ┬│┬┘├─ └─┐│ ││  
+#  ┬─┐┌─┐┐─┐┌┐┐┌─┐┬─┐┬─┐┐─┐┐─┐┬
+#  │─┘│ │└─┐ │ │ ┬│┬┘├─ └─┐│ ││
 #  ┘  ┘─┘──┘ ┘ ┘─┘┘└┘┴─┘──┘└─\┘─┘
 
 postgresqlEnabled: false
 # Please refer to PostgreSQL subchart for a full list of possible values
+# https://github.com/bitnami/charts/tree/main/bitnami/postgresql/#parameters
 postgresql: {}
 
 #  ┬─┐┬─┐┬─┐o┐─┐
@@ -303,6 +278,7 @@ postgresql: {}
 
 redisEnabled: false
 # Please refer to Redis subchart for a full list of possible values
+# https://github.com/bitnami/charts/tree/main/bitnami/redis/#parameters
 redis: {}
 
 #  ┬─┐┬─┐┐ ┬