Skip to content

Commit

Permalink
Update some sensible defaults and documentation (#130)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonrw authored Dec 20, 2024
1 parent 3706f5f commit 5de2597
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions charts/localstack/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5de2597

Please sign in to comment.