Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update some sensible defaults and documentation #130

Merged
merged 2 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
alexrashed marked this conversation as resolved.
Show resolved Hide resolved

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
Loading