Skip to content

Commit 78ca32f

Browse files
Final clean-up before code review.
1 parent 320d3f9 commit 78ca32f

6 files changed

Lines changed: 18 additions & 16 deletions

File tree

src/content/docs/aws/customization/configuration-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ To learn more about these configuration options, see [Persistence](/aws/develope
403403
| `SNAPSHOT_SAVE_STRATEGY` | `ON_SHUTDOWN`\|`ON_REQUEST`\|`SCHEDULED`\|`MANUAL` | Strategy that governs when LocalStack should make state snapshots |
404404
| `SNAPSHOT_LOAD_STRATEGY` | `ON_STARTUP`\|`ON_REQUEST`\|`MANUAL` | Strategy that governs when LocalStack restores state snapshots |
405405
| `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))|
406-
| `DISABLE_COMPATIBILITY_RULES` | `0` (default) \| `1` | Disable the [snapshot compatibility rules](/aws/developer-tools/snapshots/service-coverage#state-compatibility) that prevent loading incompatible state into LocalStack. Applies to both snapshot persistence and Cloud Pods. |
406+
| `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. |
407407

408408
## Cloud Pods
409409

src/content/docs/aws/developer-tools/snapshots/cloud-pods.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
order: 3
88
---
99

10-
import { Tabs, TabItem, FileTree } from '@astrojs/starlight/components';
10+
import { Tabs, TabItem } from '@astrojs/starlight/components';
1111

1212
In [the previous section](/aws/developer-tools/snapshots/saving-snapshots-locally/) you learned how to save a snapshot of the emulator's state to a local file,
1313
then reload the snapshot into a different emulator instance. When working in a team environment, it's important to have a standard mechanism for sharing

src/content/docs/aws/developer-tools/snapshots/index.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,7 @@ For more detail, see the following sections:
3131
<SectionCards
3232
sections={[
3333
{
34-
title: "Persistence",
35-
description: "Enabling automatic persistence of data, providing enhanced durability.",
36-
href: "/aws/developer-tools/snapshots/persistence"
37-
},
38-
{
39-
title: "Saving Locally",
34+
title: "Saving snapshots locally",
4035
description: "Saving and loading snapshots from local files.",
4136
href: "/aws/developer-tools/snapshots/saving-snapshots-locally"
4237
},
@@ -46,7 +41,7 @@ For more detail, see the following sections:
4641
href: "/aws/developer-tools/snapshots/cloud-pods"
4742
},
4843
{
49-
title: "Saving to other storage",
44+
title: "Saving snapshots to S3",
5045
description: "Save snapshots directly to your Amazon S3 bucket.",
5146
href: "/aws/developer-tools/snapshots/saving-snapshots-to-s3"
5247
},
@@ -56,7 +51,12 @@ For more detail, see the following sections:
5651
href: "/aws/developer-tools/snapshots/merging-snapshots"
5752
},
5853
{
59-
title: "Service Coverage",
54+
title: "Persistence",
55+
description: "Enabling automatic persistence of data, providing enhanced durability.",
56+
href: "/aws/developer-tools/snapshots/persistence"
57+
},
58+
{
59+
title: "Service coverage",
6060
description: "Snapshot compatibility rules and service coverage for LocalStack's snapshot mechanism.",
6161
href: "/aws/developer-tools/snapshots/service-coverage"
6262
}

src/content/docs/aws/developer-tools/snapshots/persistence.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
tags: ["Base"]
88
---
99

10-
import { Tabs, TabItem, FileTree } from '@astrojs/starlight/components';
10+
import { Tabs, TabItem } from '@astrojs/starlight/components';
1111

1212
LocalStack's _Persistence_ mechanism uses snapshots to provide an enhanced level of durability, bringing it closer to the behavior you'd expect from a cloud-based service.
1313
By default, LocalStack's internal state is ephemeral, resetting when the emulator is shut down or exits unexpectedly. When the Persistence feature is enabled,

src/content/docs/aws/developer-tools/snapshots/saving-snapshots-to-s3.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ lstk snapshot save my-snapshot s3://ls-s3-bucket-example
3434
```bash title="Output"
3535
✔︎ Snapshot saved to s3://ls-s3-bucket-example as "my-snapshot"
3636
• Version: 1
37-
• Size: 22 B
37+
• Size: 74.6 KB
3838
```
3939

4040
:::caution
4141
Snapshots are transferred to a real Amazon S3 bucket, so [transparent endpoint injection](/aws/customization/networking/transparent-endpoint-injection) must be disabled.
4242
Otherwise LocalStack's [DNS server](/aws/customization/networking/dns-server) resolves the AWS domains back to the emulator, and the transfer never reaches your bucket.
4343

44-
Disable this feature by setting [`LOCALSTACK_DNS_ADDRESS=0`](/aws/customization/configuration-options/), either on the command line when starting `lstk`, or in your `config.toml` file.
44+
Disable this feature by setting [`DNS_ADDRESS=0`](/aws/customization/configuration-options/) when starting the emulator.
45+
On the command line, use `LOCALSTACK_DNS_ADDRESS=0 lstk start` — host variables prefixed with `LOCALSTACK_` are forwarded to the emulator.
46+
In a `config.toml` [environment profile](/aws/developer-tools/running-localstack/lstk/#passing-environment-variables-to-the-container), use the unprefixed form `DNS_ADDRESS = "0"`.
4547
:::
4648

4749
Once the snapshot has been saved, you can confirm the presence of the snapshot artifacts in the S3 bucket by running:
@@ -51,7 +53,7 @@ aws s3 ls s3://ls-s3-bucket-example
5153
```
5254

5355
```bash title="Output"
54-
2026-08-05 10:08:55 22 localstack-pod-my-snapshot-state-1.zip
56+
2026-08-05 10:08:55 76390 localstack-pod-my-snapshot-state-1.zip
5557
```
5658

5759
You can then use `lstk snapshot load` to load the previously saved snapshot:

src/content/docs/aws/developer-tools/snapshots/service-coverage.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Service Coverage
2+
title: Service coverage
33
description: Snapshot compatibility rules and service coverage of LocalStack's snapshot mechanism.
44
template: doc
55
sidebar:
66
order: 7
77
tags: ["Base"]
88
---
99

10-
import { Tabs, TabItem, FileTree } from '@astrojs/starlight/components';
10+
import { Tabs, TabItem } from '@astrojs/starlight/components';
1111
import PersistenceCoverage from '../../../../../components/persistence-coverage/PersistenceCoverage.tsx';
1212

1313
This page covers two topics: the compatibility rules LocalStack enforces when loading a snapshot, and the current level of snapshot support across AWS services.

0 commit comments

Comments
 (0)