From e72c11cdfe07af39bcf4b587d674db1b0206ab0c Mon Sep 17 00:00:00 2001 From: Simon Wallner Date: Thu, 16 Nov 2023 14:25:42 +0100 Subject: [PATCH] update docs with new license management flow and UX (#864) Co-authored-by: HarshCasper --- .github/workflows/markdown.links.config.json | 3 + content/en/getting-started/api-key.md | 4 + content/en/getting-started/auth-token.md | 119 ++++++++++++++++++ content/en/getting-started/faq.md | 22 ++-- content/en/getting-started/glossary.md | 2 +- content/en/getting-started/installation.md | 32 ++--- content/en/getting-started/quickstart.md | 8 +- content/en/overview/_index.html | 2 +- content/en/references/configuration.md | 4 +- content/en/references/docker-images.md | 4 +- .../transparent-endpoint-injection/_index.md | 2 +- .../en/references/persistence-mechanism.md | 6 +- content/en/references/usage-tracking.md | 10 +- .../tutorials/ecs-ecr-container-app/index.md | 6 +- .../en/tutorials/elb-load-balancing/index.md | 4 +- .../tutorials/java-notification-app/index.md | 6 +- .../lambda-ecr-container-images/index.md | 6 +- .../index.md | 8 +- .../schema-evolution-glue-msk/index.md | 8 +- content/en/user-guide/ci/_index.md | 12 +- content/en/user-guide/ci/circle-ci/index.md | 2 +- content/en/user-guide/ci/drone-ci/index.md | 8 +- .../en/user-guide/ci/github-actions/index.md | 16 +-- content/en/user-guide/ci/gitlab-ci/index.md | 8 +- content/en/user-guide/ci/harness-ci/index.md | 16 +-- content/en/user-guide/ci/travis-ci/index.md | 10 +- .../extensions/developing-extensions/index.md | 4 +- .../extensions/managing-extensions/index.md | 6 +- .../integrations/kafka/docker-compose.yml | 2 +- .../tools/cloud-pods/getting-started/index.md | 8 +- .../en/user-guide/web-application/_index.md | 4 +- .../web-application/accounts/account.png | Bin 0 -> 7681960 bytes .../web-application/accounts/indcomp.PNG | Bin 44340 -> 0 bytes .../web-application/accounts/index.md | 28 ++--- .../web-application/auth-token/index.md | 29 +++++ .../web-application/ci-keys/ci-keys.png | Bin 0 -> 11672226 bytes .../web-application/ci-keys/index.md | 33 +++++ .../cloud-pods-browser/index.md | 4 +- .../custom-local-endpoint.md | 6 +- .../export-import-state/index.md | 10 +- .../extensions-library/index.md | 13 +- .../web-application/resource-browser/index.md | 8 +- .../web-application/single-sign-on/_index.md | 10 +- .../single-sign-on/azure-ad/index.md | 4 +- .../web-application/stack-insights/index.md | 10 +- .../user-guide/web-application/teams/index.md | 27 ---- .../web-application/teams/memberroles.PNG | Bin 76344 -> 0 bytes .../web-application/teams/teammembers.PNG | Bin 16645 -> 0 bytes .../web-application/users-licences/index.md | 72 +++++++++++ .../users-licences/users-licences.png | Bin 0 -> 9878951 bytes .../web-application/workspaces/index.md | 15 +++ .../web-application/workspaces/workspace.png | Bin 0 -> 11663011 bytes 52 files changed, 428 insertions(+), 193 deletions(-) create mode 100644 content/en/getting-started/auth-token.md create mode 100644 content/en/user-guide/web-application/accounts/account.png delete mode 100644 content/en/user-guide/web-application/accounts/indcomp.PNG create mode 100644 content/en/user-guide/web-application/auth-token/index.md create mode 100644 content/en/user-guide/web-application/ci-keys/ci-keys.png create mode 100644 content/en/user-guide/web-application/ci-keys/index.md delete mode 100644 content/en/user-guide/web-application/teams/index.md delete mode 100644 content/en/user-guide/web-application/teams/memberroles.PNG delete mode 100644 content/en/user-guide/web-application/teams/teammembers.PNG create mode 100644 content/en/user-guide/web-application/users-licences/index.md create mode 100644 content/en/user-guide/web-application/users-licences/users-licences.png create mode 100644 content/en/user-guide/web-application/workspaces/index.md create mode 100644 content/en/user-guide/web-application/workspaces/workspace.png diff --git a/.github/workflows/markdown.links.config.json b/.github/workflows/markdown.links.config.json index 9a04b0ae10..61842f29f2 100644 --- a/.github/workflows/markdown.links.config.json +++ b/.github/workflows/markdown.links.config.json @@ -1,5 +1,8 @@ { "ignorePatterns": [ + { + "pattern": "https://localstack.cloud/(.*)" + }, { "pattern": "https://kinesis.us-east-1.amazonaws.com/" }, diff --git a/content/en/getting-started/api-key.md b/content/en/getting-started/api-key.md index 2b9ab12ff6..232f92f578 100644 --- a/content/en/getting-started/api-key.md +++ b/content/en/getting-started/api-key.md @@ -8,6 +8,10 @@ aliases: - /get-started/pro/ --- +{{< alert title="Important" color="danger" >}} +API Keys are being phased out for LocalStack activation, with a transition to Auth Tokens. Auth Tokens simplify license management and eliminate the need for developers to modify their setup when there are changes to licenses. Refer to our [Auth Token documentation]({{< ref "auth-token" >}}) for more information. +{{< /alert >}} + The LocalStack API key is a unique identifier to activate your LocalStack license needed to start LocalStack Pro. You can find your API key in the [LocalStack Web app](https://app.localstack.cloud/account/apikeys). This guide demonstrates how you can use your new LocalStack licenses and go over some best practices regarding the usage, activation, and safety of your LocalStack API key. diff --git a/content/en/getting-started/auth-token.md b/content/en/getting-started/auth-token.md new file mode 100644 index 0000000000..4670cd8276 --- /dev/null +++ b/content/en/getting-started/auth-token.md @@ -0,0 +1,119 @@ +--- +title: "Auth Token" +weight: 20 +description: > + Configure your auth token to start LocalStack +--- + +LocalStack uses auth tokens to to authenticate users and to activate your LocalStack license. +You can find your auth token on the [Getting Started page in the web app](https://app.localstack.cloud/getting-started) or on the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) + +## Managing your License + +To get started, you need to have a LocalStack license. If you don't have one, you can [sign up for a free trial](https://localstack.cloud/pricing/) without any credit card required. The free trial will last 14 days, and you can use it to test all the features of LocalStack. + +You can assign licenses to users on the [Users & Licenses](https://app.localstack.cloud/workspace/members) page or you can check your assigned license on the [My License](https://app.localstack.cloud/workspace/my-license) page. + +{{< alert title="Important" color="danger" >}} +- Avoid sharing your auth token with anyone. Ensure that you do not commit it to any source code management systems (like Git repositories). +- If you push an auth token to a public repository, it has potentially been exposed and might remain in the history (even if you try to rewrite it). +- If you accidentally publish your auth token, you can rotate it on the [Auth Token](https://app.localstack.cloud/workspace/auth-token) page +- Use in CI or other machine environments requires a CI key. Check out our [CI documentation]({{< ref "user-guide/ci" >}}) to see the proper way to handle secrets in your CI environment to store your CI key securely. +{{< /alert >}} + +### Starting LocalStack via CLI + +LocalStack expects your auth token to be present in the environment variable `LOCALSTACK_AUTH_TOKEN`. You can define the `LOCALSTACK_AUTH_TOKEN` environment variable before or while starting LocalStack using the `localstack` CLI. + +{{< tabpane >}} +{{< tab header="macOS/Linux" lang="shell" >}} +export LOCALSTACK_AUTH_TOKEN= +localstack start +{{< /tab >}} +{{< tab header="Windows" lang="powershell" >}} +$env:LOCALSTACK_AUTH_TOKEN=""; localstack start +{{< /tab >}} +{{< /tabpane >}} + +You can optionally run your LocalStack container in background mode by adding the `-d` flag to the `localstack start` command. + +The `localstack` CLI will detect the auth token and properly pass it to the LocalStack container. + +{{< alert title="Note" >}} +If you are using LocalStack with an auth token, you need to pull the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image) that includes the Pro services and several other advanced features. +{{< /alert >}} + +### Starting LocalStack via Docker + +To start LocalStack using Docker, you have to specify the auth token using the `-e` flag for environment variables: + +{{< command "hl_lines=5" >}} +$ docker run \ + --rm -it \ + -p 4566:4566 \ + -p 4510-4559:4510-4559 \ + -e LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:- } \ + localstack/localstack-pro +{{< / command >}} + +For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide. + +### Starting LocalStack via Docker-Compose + +To start LocalStack using `docker-compose`, you have to include the `LOCALSTACK_AUTH_TOKEN` environment variable in your `docker-compose.yml` file: + +```yaml +environment: + - LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN- } +``` + +You can set the auth token manually, or you can use the `export` command to set the auth token in your current shell session. The auth token will be passed into your LocalStack container, such that the key activation can take place. + +## Licensing-related configuration + +If you want to make sure that LocalStack is only started if you can activate LocalStack Pro or Enterprise, or if you wish to suppress licensing-related error messages, take a look at our [configuration guide]({{< ref "configuration.md#localstack-pro">}}) regarding LocalStack Pro. + +## Checking license activation + +The easiest way to check if LocalStack is activated is to query the health endpoint for a list of the running services: + +{{< command >}} +$ curl localhost:4566/_localstack/health | jq +{{< / command >}} + +If a Pro-only [service]({{< ref "aws" >}}) -- like [XRay]({{< ref "xray" >}}) -- is running, LocalStack has started successfully. You can also check the logs of the LocalStack container to see if the activation was successful. + +{{< command >}} +[...] Successfully activated license +{{< / command >}} + +Otherwise, check our collected most [common activation issues](#common-activation-issues). + +## Common activation issues + +Since LocalStack v2.0.0, the image `localstack/localstack-pro` requires a successful license activation to start. +If the license activation fails, LocalStack will quit with an error messages that may look something like this: + +```bash +=============================================== +License activation failed! 🔑❌ + +Reason: The credentials defined in your environment are invalid. Please make sure to either set the LOCALSTACK_AUTH_TOKEN variable to a valid auth token, or the LOCALSTACK_API_KEY variable to a valid LocalStack API key. You can find your auth token or API key in the LocalStack web app https://app.localstack.cloud. + +Due to this error, Localstack has quit. LocalStack pro features can only be used with a valid license. + +- Please check that your credentials are set up correctly and that you have an active license. + You can find your credentials in our webapp at https://app.localstack.cloud. +- If you want to continue using LocalStack without pro features you can set `ACTIVATE_PRO=0`. +``` + +There are several reasons a key activation can fail: +* Missing credentials: Using `localstack/localstack-pro` requires per default to have an auth token or legacy API key set. +* Invalid license: there is no valid license associated with your user account, for example because the license has expired. +* License server cannot be reached: LocalStack will try to perform an offline license activation if the license server cannot be reached, but will require a re-activation every 24 hours. + +If you are using the `localstack/localstack-pro` image, but cannot activate your license, we recommend falling back to the community version `localstack/localstack`. +If that is not an option, you can set `ACTIVATE_PRO=0` which will attempt to start LocalStack without pro features. + +Navigate to our [FAQ page]({{< ref "faq" >}}) if your are having troubles with the LocalStack license activation. +If you have any further problems concerning your license activation, or if the steps do not help, do not hesitate to [contact us](https://localstack.cloud/contact/). diff --git a/content/en/getting-started/faq.md b/content/en/getting-started/faq.md index 619badad3e..0f85f76496 100644 --- a/content/en/getting-started/faq.md +++ b/content/en/getting-started/faq.md @@ -3,7 +3,7 @@ title: "Frequently Asked Questions" linkTitle: "FAQ" weight: 40 description: > - This page answers the frequently asked questions about LocalStack Pro, Enterprise, and Community Editions. + This page answers the frequently asked questions about LocalStack Pro, Enterprise, and Community Editions. cascade: type: docs hide_readingtime: true @@ -74,7 +74,7 @@ For additional known issues related to Git Bash, you can refer to the following ### How to fix LocalStack CLI (Python) UTF-8 encoding issue under Windows? -If you are using LocalStack CLI under Windows, you might run into encoding issues. To fix this, set the following environment variables: +If you are using LocalStack CLI under Windows, you might run into encoding issues. To fix this, set the following environment variables: Set the system locale (language for non-Unicode programs) to UTF-8 to avoid Unicode errors. Follow these steps: @@ -93,8 +93,8 @@ A company proxy can lead to connection issues. To allow access to the `localstac ```yaml ... -environment: -- HTTP_PROXY = +environment: +- HTTP_PROXY = - NO_PROXY = .s3.localhost.localstack.cloud,127.0.0.1,*.localhost ... ``` @@ -135,7 +135,7 @@ You might be able to connect to the internet, but your Docker container can't co More details can be found on [official docker documentation](https://docs.docker.com/network/bridge/#enable-forwarding-from-docker-containers-to-the-outside-world). -Solution for this is enabling the IP forwarding: +Solution for this is enabling the IP forwarding: ```bash sudo sysctl -w net.ipv4.ip_forward=1 @@ -175,7 +175,7 @@ For example, these options may interfere with the functionality of AppSync funct We advise you to exercise caution. {{< /alert >}} -You can change the LocalStack `volume` folder to use the WSL Linux file system instead of the Windows host folder. +You can change the LocalStack `volume` folder to use the WSL Linux file system instead of the Windows host folder. To do so, you need to change the [`docker-compose.yml`](https://github.com/localstack/localstack/blob/master/docker-compose-pro.yml) file and add the following lines: {{< tabpane text=true >}} @@ -213,7 +213,7 @@ For more details visit [Docker WSL documentation](https://docs.docker.com/deskto ## LocalStack Platform FAQs -### How do I check if my API key is valid and activated? +### How do I check if my license is valid and activated? The easiest way to check if LocalStack Pro or Enterprise is activated is to check the health endpoint of LocalStack for a list of the running services: @@ -221,13 +221,13 @@ The easiest way to check if LocalStack Pro or Enterprise is activated is to chec $ curl localhost:4566/_localstack/health | jq {{< / command >}} -If a Pro-only [service]({{< ref "aws" >}}) -- like [XRay]({{< ref "xray" >}}) -- is running, LocalStack Pro or Enterprise has started successfully. If your API key is invalid, you will see an error message like this in the logs of LocalStack: +If a Pro-only [service]({{< ref "aws" >}}) -- like [XRay]({{< ref "xray" >}}) -- is running, LocalStack Pro or Enterprise has started successfully. If your auth token is invalid, you will see an error message like this in the logs of LocalStack: ```bash -Activation key "abc..."(10) is invalid or expired! Reason: ... +license activation failed! Reason: ... ``` -If this error occurs, something is wrong with your API key or license. Make sure your API key is set correctly (check for typos!) and your license is valid. If the API key still does not work, please [contact us](https://localstack.cloud/contact/). +If this error occurs, something is wrong with your auth token or license. Make sure your auth token is set correctly (check for typos!) and your license is valid. If the auth token still does not work, please [contact us](https://localstack.cloud/contact/). ### How are CI credits in LocalStack calculated? @@ -269,7 +269,7 @@ Some corporate DNS servers might filter requests to certain domains. Contact you We take security seriously and respond to any emergency vulnerabilities as soon as possible. Our cloud provider (AWS) handles most of the infrastructure maintenance for us. We also use Infrastructure-as-Code scripts to ensure that our infrastructure configuration is consistent and recoverable in case of a disaster. -### How does LocalStack ensure the security of its containers and images? +### How does LocalStack ensure the security of its containers and images? Our software assets are regularly checked for vulnerabilities, such as code issues and outdated dependencies. We use Dependabot to scan our GitHub repositories, and Trivy as well as Snyk (among other security tools) to scan our Docker images. diff --git a/content/en/getting-started/glossary.md b/content/en/getting-started/glossary.md index de90224355..b51829675b 100644 --- a/content/en/getting-started/glossary.md +++ b/content/en/getting-started/glossary.md @@ -18,7 +18,7 @@ hide_readingtime: true | [Edge Port]({{< ref "endpoint-url" >}}) | The HTTP port LocalStack listens on for any type of request (e.g. from AWS SDKs). The default port is 4566. | | [External Service Ports]({{< ref "external-ports" >}}) | The ports reserved for infrastructure that is started as part of a managed service like database server, Redis cluster, and are exposed through the LocalStack Container. | | [Lambda Hot Reloading]({{< ref "hot-reloading" >}}) | The ability to make changes in Lambda handler files, and have them immediately reflected on each invocation of a Lambda function, without the need to redeploy the Lambda function. | -| [LocalStack API Key]({{< ref "api-key" >}}) | An API key that can be configured via the LOCALSTACK_API_KEY environment variable, to enable advanced features in your LocalStack instance. We distinguish between individual developer keys, as well as CI keys for continuous integration environments (e.g., Github Actions, CircleCI, etc). | +| [LocalStack auth token]({{< ref "auth-token" >}}) | An auth token that can be configured via the LOCALSTACK_AUTH_TOKEN environment variable, to enable advanced features in your LocalStack instance. We distinguish between individual developer auth tokens, as well as CI keys for continuous integration environments (e.g., Github Actions, CircleCI, etc). | | [LocalStack Container]({{< ref "installation" >}}) | The Docker/Podman container or Kubernetes pod running LocalStack. | | [LocalStack Extensions]({{< ref "references/extensions" >}}) | Extend and customize LocalStack using pluggable Python distributions to run applications alongside the main process in the LocalStack Docker container. | | [LocalStack Platform]({{< ref "web-application" >}}) | The LocalStack Web Application for licensed users to use advanced features, such as Stack Insights, CI Analytics, Resource Browser, and Team Collaboration. | diff --git a/content/en/getting-started/installation.md b/content/en/getting-started/installation.md index 7d2dd7839c..4c480d5789 100644 --- a/content/en/getting-started/installation.md +++ b/content/en/getting-started/installation.md @@ -60,7 +60,7 @@ $ python3 -m pip install --upgrade localstack {{% /markdown %}} {{< alert title="Important" color="danger" >}} -Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. +Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. If you have problems with permissions in MacOS X Sierra, install with `python3 -m pip install --user localstack`. {{< /alert >}} @@ -119,7 +119,7 @@ $ python3 -m pip install --upgrade localstack {{< / command >}} {{% /markdown %}} {{< alert title="Important" color="danger" >}} -Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. +Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. {{< /alert >}} {{< /tab >}} @@ -127,7 +127,7 @@ Do not use `sudo` or the `root` user - LocalStack should be installed and starte {{< tab header="Windows" >}} -You can download the respective binary for your architecture directly: +You can download the respective binary for your architecture directly: {{< cli-binary-download os="windows" >}}
Then extract the archive and execute the binary using Powershell. @@ -146,7 +146,7 @@ $ python3 -m pip install --upgrade localstack {{% /markdown %}} {{< alert title="Important" color="danger" >}} -Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. +Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. {{< /alert >}} {{< /tab >}} @@ -168,7 +168,7 @@ $ python3 -m pip install --upgrade localstack {{< alert title="Note" >}} To download a specific version of LocalStack, check out our [release page](https://github.com/localstack/localstack) and download it in the following manner: -{{< command >}} +{{< command >}} $ python3 -m pip install localstack== {{< / command >}} {{% markdown %}} @@ -177,7 +177,7 @@ Here `` depicts the particular LocalStack version that you would like t {{< /alert >}} {{< alert title="Important" color="danger" >}} -Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. +Do not use `sudo` or the `root` user - LocalStack should be installed and started entirely under a local non-root user. {{< /alert >}} {{< /tab >}} {{< /tabpane >}} @@ -189,7 +189,7 @@ $ localstack --version {{< / command >}} You are all set! -To use all of LocalStack's features we recommend to [get a LocalStack account and set up your api key]({{< ref "api-key" >}}). +To use all of LocalStack's features we recommend to [get a LocalStack account and set up your auth token]({{< ref "auth-token" >}}). Afterwards, check out our [Quickstart guide]({{< ref "quickstart" >}}) to start your local cloud! ## Alternatives @@ -272,7 +272,7 @@ services: environment: - DEBUG=${DEBUG-} - PERSISTENCE=${PERSISTENCE-} - - LOCALSTACK_API_KEY=${LOCALSTACK_API_KEY-} # required for Pro + - LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN-} # required for Pro - DOCKER_HOST=unix:///var/run/docker.sock volumes: - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack" @@ -290,7 +290,7 @@ $ docker-compose up - This command pulls the current nightly build from the `master` branch (if you don't have the image locally) and **not** the latest supported version. If you want to use a specific version, set the appropriate localstack image tag at `services.localstack.image` in the `docker-compose.yml` file (for example `localstack/localstack:`). -- If you are using LocalStack with an [API key]({{< ref "api-key" >}}), you need to specify the image tag as `localstack/localstack-pro` in the `docker-compose.yml` file. +- If you are using LocalStack with an [auth token]({{< ref "auth-token" >}}), you need to specify the image tag as `localstack/localstack-pro` in the `docker-compose.yml` file. Going forward, `localstack/localstack-pro` image will contain our Pro-supported services and APIs. - This command reuses the image if it's already on your machine, i.e. it will **not** pull the latest image automatically from Docker Hub. @@ -303,7 +303,7 @@ $ docker-compose up - If using the Docker default bridge network using `network_mode: bridge`, container name resolution will not work inside your containers. Please consider removing it, if this functionality is needed. -- To configure an API key, refer to the [API Key](https://docs.localstack.cloud/getting-started/api-key/) documentation. +- To configure an auth token, refer to the [auth token]({{< ref "auth-token" >}}) documentation. {{< /alert >}} Please note that there are a few pitfalls when configuring your stack manually via docker-compose (e.g., required container name, Docker network, volume mounts, and environment variables). @@ -342,7 +342,7 @@ docker run \ --rm -it \ -p 4566:4566 \ -p 4510-4559:4510-4559 \ - -e LOCALSTACK_API_KEY=${LOCALSTACK_API_KEY:- } \ + -e LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:- } \ localstack/localstack-pro{{< /tab >}} {{< /tabpane >}} @@ -350,7 +350,7 @@ docker run \ - This command pulls the current nightly build from the `master` branch (if you don't have the image locally) and **not** the latest supported version. If you want to use a specific version of LocalStack, use the appropriate tag: `docker run --rm -it -p 4566:4566 -p 4510-4559:4510-4559 localstack/localstack:`. Check-out the [LocalStack releases](https://github.com/localstack/localstack/releases) to know more about specific LocalStack versions. -- If you are using LocalStack with an [API key]({{< ref "api-key" >}}), you need to specify the image tag as `localstack/localstack-pro` in your Docker setup. +- If you are using LocalStack with an [auth token]({{< ref "auth-token" >}}), you need to specify the image tag as `localstack/localstack-pro` in your Docker setup. Going forward, `localstack/localstack-pro` image will contain our Pro-supported services and APIs. - This command reuses the image if it's already on your machine, i.e. it will **not** pull the latest image automatically from Docker Hub. @@ -362,7 +362,7 @@ docker run \ - To facilitate interoperability, configuration variables can be prefixed with `LOCALSTACK_` in docker. For instance, setting `LOCALSTACK_PERSISTENCE=1` is equivalent to `PERSISTENCE=1`. -- To configure an API key, refer to the [API Key](https://docs.localstack.cloud/getting-started/api-key/) documentation. +- To configure an auth token, refer to the [auth token]({{< ref "auth-token" >}}) documentation. {{< /alert >}} ### Helm @@ -425,13 +425,13 @@ If you have installed the CLI with Brew or directly as a binary, please simply p You can now avail logging output and error reporting using LocalStack logs. To access the logs, run the following command: {{< command >}} - $ localstack logs + $ localstack logs {{< / command >}} - + AWS requests are now logged uniformly in the INFO log level (set by default or when `DEBUG=0`). The shape is `AWS . => ()`. Requests to HTTP endpoints are logged in a similar way: - + ```sh 2022-09-12T10:39:21.165 INFO --- [ asgi_gw_0] localstack.request.aws : AWS s3.ListBuckets => 200 2022-09-12T10:39:41.315 INFO --- [ asgi_gw_0] localstack.request.aws : AWS s3.CreateBucket => 200 diff --git a/content/en/getting-started/quickstart.md b/content/en/getting-started/quickstart.md index 0b4a459861..7f69c5faad 100644 --- a/content/en/getting-started/quickstart.md +++ b/content/en/getting-started/quickstart.md @@ -8,7 +8,7 @@ cascade: type: docs --- -This quickstart guide will walk you through starting LocalStack on your local machine to deploying a sample AWS application locally using LocalStack's cloud emulation. This guide assumes that you have [installed LocalStack on your local machine]({{< ref "installation" >}}), [signed up](https://app.localstack.cloud) for a LocalStack account and configured your [API key]({{< ref "api-key" >}}) to authenticate your LocalStack container on startup. +This quickstart guide will walk you through starting LocalStack on your local machine to deploying a sample AWS application locally using LocalStack's cloud emulation. This guide assumes that you have [installed LocalStack on your local machine]({{< ref "installation" >}}), [signed up](https://app.localstack.cloud) for a LocalStack account and configured your [auth token]({{< ref "auth-token" >}}) to authenticate your LocalStack container on startup. {{< alert title="Note" >}} The quickest way to experiment with LocalStack is to use one of our [LocalStack quickstart samples](https://app.localstack.cloud/quickstart) to deploy a thumbnail creator, request worker application, or an asynchronous microservice with tracing/debugging. The quickstart samples will automatically connect to your running LocalStack container on your local machine and run the applications. @@ -18,7 +18,7 @@ To quickly see the outcome of this quickstart guide, try deploying the [Request ## Start your LocalStack container -After installing LocalStack and configuring your API key, let us start LocalStack. To run our sample AWS application, we will start LocalStack using the `localstack` CLI. +After installing LocalStack and configuring your auth token, let us start LocalStack. To run our sample AWS application, we will start LocalStack using the `localstack` CLI. {{< command >}} $ localstack start @@ -34,8 +34,8 @@ You can optionally run your LocalStack container in background mode by adding th - The default image [`localstack/localstack`](https://hub.docker.com/r/localstack/localstack) on Docker Hub refers to the community version of LocalStack. The [`localstack/localstack-pro`](https://hub.docker.com/r/localstack/localstack-pro) image refers to the Pro version of LocalStack. Previously we maintained `localstack-light` and `localstack-full` images which have been deprecated and removed with the LocalStack 2.0 release. -- If an [API key]({{< ref "api-key" >}}) is set in your environment, `localstack start` will attempt to start LocalStack with the `localstack/localtack-pro` image. - A successful key activation is required to start LocalStack Pro but can be disabled by setting `ACTIVATE_PRO=0`. +- If an [auth token]({{< ref "auth-token" >}}) is set in your environment, `localstack start` will attempt to start LocalStack with the `localstack/localtack-pro` image. + A successful license activation is required to start LocalStack Pro but can be disabled by setting `ACTIVATE_PRO=0`. {{< /alert >}} ## Setup the sample AWS application diff --git a/content/en/overview/_index.html b/content/en/overview/_index.html index a557e2cf01..66532ec498 100644 --- a/content/en/overview/_index.html +++ b/content/en/overview/_index.html @@ -107,7 +107,7 @@
Featured guides and articles