Skip to content

Add documentation for storage and persistence for Kubernetes #450

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.

Sign up for GitHub

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

Open
simonrw wants to merge 1 commit into
base: main
Choose a base branch
from
+39 −1
Open

Add documentation for storage and persistence for Kubernetes #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions src/content/docs/aws/enterprise/kubernetes/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ In a Kubernetes deployment:

This enables applications running in Kubernetes to interact with LocalStack using standard AWS SDK endpoint resolution without additional configuration.

## Storage

LocalStack can store data that persists across sessions, such as data that can be used for [local persistence](https://docs.localstack.cloud/aws/capabilities/state-management/persistence/) or caching downloaded resources between sessions. See the [LocalStack volume](/aws/capabilities/config/filesystem/#localstack-volume) page for more information.

This volume directory can be created in Kubernetes using a [Persistent Volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) and associated [Persistent Volume Claim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims). This volume should be mounted into the pod at `/var/lib/localstack` to persist LocalStack state. See the [Operator](/aws/enterprise/kubernetes/kubernetes-operator/) and [Helm Chart](/aws/enterprise/kubernetes/deploy-helm-chart) documentation for specific details.

## Choose execution mode

Expand Down
4 changes: 4 additions & 0 deletions src/content/docs/aws/enterprise/kubernetes/deploy-helm-chart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ persistence:
This is especially useful for workflows where you seed resources or rely on state across restarts.
:::

This performs these two changes:
* sets `PERSISTENCE=1`, and
* creates a psrsistent volume claim for the (customizable) storage class.


### Set Pod resource requests and limits

Expand Down
31 changes: 30 additions & 1 deletion src/content/docs/aws/enterprise/kubernetes/kubernetes-operator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,35 @@ curl http://1d4b6907.execute-api.localstack-localstack.my-namespace:4566/json

This works without additional DNS configuration in client applications.

## Storage

:::note
Requires Operator version 0.4.0 or later.
:::

To persist the [LocalStack volume](/aws/capabilities/config/filesystem/#localstack-volume), use the `spec.pvcName` to specify the PVC you want to mount. This automatically mounts the PVC at `/var/lib/localstack`.

For example:

```yaml
# pvc definition
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: myPvc
spec:
# ...

# LocalStack instance definition
apiVersion: api.localstack.cloud/v1alpha1
kind: LocalStack
metadata:
name: localstack
namespace: my-namespace
spec:
# ...
pvcName: myPvc
```

## Update

Expand Down Expand Up @@ -261,4 +290,4 @@ Ensure that:
* Each LocalStack instance requires its **own auth token**
* The Operator supports **LocalStack Pro images only**
* DNS integration and Cloud Pod automation are Operator-exclusive features
:::
:::