From 32e3b89ad119e18b39f471fbe20966580d87bfd9 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Mon, 16 Jun 2025 11:17:13 +0530 Subject: [PATCH 1/2] document --stack option for CLI --- content/en/getting-started/installation/index.md | 4 ++-- content/en/references/configuration/index.md | 2 +- .../aws-lambda-localstack-snowpark/index.md | 3 +-- .../credit-scoring-with-localstack-snowpark/index.md | 2 +- content/en/user-guide/init-hooks/index.md | 2 +- .../integrations/continuous-integration/index.md | 12 ++++++------ content/en/user-guide/state-management/index.md | 2 +- content/en/user-guide/user-interface/index.md | 3 ++- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/content/en/getting-started/installation/index.md b/content/en/getting-started/installation/index.md index 56b0585..5365787 100644 --- a/content/en/getting-started/installation/index.md +++ b/content/en/getting-started/installation/index.md @@ -33,7 +33,7 @@ To start the Snowflake Docker container using the `localstack` CLI, execute the {{< command >}} $ export LOCALSTACK_AUTH_TOKEN= -$ IMAGE_NAME=localstack/snowflake localstack start +$ localstack start --stack snowflake {{< / command >}} ### `docker` CLI @@ -100,7 +100,7 @@ When using `docker-compose` then simply add this variable to the `environment` s If you're starting up via the `localstack start` CLI, then make sure to start up via the following configuration: {{< command >}} -$ DOCKER_FLAGS='-e SF_LOG=trace' DEBUG=1 IMAGE_NAME=localstack/snowflake localstack start +$ DOCKER_FLAGS='-e SF_LOG=trace' DEBUG=1 localstack start --stack snowflake {{< / command >}} ### The `snowflake.localhost.localstack.cloud` hostname doesn't resolve on my machine, what can I do? diff --git a/content/en/references/configuration/index.md b/content/en/references/configuration/index.md index bda750e..afc2aff 100644 --- a/content/en/references/configuration/index.md +++ b/content/en/references/configuration/index.md @@ -16,7 +16,7 @@ LocalStack exposes various configuration options to control its behaviour. These options can be passed to LocalStack as environment variables like so: {{< command >}} -$ DEBUG=1 localstack start +$ DEBUG=1 localstack start --stack snowflake {{< / command >}} ## Core diff --git a/content/en/tutorials/aws-lambda-localstack-snowpark/index.md b/content/en/tutorials/aws-lambda-localstack-snowpark/index.md index 3ee422f..316945d 100644 --- a/content/en/tutorials/aws-lambda-localstack-snowpark/index.md +++ b/content/en/tutorials/aws-lambda-localstack-snowpark/index.md @@ -142,8 +142,7 @@ Start your LocalStack container in your preferred terminal/shell. $ export LOCALSTACK_AUTH_TOKEN= $ DEBUG=1 \ LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT=180 \ - IMAGE_NAME=localstack/snowflake \ - localstack start + localstack start --stack snowflake {{< / command >}} > The `DEBUG=1` environment variable is set to enable debug logs. It would allow you to see the SQL queries executed by the Lambda function. The `LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT` environment variable is set to increase the Lambda function's timeout to 180 seconds. diff --git a/content/en/tutorials/credit-scoring-with-localstack-snowpark/index.md b/content/en/tutorials/credit-scoring-with-localstack-snowpark/index.md index d6e5154..4f2e189 100644 --- a/content/en/tutorials/credit-scoring-with-localstack-snowpark/index.md +++ b/content/en/tutorials/credit-scoring-with-localstack-snowpark/index.md @@ -28,7 +28,7 @@ Start your LocalStack container in your preferred terminal/shell. {{< command >}} $ export LOCALSTACK_AUTH_TOKEN= -$ IMAGE_NAME=localstack/snowflake localstack start +$ localstack start --stack snowflake {{< / command >}} ## Create a Snowpark session diff --git a/content/en/user-guide/init-hooks/index.md b/content/en/user-guide/init-hooks/index.md index 36e86ce..d182d23 100644 --- a/content/en/user-guide/init-hooks/index.md +++ b/content/en/user-guide/init-hooks/index.md @@ -53,7 +53,7 @@ services: {{< tab header="CLI" lang="bash" >}} # DOCKER_FLAGS are additional parameters to the `docker run` command of localstack start -DOCKER_FLAGS='-v /path/to/test.sf.sql:/etc/localstack/init/ready.d/test.sf.sql' DEBUG=1 localstack start +DOCKER_FLAGS='-v /path/to/test.sf.sql:/etc/localstack/init/ready.d/test.sf.sql' DEBUG=1 localstack start --stack snowflake {{< /tab >}} {{< /tabpane >}} diff --git a/content/en/user-guide/integrations/continuous-integration/index.md b/content/en/user-guide/integrations/continuous-integration/index.md index fa7eee8..d10aef9 100644 --- a/content/en/user-guide/integrations/continuous-integration/index.md +++ b/content/en/user-guide/integrations/continuous-integration/index.md @@ -44,12 +44,12 @@ jobs: run: docker pull localstack/snowflake:latest & pip install localstack - IMAGE_NAME=localstack/snowflake localstack start -d + localstack start --stack snowflake echo "Waiting for LocalStack startup..." localstack wait -t 15 echo "Startup complete" env: - LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }} + LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }} {{< /tab >}} {{< tab header="CircleCI" lang="yaml" >}} version: 2.1 @@ -70,11 +70,11 @@ jobs: command: | pip3 install localstack docker pull localstack/snowflake - IMAGE_NAME=localstack/snowflake localstack start -d + localstack start --stack snowflake echo "Waiting for LocalStack startup..." localstack wait -t 30 - echo "Startup complete" + echo "Startup complete" workflows: version: 2 @@ -93,7 +93,7 @@ test: variables: DOCKER_HOST: tcp://docker:2375 DOCKER_TLS_CERTDIR: "" - LOCALSTACK_API_KEY: $LOCALSTACK_API_KEY + LOCALSTACK_AUTH_TOKEN: $LOCALSTACK_AUTH_TOKEN services: - name: docker:20.10.16-dind @@ -108,7 +108,7 @@ test: - docker pull localstack/snowflake:latest - dind_ip="$(getent hosts docker | cut -d' ' -f1)" - echo "${dind_ip} localhost.localstack.cloud " >> /etc/hosts - - DOCKER_HOST="tcp://${dind_ip}:2375" IMAGE_NAME=localstack/snowflake localstack start -d + - DOCKER_HOST="tcp://${dind_ip}:2375" localstack start --stack snowflake - localstack wait -t 15 {{< /tab >}} {{< /tabpane >}} diff --git a/content/en/user-guide/state-management/index.md b/content/en/user-guide/state-management/index.md index fedb4ad..bc174e6 100644 --- a/content/en/user-guide/state-management/index.md +++ b/content/en/user-guide/state-management/index.md @@ -26,7 +26,7 @@ To start snapshot-based persistence, launch LocalStack with the configuration op {{< tabpane >}} {{< tab header="LocalStack CLI" lang="bash" >}} -LOCALSTACK_AUTH_TOKEN=... PERSISTENCE=1 IMAGE_NAME=localstack/snowflake localstack start +LOCALSTACK_AUTH_TOKEN=... PERSISTENCE=1 localstack start --stack snowflake {{< /tab >}} {{< tab header="Docker Compose" lang="yaml" >}} ... diff --git a/content/en/user-guide/user-interface/index.md b/content/en/user-guide/user-interface/index.md index fef6d6a..8fac173 100644 --- a/content/en/user-guide/user-interface/index.md +++ b/content/en/user-guide/user-interface/index.md @@ -28,7 +28,8 @@ Please note that the Snowflake User Interface is still experimental and under ac This guide is designed for users new to the Snowflake emulator Web UI. Start your Snowflake emulator using the following command: ```bash -IMAGE_NAME=localstack/snowflake localstack start +export LOCALSTACK_AUTH_TOKEN= +localstack start --stack snowflake ``` Navigate to [**https://app.localstack.cloud/inst/default/snowflake**](https://app.localstack.cloud/inst/default/snowflake) to access the User Interface. From a7ae581a3c3a68fd3d11f3645964d2058ce60ced Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Mon, 16 Jun 2025 11:19:13 +0530 Subject: [PATCH 2/2] more --- content/en/getting-started/quickstart/index.md | 2 +- content/en/references/configuration/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/getting-started/quickstart/index.md b/content/en/getting-started/quickstart/index.md index 9c2044a..df24c88 100644 --- a/content/en/getting-started/quickstart/index.md +++ b/content/en/getting-started/quickstart/index.md @@ -24,7 +24,7 @@ Before you begin, pull the Snowflake emulator image (`localstack/snowflake`) and {{< command >}} $ export LOCALSTACK_AUTH_TOKEN= -$ IMAGE_NAME=localstack/snowflake:latest localstack start +$ localstack start --stack snowflake {{< / command >}} Check the emulator's availability by running: diff --git a/content/en/references/configuration/index.md b/content/en/references/configuration/index.md index afc2aff..95e97d0 100644 --- a/content/en/references/configuration/index.md +++ b/content/en/references/configuration/index.md @@ -95,7 +95,7 @@ You can load a profile by either setting the environment variable `CONFIG_PROFIL Let's take an example to load the `dev.env` profile file if it exists: {{< command >}} -$ IMAGE_NAME=localstack/snowflake localstack --profile=dev start +$ localstack --profile=dev start --stack snowflake {{< / command >}} If no profile is specified, the `default.env` profile will be loaded.