Revamp Snapshots section: major restructuring (largely by hand), and support for lstk
#800
+757
−1,392
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -520,7 +520,7 @@ jobs: | |
| - localstack-load-state | ||
| ``` | ||
|
|
||
| More information about Localstack's [state import/export](/aws/developer-tools/snapshots/saving-snapshots-locally). | ||
|
|
||
| #### Cache | ||
|
|
||
|
|
@@ -586,4 +586,4 @@ workflows: | |
| ... | ||
| ``` | ||
|
|
||
| More information about [state management](/aws/developer-tools/snapshots/saving-snapshots-locally). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -241,7 +241,7 @@ Find out more about [ephemeral instances](/aws/developer-tools/cloud-sandbox/eph | |
|
|
||
| #### Artifact | ||
|
|
||
| Find out more about [state management](/aws/developer-tools/snapshots/saving-snapshots-locally/). | ||
|
|
||
| ```yml showshowLineNumbers | ||
| ... | ||
|
|
@@ -274,7 +274,7 @@ To use previously stored artifacts as inputs, set them as a source in the projec | |
|
|
||
| #### Cache | ||
|
|
||
| Additional information about [state export and import](/aws/developer-tools/snapshots/saving-snapshots-locally/). | ||
|
|
||
| ##### Native Runner | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -171,7 +171,7 @@ Find out more about ephemeral instances [here](/aws/developer-tools/cloud-sandbo | |||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| More information about state import and export [here](/aws/developer-tools/snapshots/saving-snapshots-locally). | ||||||
|
There was a problem hiding this comment.
Suggested change
Given the example above this is using the Cloud Pod backend, should we link to the cloud pods page instead? |
||||||
|
|
||||||
| ## Current Limitations | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -136,7 +136,7 @@ job: | |
| ... | ||
| ``` | ||
|
|
||
| More info about Localstack's state export and import [here](/aws/developer-tools/snapshots/saving-snapshots-locally/). | ||
|
|
||
| #### Cache | ||
|
|
||
|
|
@@ -159,7 +159,7 @@ job: | |
| ... | ||
| ``` | ||
|
|
||
| Additional information about state export and import [here](/aws/developer-tools/snapshots/saving-snapshots-locally/). | ||
|
|
||
| #### Cloud Pod | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -117,7 +117,7 @@ A common use case for init hooks is pre-seeding LocalStack with custom state. | |
| For example if you want to have a certain S3 bucket or DynamoDB table created when starting LocalStack, init hooks can be very useful. | ||
|
|
||
| :::tip | ||
| If you have more complex states, [Cloud Pods](/aws/developer-tools/snapshots/cloud-pods) and [how to auto-load them on startup](/aws/developer-tools/snapshots/cloud-pods#auto-loading-from-cloud-pods) may be a good option to look into! | ||
| ::: | ||
|
|
||
| To execute aws cli commands when LocalStack becomes ready, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -403,7 +403,7 @@ To learn more about these configuration options, see [Persistence](/aws/develope | |
| | `SNAPSHOT_SAVE_STRATEGY` | `ON_SHUTDOWN`\|`ON_REQUEST`\|`SCHEDULED`\|`MANUAL` | Strategy that governs when LocalStack should make state snapshots | | ||
| | `SNAPSHOT_LOAD_STRATEGY` | `ON_STARTUP`\|`ON_REQUEST`\|`MANUAL` | Strategy that governs when LocalStack restores state snapshots | | ||
| | `SNAPSHOT_FLUSH_INTERVAL` | 15 (default) | The interval (in seconds) between persistence snapshots. It only applies to a `SCHEDULED` save strategy (see [Persistence Mechanism](/aws/developer-tools/snapshots/persistence))| | ||
| | `DISABLE_COMPATIBILITY_RULES` | `0` (default) \| `1` | Disable the [snapshot compatibility rules](/aws/developer-tools/snapshots/service-coverage#snapshot-compatibility) that prevent loading incompatible state into LocalStack. Applies to both snapshot persistence and Cloud Pods. | | ||
|
|
||
| ## Cloud Pods | ||
|
|
||
|
|
@@ -415,7 +415,7 @@ To learn more about these configuration options, see [Cloud Pods](/aws/developer | |
| | `POD_LOAD_CLI_TIMEOUT` | 60 (default) | Timeout in seconds to wait before returning from load operations on the Cloud Pods CLI | | ||
| | `POD_ENCRYPTION` | `0` (default) \| `1` | Whether to encrypt the Cloud Pods artifacts at rest. | | ||
| | `ENABLE_POD_RESOURCES=1` | `0` (default) \| `1` | Whether to save a detailed Stack Overview including available resources for the Cloud Pod | | ||
| | `MERGE_STRATEGY` | `account-region-merge` (default) \| `service-merge` \| `overwrite` | The merge strategy to apply when loading a Cloud Pod into LocalStack (see [merging snapshots](/aws/developer-tools/snapshots/merging-snapshots/)) | | ||
|
|
||
| ## Extensions | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,7 +53,7 @@ The main integrations are: | |
|
|
||
| - **License activation**: The standard image performs online activation using your `LOCALSTACK_AUTH_TOKEN`. See [Auth Token](/aws/getting-started/auth-token) for activation behavior and fallbacks. | ||
| - **Event reporting (telemetry)**: Used for Stack Insights and related usage analytics. You can disable this via `DISABLE_EVENTS=1`. | ||
| - **Cloud Pods (platform remote)**: Saving/loading pods against the default platform remote uses LocalStack-managed infrastructure. For stricter data residency, consider other [remote storage options](/aws/developer-tools/snapshots/saving-snapshots-to-s3). | ||
|
There was a problem hiding this comment.
This probably goes beyond the the scope of this PR, but I wonder if it's worth mentioning somewhere in our docs the region in which the LocalStack platform (Console + hosted resources like CloudPods and Ephem Instances) is hosted (e.g. eu-central-1?). From my experience, enterprises like to know this and it can help them think about which Snapshot backend is right for them. Perhaps we could add a note on this page: https://docs.localstack.cloud/aws/connecting/console/ and then link to it from here, Cloud Pods page, and Ephemeral Instances page. |
||
| - **Ephemeral instances**: These are managed cloud instances and therefore require connectivity to LocalStack Cloud services. | ||
|
|
||
| ### Recommended setup for offline environments | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.