Migrate from the localstack CLI to lstk

.github/workflows/main.yml

@@ -25,17 +25,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - uses: gautamkrishnar/keepalive-workflow@v1
-
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 18
 
       - name: Install CDK
         run: |
-          npm install -g aws-cdk-local aws-cdk
-          cdklocal --version
+          npm install -g @localstack/lstk aws-cdk
+          cdk --version
 
       - name: Setup .NET Core
         uses: actions/setup-dotnet@v3
@@ -55,16 +53,10 @@ jobs:
       - name: Start LocalStack
         env:
           LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
-          DNS_ADDRESS: 0
+          LOCALSTACK_DNS_ADDRESS: 0
         run: |
-          pip install localstack awscli-local[ver1]
           docker pull localstack/localstack:latest
-          # Start LocalStack in the background
-          LS_LOG=trace localstack start -d
-          # Wait 30 seconds for the LocalStack container to become ready before timing out
-          echo "Waiting for LocalStack startup..."
-          localstack wait -t 15
-          echo "Startup complete"
+          LOCALSTACK_LS_LOG=trace lstk start
 
       - name: Deploy infrastructure using CDK
         env:
@@ -75,8 +67,8 @@ jobs:
         run: |
           cd cdk-user-microservice/src/CdkUserMicroservice && dotnet build
           cd ../..
-          cdklocal bootstrap
-          cdklocal deploy --require-approval never
+          lstk cdk bootstrap
+          lstk cdk deploy --require-approval never
 
       - name: Send a Slack notification
         if: failure() || github.event_name != 'pull_request'

Makefile

@@ -7,26 +7,20 @@ usage:		## Show this help
 	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$//' | sed -e 's/##//'
 
 install:	## Install dependencies
-	@which localstack || pip install localstack
-	@which awslocal || pip install awscli-local
-	@which cdklocal || npm install -g aws-cdk-local aws-cdk
+	@which lstk || npm install -g @localstack/lstk aws-cdk
 
 start:		## Start LocalStack
 	@test -n "${LOCALSTACK_AUTH_TOKEN}" || (echo "LOCALSTACK_AUTH_TOKEN is not set. Find your token at https://app.localstack.cloud/workspace/auth-token"; exit 1)
-	@LOCALSTACK_AUTH_TOKEN=$(LOCALSTACK_AUTH_TOKEN) localstack start -d
+	@LOCALSTACK_AUTH_TOKEN=$(LOCALSTACK_AUTH_TOKEN) lstk start
 
 stop:		## Stop LocalStack
-	@localstack stop
-
-ready:		## Wait until LocalStack is ready
-	@echo Waiting on the LocalStack container...
-	@localstack wait -t 30 && echo LocalStack is ready to use! || (echo Gave up waiting on LocalStack, exiting. && exit 1)
+	@lstk stop
 
 logs:		## Save the logs in a separate file
-	@localstack logs > logs.txt
+	@lstk logs > logs.txt
 
 deploy:		## Deploy infrastructure using CDK
 	cd cdk-user-microservice/src/CdkUserMicroservice && dotnet build
-	cd cdk-user-microservice && cdklocal bootstrap && cdklocal deploy --require-approval never
+	cd cdk-user-microservice && lstk cdk bootstrap && lstk cdk deploy --require-approval never
 
-.PHONY: usage install start stop ready logs deploy
+.PHONY: usage install start stop logs deploy

README.md

@@ -31,9 +31,9 @@ We are using the following AWS services and their features to build our infrastr
 
 ## Prerequisites
 
-- A valid [LocalStack for AWS license](https://localstack.cloud/pricing). Your license provides a [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/) to activate LocalStack.
-- [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli).
-- [Cloud Development Kit](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) with the [`cdklocal`](https://www.npmjs.com/package/aws-cdk-local) installed.
+- A valid [LocalStack for AWS license](https://localstack.cloud/pricing). Your license provides a [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/aws/getting-started/auth-token/) to activate LocalStack.
+- [`lstk` CLI](https://docs.localstack.cloud/aws/developer-tools/running-localstack/lstk/).
+- [Cloud Development Kit](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) installed, deployed via the `lstk cdk` proxy.
 - [.NET Core 7.0](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) or later and [.NET Core Global Tools for AWS](https://aws.amazon.com/blogs/developer/net-core-global-tools-for-aws/)
 
 ## Start LocalStack
@@ -43,10 +43,9 @@ Start LocalStack with the `LOCALSTACK_AUTH_TOKEN` pre-configured:
 ```shell
 export LOCALSTACK_AUTH_TOKEN=<your-auth-token>
 make start
-make ready
 ```
 
-We specified DEBUG=1 to get the printed LocalStack logs directly in the terminal to help us visualize the background tasks in action. If you prefer running LocalStack in detached mode, you can add the `-d` flag to the `localstack start` command, and use Docker Desktop to view the logs.
+We specified DEBUG=1 to get the printed LocalStack logs directly in the terminal to help us visualize the background tasks in action. `lstk` always runs LocalStack in the background; use `lstk logs` or Docker Desktop to view the logs.
 
 ## Instructions
 
@@ -64,13 +63,13 @@ cd ../../..
 
 ### Deploying the CDK code
 
-To create the AWS infrastructure locally, you can use CDK and `cdklocal` wrapper. To deploy the infrastructure, you can run the following commands:
+To create the AWS infrastructure locally, you can use CDK and the `lstk cdk` proxy. To deploy the infrastructure, you can run the following commands:
 
 ```bash
 cd cdk-user-microservice/src/CdkUserMicroservice && dotnet build
 cd ../..
-cdklocal bootstrap
-cdklocal deploy
+lstk cdk bootstrap
+lstk cdk deploy
 ```
 
 This will deploy the `CdkUserMicroserviceStack` stack on LocalStack. You will see the following output: