DOC-431: Fix remaining localstack/awslocal/tflocal mentions in AWS docs - #928
Conversation
…lstk Sweeps the AWS docs for lingering references to the legacy `localstack` CLI and the `awslocal`/`tflocal`/`cdklocal` wrapper scripts that have lstk equivalents: - getting-started/faq.mdx: `localstack start`/`localstack --version` commands. Left the `--debug` flag and `auth show-token` mentions alone, since lstk has no documented equivalent for either. - getting-started/ci-cd.mdx: rewrote the CI provider tabs to mirror the already-migrated per-provider guides under /aws/ci-pipelines/. - services/elb.mdx: GATEWAY_LISTEN startup example now uses LOCALSTACK_GATEWAY_LISTEN with lstk start. - security-testing/iam-policy-simulator.md and iam-policy-enforcement.md, developer-tools/aws-replicator/index.mdx, quickstart-library/k8s-quickstart.md, getting-started/local-development.mdx, getting-started/ai-workflows.mdx: awslocal/tflocal -> lstk aws/lstk terraform. Left tutorials/ephemeral-application-previews.mdx untouched: it documents Ephemeral Instances, which the lstk migration guide lists as not yet supported by lstk, so its awslocal/cdklocal usage is still correct. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Deploying localstack-docs with
|
| Latest commit: |
693d4dc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://287a74c8.localstack-docs.pages.dev |
| Branch Preview URL: | https://doc-431-docs-aws-fix-remaini.localstack-docs.pages.dev |
nik-localstack
left a comment
nik-localstack
left a comment
There was a problem hiding this comment.
I couldn't verify the elb change. Please take a look.
|
|
||
| ```bash | ||
| GATEWAY_LISTEN=0.0.0.0:4566,0.0.0.0:80,0.0.0.0:8080 localstack start | ||
| LOCALSTACK_GATEWAY_LISTEN=0.0.0.0:4566,0.0.0.0:80,0.0.0.0:8080 lstk start |
There was a problem hiding this comment.
For me this doesn't forward the environment variable in the LocalStack container. You probably have to use a lstk config file to achieve this.
There was a problem hiding this comment.
@anisaoshafi Our documented method of passing env var to the container is via the lstk config file. Do we want to say that's the only supported way? Is inline env var only valid for configuring lstk itself? Would you be able to suggest edits to https://docs.localstack.cloud/aws/developer-tools/running-localstack/lstk/configuration/ and/or https://docs.localstack.cloud/aws/developer-tools/running-localstack/lstk/automation/ to make that very clear?
mmaureenliu
left a comment
mmaureenliu
left a comment
There was a problem hiding this comment.
Mostly good except two points:
- I think some config in CI-CD wouldn't work but I defer to @peter-smith-phd to confirm accuracy and suggest correct fix
- As @nik-localstack pointed out,
GATEWAY_LISTENhas to be defined inlstkconfig, not as inline env var
There was a problem hiding this comment.
@peter-smith-phd can you check the CI config for accuracy please? E.g. there are cases where LocalStack is started using Docker (bitbucket case) so lstk aws needs the --endpoint-url flag?
|
|
||
| ```bash | ||
| GATEWAY_LISTEN=0.0.0.0:4566,0.0.0.0:80,0.0.0.0:8080 localstack start | ||
| LOCALSTACK_GATEWAY_LISTEN=0.0.0.0:4566,0.0.0.0:80,0.0.0.0:8080 lstk start |
There was a problem hiding this comment.
@anisaoshafi Our documented method of passing env var to the container is via the lstk config file. Do we want to say that's the only supported way? Is inline env var only valid for configuring lstk itself? Would you be able to suggest edits to https://docs.localstack.cloud/aws/developer-tools/running-localstack/lstk/configuration/ and/or https://docs.localstack.cloud/aws/developer-tools/running-localstack/lstk/automation/ to make that very clear?
3 participants
Summary
Sweeps the AWS docs for remaining mentions of the legacy
localstackCLI and theawslocal/tflocal/cdklocalwrapper scripts that havelstkequivalents:localstack start/localstack --version→lstk start/lstk --version. Left the host-side--debugflag andlocalstack auth show-tokenalone — neither has a documentedlstkequivalent./aws/ci-pipelines/.GATEWAY_LISTEN=... localstack startexample now usesLOCALSTACK_GATEWAY_LISTEN=... lstk start, matching howlstk startforwardsLOCALSTACK_-prefixed host env vars into the container.awslocal/tflocal→lstk aws/lstk terraform.Deliberately left unchanged:
tutorials/ephemeral-application-previews.mdx. The ticket flagged itsawslocal/cdklocalmentions, but the whole tutorial documents Ephemeral Instances, which the lstk migration guide explicitly lists as not yet supported bylstk(thelocalstackCLI is still required). Converting those mentions would document a workflow that doesn't actually work. cc @mmaureenliuLinear ticket
https://linear.app/localstack/issue/DOC-431/docs-aws-fix-remaining-mention-of-localstack-that-should-be-lstk-in
Test plan
npx astro buildcompletes successfully (417 pages built)awslocal/tflocal/cdklocal/barelocalstackcommand references in the files the ticket calls out, aside from the deliberate exception noted above