DOC-429: Split Azure lstk doc into the same v2 multi-page IA by quetzalliwrites · Pull Request #909 · localstack/localstack-docs

quetzalliwrites · 2026-09-01T20:14:34Z

Summary

Follows up on #898 (the AWS lstk docs split). azure/developer-tools/lstk.mdx turned out to be a 1556-line near-duplicate of the pre-split AWS content — same commands, config reference, and troubleshooting, since lstk is one CLI shared across products. This replaces it with the same nine-page structure, cross-linked under /azure/developer-tools/lstk/:

index.mdx, authentication.md, configuration.mdx, lifecycle-commands.md, cloud-and-iac-commands.md, snapshots.md, automation.mdx, setup-and-maintenance.md, faq-and-troubleshooting.md

Azure-specific differences preserved from the original doc (not just a mechanical copy of the AWS content):

Prerequisites link to the license section of Azure's own Auth Token guide.
Dropped the "legacy LocalStack CLI is deprecated" tip — Azure never had a legacy CLI to migrate from.
The Volume mounts example uses a generic init script and type = "azure" instead of AWS's Snowflake-specific example.
The Docker Compose FAQ answer links to Azure's own installation guide.
Left the corporate-proxy FAQ and Get Help links pointing at the shared AWS pages, since Azure has no equivalent of either and the original doc already did the same.

Also converted Azure's sidebar "Developer Tools" entry from autogenerate to an explicit array (mirroring AWS's approach) so the nine pages get the same nested "lstk CLI" group, labels, and order rather than relying on autogenerate's folder-naming heuristics.

Linear ticket

https://linear.app/localstack/issue/DOC-429/docs-update-azure-lstk-doc-based-on-new-lstk-v2-ia

Test plan

npx astro build completes successfully (421 pages built)
Link validator confirms all internal links are valid
Scripted verification that all 22 lstk/<page>/#anchor cross-references between the nine new Azure pages resolve to a real heading ID in the built output
Confirmed no other file in the repo linked to the old /azure/developer-tools/lstk/ single-page anchors, so no redirect or cross-reference sweep is needed

