From 5de259771ae383753c0e772a60734f4bd652f70d Mon Sep 17 00:00:00 2001
From: Simon Walker <s.r.walker101@googlemail.com>
Date: Fri, 20 Dec 2024 08:31:23 +0000
Subject: [PATCH] Update some sensible defaults and documentation (#130)

---
 README.md                     | 20 +++++++++++++++++++-
 charts/localstack/values.yaml |  8 ++++----
 2 files changed, 23 insertions(+), 5 deletions(-)

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.
diff --git a/charts/localstack/values.yaml b/charts/localstack/values.yaml
index c716854..659f922 100644
--- a/charts/localstack/values.yaml
+++ b/charts/localstack/values.yaml
@@ -106,17 +106,17 @@ extraEnvVars: []
 envFrom: []
 
 livenessProbe:
-  initialDelaySeconds: 0
+  initialDelaySeconds: 10
   periodSeconds: 10
   timeoutSeconds: 1
   successThreshold: 1
-  failureThreshold: 3
+  failureThreshold: 5
 readinessProbe:
-  initialDelaySeconds: 0
+  initialDelaySeconds: 10
   periodSeconds: 10
   timeoutSeconds: 1
   successThreshold: 1
-  failureThreshold: 3
+  failureThreshold: 5
 
 service:
   type: NodePort