Skip to content

docs(aws/customization): migrate /aws/customization section to use lstk - #862

Draft
peter-smith-phd wants to merge 5 commits into
doc-312-aws-docs-to-use-lstkfrom
devx-993-migrate-to-lstk
Draft

docs(aws/customization): migrate /aws/customization section to use lstk#862
peter-smith-phd wants to merge 5 commits into
doc-312-aws-docs-to-use-lstkfrom
devx-993-migrate-to-lstk

Conversation

@peter-smith-phd

Copy link
Copy Markdown
Contributor

Migrates the /aws/customization section to lstk, following on from #789, #792 and #800.

Configuration

  • Lead with LOCALSTACK_DEBUG=1 lstk start as the simplest way to set a config option, keeping the [env.*] profile form as the alternative.
  • Removed the Profiles section: it documented the legacy ~/.localstack/*.env + CONFIG_PROFILE mechanism, which lstk replaces with named [env.*] tables. Fixed the two in-page links that pointed at it.
  • Replaced the CLI table (CONFIG_PROFILE, CONFIG_DIR) with a pointer to the lstk config reference, and moved LOCALSTACK_VOLUME_DIR into the Docker section, where it still applies.

Networking

  • dns-server: replaced the --host-dns flag with expose_ports = [53] in config.toml. Added a caution that localstack dns systemd-resolved is only available in the deprecated CLI.
  • route53: same expose_ports change, now cross-linked to the DNS page.
  • external-port-range: dropped the legacy CLI tab from the multi-instance example, leaving docker-compose as the only form (running several instances has no lstk equivalent).
  • accessing-endpoint-url: converted the "From your container" CLI tab to lstk start. The pre-2.3.0 examples are intentionally left on the legacy CLI, since they document historical versions.

Multi-account

  • cross-account-access and multi-account-setups now use lstk aws --account <id> as the primary form, with AWS_ACCESS_KEY_ID noted as an alternative.
  • Both pages now point at LocalStack Support rather than GitHub Discussions.

Marked as legacy-only

Extensions (index, managing, developing) and DevContainers keep the legacy localstack CLI, and now say so explicitly with a link to the deprecated CLI page. lstk has no extensions command suite, and the upstream devcontainer-template repo installs the legacy CLI.

Not migrated

  • podman and rancher-desktop still use localstack start with DOCKER_CMD, which has no lstk equivalent. Neither page states this yet.
  • accessing-endpoint-url "From your container" still needs a user-defined Docker network and localstack wait; lstk supports neither.

Notes for review

Three lstk features referenced here are not yet documented on the lstk page: expose_ports, lstk aws --account, and AWS_ACCESS_KEY_ID pass-through.

🤖 Generated with Claude Code

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 38717b2
Status: ✅  Deploy successful!
Preview URL: https://f6e53230.localstack-docs.pages.dev
Branch Preview URL: https://devx-993-migrate-to-lstk.localstack-docs.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant