From 021d5d886d5946b2789d784e3888e7266b9baaf2 Mon Sep 17 00:00:00 2001
From: Simon Walker <s.r.walker101@googlemail.com>
Date: Wed, 18 Dec 2024 16:36:58 +0000
Subject: [PATCH] Add section on helm customzation

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 08a5b3e..7a38919 100644
--- a/README.md
+++ b/README.md
@@ -71,7 +71,7 @@ The following command allows you to download and install all the charts from thi
 $ helm repo add localstack https://localstack.github.io/helm-charts
 ```
 
-### Using Helm
+## Using Helm
 
 Once you have installed the Helm client, you can deploy a Helm chart into a Kubernetes cluster.
 
@@ -82,6 +82,24 @@ Useful Helm Client Commands:
 * Install a chart: `helm install <name> localstack/<chart>`
 * Upgrade your application: `helm upgrade`
 
+### Customization
+
+The helm chart can be customized with [Helm override files](https://helm.sh/docs/helm/helm_upgrade/) (the `-f/--values`) flag.
+A yaml file can be provided to override the default settings in the [default values.yml](https://github.com/localstack/helm-charts/blob/main/charts/localstack/values.yaml).
+
+A common customisation is to specify the LocalStack pod resource requests and limits. In particular, AWS EKS on Fargate commonly terminates LocalStack pods with the default resource requests. Consider adding the following section to your customization file:
+
+```yaml
+resources:
+  requests:
+    cpu: 1
+    memory: 1Gi
+  limits:
+    cpu: 2
+    memory: 2Gi
+```
+
+
 ### Using the chart in OpenShift
 
 Running LocalStack on OpenShift requires specific Security Context Constraints (SCC) to be applied to ensure proper deployment and operation.