Mirrors the AWS lstk split (#898). The old azure/developer-tools/ lstk.mdx was a 1556-line near-duplicate of the pre-split AWS content (same commands, config, and reference material, since lstk is one CLI shared across products). Replaces it with the same nine pages, cross-linked under /azure/developer-tools/lstk/ instead of /aws/developer-tools/running-localstack/lstk/: - index.mdx, authentication.md, configuration.mdx, lifecycle-commands.md, cloud-and-iac-commands.md, snapshots.md, automation.mdx, setup-and-maintenance.md, faq-and-troubleshooting.md Azure-specific adjustments kept from the original doc rather than copied verbatim from AWS: - Prerequisites link to the license section of Azure's own Auth Token guide instead of AWS's. - Dropped the "legacy LocalStack CLI is deprecated" tip, since Azure never had a legacy CLI to migrate from. - The Volume mounts example uses a generic init script and type = "azure" instead of the AWS version's Snowflake-specific example. - The Docker Compose FAQ answer links to Azure's own installation guide instead of AWS's. - Left the corporate-proxy FAQ and Get Help links pointing at the shared AWS pages, since Azure has no equivalent of either and the original doc already did the same. Converted the sidebar's Developer Tools entry for Azure from autogenerate to an explicit array (mirroring AWS's structure) so the nine pages get the same nested "lstk CLI" group, labels, and order instead of relying on autogenerate's folder-naming heuristics.

cloudflare-workers-and-pages · 2026-09-01T20:15:43Z

Deploying localstack-docs with Cloudflare Pages

Latest commit:	`fe81fa9`
Status:	✅ Deploy successful!
Preview URL:	https://9269bb7c.localstack-docs.pages.dev
Branch Preview URL:	https://doc-429-docs-update-azure-ls.localstack-docs.pages.dev

View logs

quetzalliwrites · 2026-09-01T20:16:26Z

Preview URL: https://5661a577.localstack-docs.pages.dev/azure/developer-tools/lstk/

quetzalliwrites · 2026-09-01T20:19:13Z

Hey @remotesynth, Maureen approved the new v2 IA for lstk doc, it's already merged in aws product line docs:

Now that we've merged that v2 IA for the aws product line, we should make this update for the azure product line docs too.

Mirrors the same fix agreed on the AWS docs sync PR (#912): Global options apply to everyday interactive use, not just automation/CI, so move the table from automation.mdx to index.mdx, right after Quick start, keeping the detailed sections (Structured output) on automation.mdx with an absolute-path cross-reference.

…new-lstk-v2-ia # Conflicts: # src/content/docs/azure/developer-tools/lstk.mdx

mmaureenliu

Thanks for the great work again. Mainly two areas to fix:

persistence is not supported in azure yet so need to adjust all references to persistence or snapshots
make examples azure relevant (can more or less copy what's been done for snowflake, with minor exceptions)

mmaureenliu · 2026-09-14T17:53:11Z

+It can also save and load emulator state (as local snapshots or Cloud Pods) reset running state, run AWS CLI commands against the emulator, and manage the on-disk volume.
+Running `lstk` with no arguments takes you through the entire startup flow automatically.
+
+`lstk` also proxies developer tools so they run directly against LocalStack: the AWS CLI (`lstk aws`), the Azure CLI (`lstk az`), Terraform (`lstk terraform`), the AWS CDK (`lstk cdk`), and the AWS SAM CLI (`lstk sam`).


I'd re-order the tools mentioned as: Azure CLI, Terraform, AWS CLI, etc.

mmaureenliu · 2026-09-14T17:53:48Z

+It provides a built-in terminal UI (TUI) for interactive use and plain text output for CI/CD pipelines and scripting.
+
+`lstk` handles the full emulator lifecycle: authentication, pulling the Docker image, starting, stopping, and restarting the container, streaming logs, and checking status.
+It can also save and load emulator state (as local snapshots or Cloud Pods) reset running state, run AWS CLI commands against the emulator, and manage the on-disk volume.


more relevant here: "runs Azure CLI commands..."

mmaureenliu · 2026-09-14T17:54:41Z

Snapshots are currently not supported at all for Azure - maybe hide until we support it?

Note if we remove this, need to also remove the ref on index page.

mmaureenliu · 2026-09-14T17:56:29Z

+- [Authentication](/azure/developer-tools/lstk/authentication/): logging in and out, and how `lstk` resolves your auth token.
+- [Configuration](/azure/developer-tools/lstk/configuration/): the `config.toml` file, emulator types, environment variables, and volumes.
+- [Lifecycle commands](/azure/developer-tools/lstk/lifecycle-commands/): `start`, `stop`, `restart`, `status`, `logs`, `reset`, `volume`.
+- [Cloud & IaC commands](/azure/developer-tools/lstk/cloud-and-iac-commands/): `aws`, `az`, `terraform`, `cdk`, `sam`.


Again reorder to put az and terraform first

mmaureenliu · 2026-09-14T17:58:28Z

+
+```toml
+[[containers]]
+type = "aws"      # Emulator type. Supported: "aws", "snowflake", "azure"


Similar to the snowflake changes, use azure profile here (and other related changes, e.g. type in the table below).

mmaureenliu · 2026-09-14T18:15:37Z

+All require a valid auth token (including the free Hobby tier).
+See [Emulator types](/azure/developer-tools/lstk/configuration/#emulator-types).
+
+### How do I pass configuration options like `DEBUG` or `PERSISTENCE` to the container?


don't mention PERSISTENCE here

mmaureenliu · 2026-09-14T18:16:00Z

+Define the variables under an `[env.<name>]` section and reference that name in the `env` list of your container config.
+See [Passing environment variables to the container](/azure/developer-tools/lstk/configuration/#passing-environment-variables-to-the-container) for details.
+
+### How do I save and restore emulator state?


keep this question but answer needs to change: we don't support it yet but the feature is coming soon

mmaureenliu · 2026-09-14T18:16:12Z

+type = "aws"
+tag  = "2026.4"
+port = "4566"
+```


change to azure

mmaureenliu · 2026-09-14T18:16:45Z

+[[containers]]
+type = "aws"
+env  = ["myprofile"]   # must match the section name below
+


mmaureenliu · 2026-09-14T18:19:02Z

+
+### Getting help
+
+If the steps above don't resolve your issue, see [Get Help](/aws/help-support/get-help/) for the available support channels, including the support email and in-app chat.


this currently points to the aws get help doc as we don't have one for azure yet. the aws doc talks about different support levels for different plans, which may confuse azure users. I suggest for now we just supply the support email address and ask them to email support.

quetzalliwrites requested review from HarshCasper and remotesynth as code owners September 1, 2026 20:14

quetzalliwrites self-assigned this Sep 1, 2026

quetzalliwrites mentioned this pull request Sep 1, 2026

DOC-430: Create Snowflake lstk doc + rename Tooling to Developer Tools #910

Open

5 tasks

gtsiolis mentioned this pull request Sep 2, 2026

docs(lstk hotfix): update CLI reference to v1.0.0 #912

Merged

quetzalliwrites added 2 commits September 7, 2026 19:31

Merge branch 'main' into doc-429-docs-update-azure-lstk-doc-based-on-…

fe81fa9

…new-lstk-v2-ia # Conflicts: # src/content/docs/azure/developer-tools/lstk.mdx

quetzalliwrites requested a review from mmaureenliu September 9, 2026 20:12

mmaureenliu requested changes Sep 14, 2026

View reviewed changes


		### Getting help

		If the steps above don't resolve your issue, see [Get Help](/aws/help-support/get-help/) for the available support channels, including the support email and in-app chat.

Uh oh!

Conversation

quetzalliwrites commented Sep 1, 2026

Summary

Linear ticket

Test plan

Uh oh!

cloudflare-workers-and-pages Bot commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying localstack-docs with Cloudflare Pages

Uh oh!

quetzalliwrites commented Sep 1, 2026

Uh oh!

quetzalliwrites commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

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

edited

Loading

quetzalliwrites commented Sep 1, 2026 •

edited

Loading