You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Require LocalStack license and standardize sample documentation (#269)
* Require LocalStack license and standardize documentation across all samples
- Add LOCALSTACK_AUTH_TOKEN check to all `start` Makefile targets
- Remove deprecated ACTIVATE_PRO=1 from all Makefiles
- Add `check` target for prerequisite validation to all Makefiles
- Create Makefiles for 11 samples that were missing them
- Rewrite all sample READMEs to match gold standard format with key/value tables
- Add license prerequisite as first bullet in all READMEs
- Create missing READMEs for cdk-for-terraform, emr-serverless-sample, lambda-function-urls-python, lambda-hot-reloading, lambda-xray
- Update root README Configuration section and add 11 missing table entries
- Fix broken lambda-function-urls link in root README
* trigger CI
* try to run
* Fix auth token guidance and missing prerequisites across all samples
- Update all 48 Makefiles: change error URL from /pricing to
/workspace/auth-token so users land on the token page directly
- Update all 48 READMEs: expand license bullet to include explicit
export LOCALSTACK_AUTH_TOKEN=<your-auth-token> instruction with
a link to the LocalStack Web Application
- Fix apigw-custom-domain/README.md: add missing license bullet,
Docker, localstack CLI, and awslocal CLI prerequisites; remove
stale Environment row from the metadata table
* Move auth token setup into Start LocalStack section in all READMEs
- Revert Prerequisites license bullet to simple one-liner (no inline
code block or web app link)
- Add explicit 'export LOCALSTACK_AUTH_TOKEN=<your-auth-token>' as
the first command in the Start LocalStack code block across all
sample READMEs (47 make start + 1 localstack start variant)
* restore DEBUG=1, expected outputs, and missing context
Copy file name to clipboardExpand all lines: README.md
+28-5Lines changed: 28 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# LocalStack Pro Samples
2
2
3
-
This repository contains sample projects that can be deployed on your local machine using [LocalStack Pro](https://localstack.cloud/).
3
+
This repository contains sample projects that can be deployed on your local machine using [LocalStack](https://localstack.cloud/).
4
4
5
5
Each example in the repository is prefixed with the name of the AWS service being used. For example, the `elb-load-balancing` directory contains examples that demonstrate how to use the Elastic Load Balancing service with LocalStack. Please refer to the sub directories for more details and instructions on how to start the samples.
6
6
@@ -14,14 +14,27 @@ Each example in the repository is prefixed with the name of the AWS service bein
14
14
15
15
## Configuration
16
16
17
-
Some of the samples require LocalStack Pro features. Please make sure to properly configure the `LOCALSTACK_AUTH_TOKEN` environment variable. You can find your Auth Token on the [LocalStack Web Application](https://app.localstack.cloud/workspace/auth-token) and you can refer to our [Auth Token documentation](https://docs.localstack.cloud/getting-started/auth-token/) for more details.
17
+
All samples require 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. Set it before running any sample:
18
+
19
+
```bash
20
+
export LOCALSTACK_AUTH_TOKEN=<your-auth-token>
21
+
```
22
+
23
+
Alternatively, use the LocalStack CLI to persist the token:
24
+
25
+
```bash
26
+
localstack auth set-token <your-auth-token>
27
+
```
28
+
29
+
You can find your Auth Token on the [LocalStack Web Application](https://app.localstack.cloud/workspace/auth-token).
Copy file name to clipboardExpand all lines: apigw-custom-domain/Makefile
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,8 @@ test: ## Run tests
55
55
make deploy run target=ci
56
56
57
57
start: ## Start LocalStack
58
-
ACTIVATE_PRO=1 localstack start -d
58
+
@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)
- 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.
run: ## Deploy the app locally and run an AppSync GraphQL test invocation
18
27
./run.sh
19
28
start:
20
-
localstack start -d
29
+
@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)
A demo application illustrating how to proxy data from different resources (DynamoDB tables, RDS Aurora Postgres databases) via AppSync GraphQL using LocalStack. The sample runs mutation and query operations for two data sources and demonstrates real-time notifications via WebSocket subscriptions.
4
12
5
13
## Prerequisites
6
14
7
-
* LocalStack
8
-
* Docker
9
-
* Python 3.6+
10
-
*`make`
15
+
- 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.
@fgrep -h "##"$(MAKEFILE_LIST)| fgrep -v fgrep | sed -e 's/\\$$//'| sed -e 's/##//'
8
8
9
+
check: ## Check if all required prerequisites are installed
10
+
@command -v docker > /dev/null 2>&1|| { echo"Docker is not installed. Please install Docker and try again.";exit 1; }
11
+
@command -v localstack > /dev/null 2>&1|| { echo"LocalStack CLI is not installed. Please install it and try again.";exit 1; }
12
+
@command -v awslocal > /dev/null 2>&1|| { echo"awslocal is not installed. Please run: pip install awscli-local";exit 1; }
13
+
@echo "All required prerequisites are available."
14
+
15
+
9
16
install: ## Install dependencies
10
17
# @test -e node_modules || npm install
11
18
@which localstack || pip install localstack
@@ -16,7 +23,8 @@ run: ## Set up database connections and run Athena queries locally
16
23
echo"Running Athena queries";\
17
24
./run.sh
18
25
start:
19
-
localstack start -d
26
+
@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)
Copy file name to clipboardExpand all lines: athena-s3-queries/README.md
+35-23Lines changed: 35 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,43 +1,57 @@
1
-
# LocalStack Demo: Athena Queries over S3 Files
1
+
# Athena Queries over S3 Files
2
2
3
-
Simple demo application illustrating how to run Athena queries over S3 files locally, using LocalStack.
3
+
| Key | Value |
4
+
| ------------ | ------------------------------ |
5
+
| Services | Athena, S3 |
6
+
| Integrations | AWS CLI |
7
+
| Categories | Analytics; Serverless |
8
+
9
+
## Introduction
10
+
11
+
A demo application illustrating how to run Athena queries over S3 files locally using LocalStack. The sample uploads CSV test data to S3, creates Athena table metadata, and runs SQL queries to aggregate results — all without connecting to AWS.
4
12
5
13
## Prerequisites
6
14
7
-
* LocalStack
8
-
* Docker
9
-
* Node.js / `npm`
10
-
*`make`
15
+
- 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.
0 commit comments