add section to README

2023-12-13 10:35:51 +01:00
parent 95c063a964
commit c5a5b91e9d
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@
 - [Server defaults](#server-defaults) 
 - [Metrics defaults](#metrics-defaults) 
 - [Rootless Defaults](#rootless-defaults) 
+ - [Session, Cache and Queue](#session-cache-and-queue) 
 - [Single-Pod Configurations](#single-pod-configurations) 
 - [Additional _app.ini_ settings](#additional-appini-settings) 
 - [User defined environment variables in app.ini](#user-defined-environment-variables-in-appini) 
@@ -197,6 +198,16 @@ If `.Values.image.rootless: true`, then the following will occur. In case you us
 
 [see deployment.yaml](./templates/gitea/deployment.yaml) template inside container "env" declarations 
 
+#### Session, Cache and Queue 
+ 
+The session, cache and queue settings are set to use the built-in Redis Cluster sub-chart dependency. 
+If Redis Cluster is disabled, the chart will fall back to the Gitea defaults which use "memory" for `session` and `cache` and "level" for `queue`. 
+ 
+While these will work and even not cause immediate issues after startup, **they are not recommended for production use**. 
+Reasons being that a single pod will take on all the work for `session` and `cache` tasks in its available memory. 
+It is likely that the pod will run out of memory or will face substantial memory spikes, depending on the workload. 
+External tools such as `redis-cluster` or `memcached` handle these workloads much better. 
+ 
 ### Single-Pod Configurations 
 
 If HA is not needed/desired, the following configurations can be used to deploy a single-pod Gitea instance.