DOC-428: Update remainder of Snowflake docs to push lstk by quetzalliwrites · Pull Request #908 · localstack/localstack-docs

quetzalliwrites · 2026-09-01T19:38:09Z

Summary

Follows the same lstk migration already done for AWS/Azure docs, and for Snowflake Getting Started in #878. This covers everything else under /snowflake/ that still referenced the legacy localstack CLI (scoped by grepping the whole tree for localstack start/--stack snowflake/`localstack` CLI and excluding getting-started/, which #878 already owns):

capabilities/configuration.md: rewrote the env var intro and the "CLI" section to match aws/customization/configuration-options.md's already-established pattern (LOCALSTACK_-prefixed env vars, .lstk/config.toml env profiles, cross-link to the lstk config reference). Dropped the "Profiles" section entirely — CONFIG_PROFILE/*.env files have no lstk equivalent, which is exactly why the AWS docs already dropped this section rather than translating it. Folded LOCALSTACK_VOLUME_DIR into the Docker table, again matching AWS.
capabilities/init-hooks.mdx: replaced the "CLI" tab with the lstk .lstk/config.toml volumes pattern, matching aws/customization/advanced/initialization-hooks.mdx.
capabilities/state-management.mdx: PERSISTENCE=1 localstack start → lstk start --persist; localstack state export/import → lstk snapshot save/load, matching the AWS persistence and snapshots docs.
tooling/user-interface.md and the three tutorials: swapped the `localstack` CLI prerequisite links and localstack start --stack snowflake invocations for lstk/lstk start --type snowflake, and prefixed forwarded env vars with LOCALSTACK_ where needed (required for lstk start to forward them into the container).

awslocal wrapper usage in the tutorials was left untouched — that's a separate, still-supported wrapper script, not the legacy localstack CLI this ticket targets.

Linear ticket

https://linear.app/localstack/issue/DOC-428/docs-update-remainder-of-snow-docs-for-pushing-lstk

Test plan

npx astro build completes successfully (405 pages built)
Link validator confirms all internal links are valid
Swept the full /snowflake/ tree afterward for any remaining localstack start/--stack snowflake/legacy CLI references outside getting-started/ — none found

