DOCS: lstk migration guide - #873
Conversation
Deploying localstack-docs with
|
| Latest commit: |
a91b3b5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://dd35e741.localstack-docs.pages.dev |
| Branch Preview URL: | https://docs-97-migration-guide-lstk.localstack-docs.pages.dev |
|
@remotesynth I've added it to the current subsection of |
remotesynth
left a comment
There was a problem hiding this comment.
Made a few suggestions
Co-authored-by: Brian Rinaldi <brianrinaldi@fastmail.com>
|
allrighty @peter-smith-phd brian already left his review, so I incorporated his suggestions into your PR already right now, it looks like there's just one last feedback comment for you :) |
|
Given that I wrote this, I won't provide any addition review feedback. But, I did notice that it's not showing up in the preview pages. How would the users find this page? 
|
Replace the separate Homebrew/npm code blocks with a Tabs component, matching the pattern used elsewhere in the lstk docs, per review feedback.
|
Pushed Now checking Peter's concern about the page not showing in nav.... |
It's not showing up because you didn't update the astro config js @peter-smith-phd |
|
Ummm… just a reminder that I wrote the page in Notion, and somebody else converted it to the localstack-docs format 😛 |
Register the new lstk migration guide in the Developer Tools > Running LocalStack section, between the lstk CLI and MCP Server entries.
|
You asked why it wasn't showing up, I understood your question to be about not understanding how it works ;) @peter-smith-phd |
|
@remotesynth do you want to add anything? otherwise, can you approve the PR to remove merging blocker? This looks good to merge tmw if agreed. |
|
Heads up, pinging you here too @mmaureenliu in case you'd like to review now that you're back tmw. |
|
I definitely understand how it works, but I recommend you say "It's not showing up because the astro config js wasn't updated correctly" or "thanks for pointing that out, I'll fix it", rather than indicating that it was me that missed it in the first place. Just a different language choice. |
mmaureenliu
left a comment
There was a problem hiding this comment.
A really well-written doc. Thanks @peter-smith-phd and all who contributed!
I made some very minor comments.
I also asked Jacque to take a look at the preview in case she has any feedbacks.
|
|
||
| Both CLIs need a LocalStack license to run the emulator, but they ask for it in different ways. With the `localstack` CLI you copied an auth token out of the web application and stored it with `localstack auth set-token`, or exported `LOCALSTACK_AUTH_TOKEN` yourself. | ||
|
|
||
| `lstk` replaces that with a browser-based login. Run `lstk login` and approve the request in the browser window that opens. The credential is then stored securely on your machine. There is no token to copy, and none to keep in your shell profile. |
There was a problem hiding this comment.
I'd mention simply running lstk or lstk start will take care of the auth flow, then say run lstk login if the user specifically wants to authenticate or they want to switch account.
|
|
||
| The existing `CONFIG_PROFILE` mechanism in the `localstack` CLI and its `~/.localstack/*.env` files have no direct equivalent with `lstk`. The recommended replacement is a per-project `.lstk/config.toml`. If you need to switch between several configurations for the same project, keep them as separate files and choose between them with `lstk --config <path>`. | ||
|
|
||
| ## Unsupported features |
There was a problem hiding this comment.
I'd link the feature name in the table to the feature docs page so it's easier to find, and also since we mention here "you should follow the linked documentation for more detail"
| | Shell access to the container (`localstack ssh`) | Use `docker exec -it localstack-aws bash`. Note that `lstk` names its container `localstack-[aws,azure,snowflake]`. | | ||
| | GitHub Action | There is no GitHub Action for `lstk` yet, and the existing setup-localstack Action installs the `localstack` CLI. Install `lstk` in a step of your own instead, as shown in [Using lstk with Continuous Integration](#using-lstk-with-continuous-integration). | | ||
|
|
||
| ## Next steps |
There was a problem hiding this comment.
Similarly, it'll be helpful to link the relevant docs for easier navigation.
Peter authored this migration guide for lstk, it's ready for review.
Closes: https://linear.app/localstack/issue/DOC-97/docs-migration-guide-for-legacy-cli-new-lstk