Skip to content

Commit

Permalink
add docs on new features in cloud pod save/load on web ui (#1567)
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshCasper authored Nov 21, 2024
1 parent 082676d commit ebfc21a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions content/en/user-guide/state-management/cloud-pods/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,9 @@ To export the state, follow these steps:
1. Navigate to the **Cloud Pod** tab within the [Export/Import State](https://app.localstack.cloud/inst/default/state) page.
2. Create AWS resources locally as needed.
3. Enter the Pod name and toggle between the **New Pod** and **Existing Pod** options.
4. Click on **Create New Pod**.
4. Enter the services to save resources for.
By default, all available service resources are saved.
5. Click on **Create New Pod**.

A new Cloud Pod will be created and will be available for import into another LocalStack instance.
You can check out the list of available Cloud Pods in the [Cloud Pod](https://app.localstack.cloud/pods) page.
Expand Down Expand Up @@ -518,7 +520,6 @@ Once added, a remote persists even after LocalStack restarts.
## State Merging

Cloud Pods offers various strategies for integrating states into your LocalStack container.
To activate the merge strategies, you can set `--strategy <strategy>` while loading the Cloud Pod.
The available strategies are:

- `overwrite`: This strategy clears the existing state and loads the new state from the Cloud Pod, completely resetting the LocalStack state.
Expand All @@ -527,6 +528,22 @@ The available strategies are:
- `service-merge`: This strategy merges services at the account-region level, provided there's no overlap in resources.
It prioritizes the loaded resources when merging.

### LocalStack CLI

To activate merge strategies, set `--strategy <strategy>` when loading a Cloud Pod using the LocalStack CLI.
For instance, to load a Cloud Pod named `test-pod-s3-sqs` with the `service-merge` strategy, run the following command:

{{< command >}}
$ localstack pod load test-pod-s3-sqs --strategy service-merge
{{< / command >}}

### LocalStack Web Application

To activate merge strategies, navigate to the **Cloud Pods** tab on the [Export/Import State page](https://app.localstack.cloud/inst/default/state).
Enter the name of the Cloud Pod, select the version, choose the strategy from a dropdown, and click **Load State from Pod**.

<img src="merge-strategy-web-app.png" alt="Merge Strategy Web UI" title="Merge Strategy Web UI" width="800px" />

### Example scenario

Let us take the image below as example.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ebfc21a

Please sign in to comment.