Follows the same lstk migration already done for AWS/Azure docs and for Snowflake Getting Started (#878). Covers everything else under /snowflake/ that still referenced the legacy `localstack` CLI: - capabilities/configuration.md: rewrite the env var intro and the "CLI" section to match AWS's configuration-options.md pattern (LOCALSTACK_-prefixed env vars, .lstk/config.toml env profiles, cross-link to the lstk config reference). Drop the "Profiles" section entirely (CONFIG_PROFILE/*.env files have no lstk equivalent, same as the AWS docs already did) and fold LOCALSTACK_VOLUME_DIR into the Docker table. - capabilities/init-hooks.mdx: replace the CLI tab with the lstk .lstk/config.toml `volumes` pattern, matching aws/customization/advanced/initialization-hooks.mdx. - capabilities/state-management.mdx: `PERSISTENCE=1 localstack start` -> `lstk start --persist`; `localstack state export/import` -> `lstk snapshot save/load`, matching the AWS persistence and snapshots docs. - tooling/user-interface.md and the three tutorials: swap the `localstack` CLI prerequisite links and `localstack start --stack snowflake` invocations for `lstk`/`lstk start --type snowflake`, and prefix forwarded env vars with LOCALSTACK_ where needed.

cloudflare-workers-and-pages · 2026-09-01T19:39:27Z

Deploying localstack-docs with Cloudflare Pages

Latest commit:	`8ccb645`
Status:	✅ Deploy successful!
Preview URL:	https://570f8893.localstack-docs.pages.dev
Branch Preview URL:	https://doc-428-docs-update-remainde.localstack-docs.pages.dev

View logs

mmaureenliu

Lgtm. Some minor comments to address but I'll pre-approve.

mmaureenliu · 2026-09-01T20:29:59Z

-When you use the `localstack` CLI, add the `LOCALSTACK_` prefix so the CLI passes the variable to the container:
+When you use `lstk`, add the `LOCALSTACK_` prefix so the CLI passes the variable to the container:

 ```bash


I'd recommend using the lstk config file to do this: see my reply in https://linear.app/localstack/issue/PRO-327/verify-lstk-behavior-in-capabilitiesconfigurationmd

mmaureenliu · 2026-09-01T20:30:22Z

 CUSTOM_SSL_CERT_PATH=/var/lib/localstack/custom/cert.pem \
 SKIP_SSL_CERT_DOWNLOAD=1 \
-localstack start --stack snowflake
+lstk start


Similarly, use the config I provided in https://linear.app/localstack/issue/PRO-327/verify-lstk-behavior-in-capabilitiesconfigurationmd

mmaureenliu · 2026-09-01T20:34:34Z

+env     = ["debug"]
+volumes = ["/path/to/test.sf.sql:/etc/localstack/init/ready.d/test.sf.sql"]
+
+[env.debug]


I'd add an inline comment here saying: "Optionally enable DEBUG" as DEBUG is not required for init hook but helps to diagnose init hook issues

mmaureenliu · 2026-09-01T20:37:26Z

-PERSISTENCE=1 \
-localstack start --stack snowflake
+lstk start --persist
 ```


It's worth adding a note that to resume a persisted session after the emulator stopped, or to restart a session while keeping persistence on, you also need this flag, i.e.

lstk stop lstk start --persist

and

lstk restart --persist

mmaureenliu · 2026-09-01T20:38:35Z


 ```bash
-localstack state export '<file-name>'
+lstk snapshot save '<file-name>'


Since file-name here mostly associates with a path, I'd suggest lstk snapshot save <path-to-snapshot-file>

mmaureenliu · 2026-09-01T20:42:59Z

 ```

-You can use the `<file-name>` argument to specify a file path to export the state to. If you do not specify a file path, the state will be exported to the current working directory into a file named `ls-state-export`.
+You can use the `<file-name>` argument to specify a file path to export the state to. If you do not specify a file path, the state will be exported to the current working directory into an auto-named snapshot file.


It's helpful to link to the snapshot section of the lstk doc for more info on supported save destinations (local and remote).

mmaureenliu · 2026-09-01T20:43:47Z


 ```bash
-localstack state import '<file-name>'
+lstk snapshot load '<file-name>'


If you agree with using above then this also changes to lstk snapshot load <path-to-snapshot-file>

mmaureenliu · 2026-09-01T20:46:03Z

 ```bash
 export LOCALSTACK_AUTH_TOKEN=<your_auth_token>
-localstack start --stack snowflake
+lstk start --type snowflake


Simply lstk start

mmaureenliu · 2026-09-01T20:46:23Z

 ```bash
 export LOCALSTACK_AUTH_TOKEN=<your_auth_token>
-localstack start --stack snowflake
+lstk start --type snowflake


Simply lstk start

mmaureenliu · 2026-09-02T12:09:23Z

Actually found a (slightly) bigger problem on Peter's reminder: awslocal is still used in snowpipe.md, glue-catalog.md, storage-integrations.md, stages.mdx, dynamic-tables.md, iceberg-tables.md, polaris-catalog.md, airflow.md, aws-lambda-localstack-snowpark.md, s3-tables-iceberg-integration.md

All should be updated to lstk aws but this could be a simple search & replace fix.

quetzalliwrites requested review from HarshCasper and remotesynth as code owners September 1, 2026 19:38

quetzalliwrites requested a review from mmaureenliu September 1, 2026 19:43

quetzalliwrites self-assigned this Sep 1, 2026

mmaureenliu approved these changes Sep 1, 2026

View reviewed changes

Navigation Menu

Uh oh!

DOC-428: Update remainder of Snowflake docs to push lstk - #908

DOC-428: Update remainder of Snowflake docs to push lstk#908
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-428-docs-update-remainder-of-snow-docs-for-pushing-lstk

quetzalliwrites commented Sep 1, 2026

Uh oh!

cloudflare-workers-and-pages Bot commented Sep 1, 2026

Uh oh!

mmaureenliu left a comment

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu Sep 1, 2026

Uh oh!

mmaureenliu commented Sep 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

quetzalliwrites commented Sep 1, 2026

Summary

Linear ticket

Test plan

Uh oh!

cloudflare-workers-and-pages Bot commented Sep 1, 2026

Deploying localstack-docs with Cloudflare Pages

Uh oh!

mmaureenliu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mmaureenliu commented Sep 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants