diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index cffd522cc9..f3fd902e78 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -7,6 +7,7 @@ ignores: - 'content/en/user-guide/integrations/terraform/*' - 'content/en/user-guide/aws/events/*' - 'content/en/references/coverage/_index.md' + - 'content/en/getting-started/installation.md' customRules: - markdownlint-rule-max-one-sentence-per-line config: @@ -25,3 +26,4 @@ config: MD032: false # Lists should be surrounded by blank lines MD018: false # No space after hash on atx style header MD022: false # Headers should be surrounded by blank lines + MD037: false # Spaces inside emphasis markers diff --git a/content/en/getting-started/auth-token/index.md b/content/en/getting-started/auth-token/index.md index 3e46f4b9f1..0a4a108383 100644 --- a/content/en/getting-started/auth-token/index.md +++ b/content/en/getting-started/auth-token/index.md @@ -2,24 +2,29 @@ title: "Auth Token" weight: 20 description: > - Configure your Auth Token to start LocalStack + Configure your Auth Token to access and activate LocalStack. --- ## Introduction -The Auth Token is a personal identifier used for user authentication outside the LocalStack Web Application, particularly in conjunction with the LocalStack core cloud emulator. -Its primary functions are to retrieve the user's license and enable access to advanced features, effectively replacing the older developer API keys. +The Auth Token identifies and authenticates users outside the LocalStack Web Application to activate the LocalStack core cloud emulator. +It primarily accesses your workspace and advanced services & features. -The Auth Token remains unchanged unless manually rotated by the user, regardless of any license assignment changes. -You can locate your Auth Token on the [Getting Started page](https://app.localstack.cloud/getting-started) or the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) in the LocalStack Web Application. +Auth tokens come in two types: a **Developer Auth Token** and a **CI Auth Token**: -{{< callout "warning" >}} -- Previously, API keys were required to activate the LocalStack core cloud emulator. - These API keys are now being replaced by Auth Tokens. -- Currently, LocalStack supports both API Keys and Auth Tokens. - However, API Keys will be discontinued in the upcoming major release of LocalStack. -- To update your LocalStack configuration, replace your API Key with an Auth Token. - Use the `LOCALSTACK_AUTH_TOKEN` environment variable in place of `LOCALSTACK_API_KEY`. +- The **Developer Auth Token** is linked to a specific user within a specific workspace. + Every user has their own Auth Token. + It cannot be deleted but can be rotated for security reasons if needed. +- The **CI Auth Token** is not associated with any specific user and is designed for use in CI environments and other non-developer contexts. + These tokens are stored in the workspace and can be managed by members with appropriate permissions. + +Both the **Developer Auth Token** and **CI Auth Token** can be managed on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens). + +{{< callout "warning">}} +- It's crucial to keep your Auth Token confidential. + Do not include it in source code management systems, such as Git repositories. +- Be aware that if an Auth Token is committed to a public repository, it is at risk of exposure, and could remain in the repository's history, even if attempts are made to rewrite it. +- In case your Auth Token is accidentally published, immediately rotate it on the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens). {{< /callout >}} ## Managing your License @@ -51,7 +56,7 @@ If you do not assign a license, you will not be able to use LocalStack even if y {{< /callout >}} To view your own assigned license, visit the [My License page](https://app.localstack.cloud/workspace/my-license). -You can further navigate to the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) to view your Auth Token. +You can further navigate to the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) to view your **Developer Auth Token** and **CI Auth Token**. ## Configuring your Auth Token @@ -63,7 +68,7 @@ The following sections describe the various methods of setting your Auth Token. - It's crucial to keep your Auth Token confidential. Do not include it in source code management systems, such as Git repositories. - Be aware that if an Auth Token is committed to a public repository, it's at risk of exposure, and could remain in the repository's history, even if attempts are made to rewrite it. -- In case your Auth Token is accidentally published, immediately rotate it on the [Auth Token page](https://app.localstack.cloud/workspace/auth-token). +- In case your Auth Token is accidentally published, immediately rotate it on the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens). {{< /callout >}} ### LocalStack CLI @@ -76,7 +81,8 @@ localstack auth set-token localstack start {{< /tab >}} {{< tab header="Windows" lang="powershell" >}} -$env:LOCALSTACK_AUTH_TOKEN=""; localstack start +localstack auth set-token +localstack start {{< /tab >}} {{< /tabpane >}} @@ -121,13 +127,31 @@ environment: You can manually set the Auth Token, or use the `export` command to establish the Auth Token in your current shell session. This ensures the Auth Token is transmitted to your LocalStack container, enabling key activation. -## Licensing-related configuration +### CI Environments + +CI environments require a CI Auth Token. +Developer Auth Tokens cannot be used in CI. +CI Auth Tokens are available on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) and are configured similarly to Developer Auth Tokens. + +To set the CI Auth Token, add the Auth Token value in the `LOCALSTACK_AUTH_TOKEN` environment variable of your CI provider, and refer to it when starting LocalStack in your CI workflow. +You can find detailed examples in our [LocalStack in CI documentation](https://docs.localstack.cloud/user-guide/ci/). + +## Rotating the Auth Token + +Your personal Auth Token provides full access to your workspace and LocalStack license. +It's important to treat auth tokens as confidential, avoiding sharing or storing them in source control management systems (SCMs) like Git. + +If you believe your Auth Token has been compromised or becomes known to someone else, reset it without delay. +When you reset a token, the old one is immediately deactivated, losing its ability to access your license or workspace. +It is not possible to restore previous tokens. + +To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) and select the **Reset Auth Token** option. + +## Licensing configuration & activation checkup To avoid logging any licensing-related error messages, set `LOG_LICENSE_ISSUES=0` in your environment. Refer to our [configuration guide](https://docs.localstack.cloud/references/configuration/#localstack-pro) for more information. -## Checking license activation - The simplest method to verify if LocalStack is active is by querying the health endpoint for a list of running services: {{< tabpane text=true >}} @@ -170,37 +194,37 @@ Another way to confirm this is by checking the logs of the LocalStack container [...] Successfully activated license {{< / command >}} -Otherwise, check our collected most [common activation issues](#common-activation-issues). +Otherwise, check our [troubleshooting](#troubleshooting) section. -## Rotating the Auth Token +## FAQ -Your personal Auth Token provides full access to your workspace and LocalStack license. -It's important to treat auth tokens as confidential, avoiding sharing or storing them in source control management systems (SCMs) like Git. +### How do I activate older versions of LocalStack (Before v3.0)? -If you believe your Auth Token has been compromised or becomes known to someone else, reset it without delay. -When you reset a token, the old one is immediately deactivated, losing its ability to access your license or workspace. -It is not possible to restore previous tokens. +Prior to the introduction of Auth Tokens, LocalStack used **API keys** managed through the `LOCALSTACK_API_KEY` environment variable for activation. + +For backwards compatibility, we've updated our back-end to accept new Auth Tokens within the `LOCALSTACK_API_KEY` variable. +You can use the new Auth Token in the same way you previously used the API key. -To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) and select the **Reset Auth Token** option. +### When will the legacy API keys be phased out? -### Configuring your CI environment +In early 2025, we will begin phasing out legacy API keys entirely. +After the sunsetting period, legacy API and legacy CI keys will no longer activate or work with LocalStack. -For use in Continuous Integration (CI) or automated test environments, a CI key is necessary. -Refer to our [CI documentation]({{< ref "user-guide/ci" >}}) for guidance on securely handling secrets, including storing your CI key in these environments. +During the sunsetting period, the legacy service will experience scheduled downtimes. +These are planned to encourage users to transition to new Auth Tokens while minimizing impact for those who have not yet updated. -To configure your CI key, you need to set the `LOCALSTACK_API_KEY` environment variable to your CI key. -You can find your CI key on the [CI Keys page](https://app.localstack.cloud/workspace/ci-keys) in the LocalStack Web Application. +The downtime schedule will be communicated well in advance, allowing users ample time to switch to the new Auth Tokens. -## Common activation issues +## Troubleshooting -Starting from version 2.0.0, the `localstack/localstack-pro` image in LocalStack demands a successful license activation for startup. +While using Auth Tokens, LocalStack demands a successful license activation for startup. If the activation of the license is unsuccessful, LocalStack will exit and display error messages. ```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. +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. @@ -213,8 +237,8 @@ The key activation in LocalStack may fail for several reasons, and the most comm ### Missing Credentials -You need to provide either an Auth Token or an API Key to start the LocalStack Pro image successfully. -You can find your Auth Token or API Key on the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) or the [Legacy API Key page](https://app.localstack.cloud/workspace/api-keys) in the LocalStack Web Application. +You need to provide either an Auth Token to start the LocalStack Pro image successfully. +You can find your Auth Token on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) in the LocalStack Web Application. If you are using the `localstack` CLI, you can set the `LOCALSTACK_AUTH_TOKEN` environment variable to your Auth Token or use the following command to set it up: diff --git a/content/en/getting-started/faq.md b/content/en/getting-started/faq.md index e1ccf078a6..f0e9ea6499 100644 --- a/content/en/getting-started/faq.md +++ b/content/en/getting-started/faq.md @@ -27,7 +27,7 @@ To resolve the issue follow the steps: Additionally, it’s important to clear the cached certificate from your host machine as mentioned above. 2. **Use HTTP Instead of HTTPS**: Where possible, use `http://` instead of `https://` to avoid issues related to the revoked certificates. This workaround works with most browsers. - However, Safari requires additional steps: + However, Safari requires additional steps: 2.1. **Safari Users**: To make this work, you’ll need to first navigate to the page in a new tab and accept the security warning. To do this, make sure that LocalStack is started with `SKIP_SSL_CERT_DOWNLOAD=1` and that you have cleared the cached certificate as mentioned above. Once you’ve accepted the warning, you should be able to proceed. @@ -280,20 +280,20 @@ $ 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 auth token is invalid, you will see an error message like this in the logs of LocalStack: +If your Auth Token is invalid, you will see an error message like this in the logs of LocalStack: ```bash license activation failed! Reason: ... ``` -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/). +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? -A CI key allows you to use LocalStack in your CI environment. -Every activation of a CI key consumes one build credit. +A CI Auth Token allows you to use LocalStack in your CI environment. +Every activation with a CI Auth Token consumes one CI credit. This means that with every build triggered through the LocalStack container you will consume one credit. To understand the CI pricing across our product tiers, follow up with our [LocalStack in CI]({{}}) documentation. @@ -329,7 +329,7 @@ $ dig api.localstack.cloud If the result has some other status than `status: NOERROR,` your machine cannot resolve this domain. Some corporate DNS servers might filter requests to certain domains. -Contact your network administrator to safelist`localstack.cloud` domains. +Contact your network administrator to safelist `localstack.cloud` domains. ### How does LocalStack Pro handle security patches and bug fixes? diff --git a/content/en/getting-started/help-and-support/index.md b/content/en/getting-started/help-and-support/index.md index 724f2816e1..bc1a9319ea 100644 --- a/content/en/getting-started/help-and-support/index.md +++ b/content/en/getting-started/help-and-support/index.md @@ -55,7 +55,7 @@ At the moment, we only provide support in `English`, as we are an international | Support ticketing portal | | | | βœ… | | SLAs | | | | βœ… | | Direct Slack connect channel | | | | βœ… | -| Dedicated CSM and AM | | | | βœ… | +| Dedicated CSM and TAM | | | | βœ… | - Real time chat support is offered during our [Support Business Hours](#support-business-hours) diff --git a/content/en/getting-started/installation.md b/content/en/getting-started/installation.md index a1f6967c8d..c4e8c7229e 100644 --- a/content/en/getting-started/installation.md +++ b/content/en/getting-started/installation.md @@ -15,12 +15,14 @@ The quickest way get started with LocalStack is by using the LocalStack CLI. It allows you to start LocalStack from your command line. Please make sure that you have a working [Docker installation](https://docs.docker.com/get-docker/) on your machine before moving on. +### Installing LocalStack CLI + The CLI starts and manages the LocalStack Docker container. For alternative methods of managing the LocalStack container, see our [alternative installation instructions]({{< ref "#alternatives" >}}). {{< tabpane text=true >}} - @@ -75,8 +77,8 @@ $ brew install localstack/tap/localstack-cli {{< /tab >}} - {{< tab header="**MacOS**" >}} @@ -182,6 +184,8 @@ It should be installed and started entirely under a local non-root user. {{< /tab >}} {{< /tabpane >}} +### Starting LocalStack + To verify that the LocalStack CLI was installed correctly, you can check the version in your terminal: {{< command >}} $ localstack --version @@ -189,9 +193,56 @@ $ localstack --version {{< / command >}} You are all set! +You can now start LocalStack with the following command: + +{{< command >}} +$ localstack start # start localstack in background with -d flag + + __ _______ __ __ + / / ____ _________ _/ / ___// /_____ ______/ /__ + / / / __ \/ ___/ __ `/ /\__ \/ __/ __ `/ ___/ //_/ + / /___/ /_/ / /__/ /_/ / /___/ / /_/ /_/ / /__/ ,< + /_____/\____/\___/\__,_/_//____/\__/\__,_/\___/_/|_| + + πŸ’» LocalStack CLI 4.0.0 + πŸ‘€ Profile: default + +[12:47:13] starting LocalStack in Docker mode 🐳 localstack.py:494 + preparing environment bootstrap.py:1240 + configuring container bootstrap.py:1248 + starting container bootstrap.py:1258 +[12:47:15] detaching bootstrap.py:1262 + +{{< / command >}} +{{< callout >}} 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! +Afterwards, check out our [Quickstart guide]({{< ref "quickstart" >}}) to start your local development cloud! +{{< /callout >}} + +### Updating LocalStack CLI + +The LocalStack CLI allows you to easily update the different components of LocalStack. +To check the various options available for updating, run: +{{< command >}} +$ localstack update --help +Usage: localstack update [OPTIONS] COMMAND [ARGS]... + + Update different LocalStack components. + +Options: + -h, --help Show this message and exit. + +Commands: + all Update all LocalStack components + docker-images Update docker images LocalStack depends on + localstack-cli Update LocalStack CLI +{{< / command >}} + +{{< callout >}} +Updating the LocalStack CLI using `localstack update localstack-cli` and `localstack update all` will work only if it was installed from the Python distribution. +If it was installed using the pre-built binary or via Brew, please run the installation steps again to update to the latest version. +{{< /callout >}} ## Alternatives @@ -213,6 +264,9 @@ Besides using the CLI, there are other ways of starting and managing your LocalS Use Helm to create a LocalStack deployment in a Kubernetes cluster. LocalStack runs inside a Docker container, and the above options are different ways to start and manage the LocalStack Docker container. + +The LocalStack emulator is available on Docker Hub in two editions: the Community Edition (`localstack/localstack`) and the Pro Edition (`localstack/localstack-pro`). + For a comprehensive overview of the LocalStack images, check out our [Docker images documentation]({{< ref "docker-images" >}}). ### LocalStack Desktop @@ -286,7 +340,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 [auth token]({{< ref "auth-token" >}}), 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. @@ -300,7 +354,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 auth token, refer to the [auth token]({{< ref "auth-token" >}}) documentation. +- To configure an Auth Token, refer to the [Auth Token]({{< ref "auth-token" >}}) documentation. {{< /callout >}} 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). @@ -357,7 +411,7 @@ $ docker run \ 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 [auth token]({{< ref "auth-token" >}}), 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. @@ -372,7 +426,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 auth token, refer to the [auth token]({{< ref "auth-token" >}}) documentation. +- To configure an Auth Token, refer to the [Auth Token]({{< ref "auth-token" >}}) documentation. {{< /callout >}} ### Helm @@ -394,29 +448,18 @@ $ helm upgrade --install localstack localstack-repo/localstack The Helm charts are not maintained in the main repository, but in a [separate one](https://github.com/localstack/helm-charts). -## Updating - -The LocalStack CLI allows you to easily update the different components of LocalStack. -To check the various options available for updating, run: -{{< command >}} -$ localstack update --help -Usage: localstack update [OPTIONS] COMMAND [ARGS]... - - Update different LocalStack components. - -Options: - -h, --help Show this message and exit. - -Commands: - all Update all LocalStack components - docker-images Update docker images LocalStack depends on - localstack-cli Update LocalStack CLI -{{< / command >}} +## What's next? -{{< callout >}} -Updating the LocalStack CLI using `localstack update localstack-cli` and `localstack update all` will work only if it was installed from the Python distribution. -If it was installed using the pre-built binary or via Brew, please run the installation steps again to update to the latest version. -{{< /callout >}} +Now that you have LocalStack up and running, the following resources might be useful for your next steps: +- Check out our [Quickstart guide]({{< ref "quickstart" >}}) if you are a new user to get started with LocalStack quickly. +- [Use the LocalStack integrations]({{< ref "integrations" >}}) to interact with LocalStack and other integrated tools, for example: + - Use `awslocal` to use the AWS CLI against your local cloud! + - Use the Serverless Framework with LocalStack! + - And many more! +- [Find out how to configure LocalStack]({{< ref "configuration" >}}) such that it perfectly fits your need. +- [Use LocalStack in your CI environment]({{< ref "user-guide/ci" >}}) to increase your code quality. +- [Checkout LocalStack's Cloud Developer Tools]({{< ref "user-guide/tools" >}}) to further increase your development efficiency with LocalStack. +- Find out about the ways you can [configure LocalStack]({{< ref "configuration" >}}). ## Troubleshooting @@ -483,16 +526,3 @@ After running the task, run the diagnostic endpoint and share the archive file w We have extensive network troubleshooting documentation available [here]({{< ref "references/network-troubleshooting" >}}). If this does not solve your problem then please [reach out]({{< ref "help-and-support" >}}). - -## What's next? - -Now that you have LocalStack up and running, the following resources might be useful for your next steps: -- Check out our [Quickstart guide]({{< ref "quickstart" >}}) if you are a new user to get started with LocalStack quickly. -- [Use the LocalStack integrations]({{< ref "integrations" >}}) to interact with LocalStack and other integrated tools, for example: - - Use `awslocal` to use the AWS CLI against your local cloud! - - Use the Serverless Framework with LocalStack! - - And many more! -- [Find out how to configure LocalStack]({{< ref "configuration" >}}) such that it perfectly fits your need. -- [Use LocalStack in your CI environment]({{< ref "user-guide/ci" >}}) to increase your code quality. -- [Checkout LocalStack's Cloud Developer Tools]({{< ref "user-guide/tools" >}}) to further increase your development efficiency with LocalStack. -- Find out about the ways you can [configure LocalStack]({{< ref "configuration" >}}). diff --git a/content/en/references/api-key.md b/content/en/references/api-key.md index 6e5c99f5cc..f34ef3fae5 100644 --- a/content/en/references/api-key.md +++ b/content/en/references/api-key.md @@ -13,8 +13,10 @@ aliases: - LocalStack is transitioning from API Keys to Auth Tokens for activation. Auth Tokens streamline license management and remove the need for developers to adjust their setup when license changes occur. - For detailed information and guidance on migrating your LocalStack setup to Auth Tokens, please consult our [Auth Token documentation]({{< ref "auth-token" >}}). -- API Keys will remain functional for LocalStack Pro and Enterprise users until the next major release. - Following this release, LocalStack Pro and Enterprise will exclusively use Auth Tokens. +- API Keys will remain functional for LocalStack Pro and Enterprise users till early 2025 +- After the sunsetting period, legacy API and legacy CI keys will no longer activate or work with LocalStack. +- During the sunsetting period, the legacy service will experience scheduled downtimes. +- We strongly encourage users to transition to new Auth Tokens while minimizing impact for those who have not yet updated. {{< /callout >}} The LocalStack API key is a unique identifier to activate your LocalStack license needed to start LocalStack Pro. diff --git a/content/en/references/docker-images.md b/content/en/references/docker-images.md index c904e0f95d..4a34a8dd34 100644 --- a/content/en/references/docker-images.md +++ b/content/en/references/docker-images.md @@ -23,7 +23,7 @@ $ docker pull localstack/localstack:latest {{< / command >}} To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud). -The Community image is free to use and does not require any API key to run. +The Community image is free to use and does not require a license to run. The Community image can be used to run [local AWS services](https://docs.localstack.cloud/user-guide/aws/) with [integrations](https://docs.localstack.cloud/user-guide/integrations/) on your local machine or in your [continuous integration pipelines](https://docs.localstack.cloud/user-guide/ci/). The Community image also covers a limited set of [LocalStack Tools](https://docs.localstack.cloud/user-guide/tools/) to make your life as a cloud developer easier. @@ -42,8 +42,8 @@ To use the LocalStack Pro image, you can pull the image from Docker Hub: $ docker pull localstack/localstack-pro:latest {{< / command >}} -To use the LocalStack Pro image, you must configure an environment variable named `LOCALSTACK_AUTH_TOKEN` to contain your auth token. -The LocalStack Pro image will display a warning if you do not set an auth token (or if the license is invalid/expired) and will not activate the Pro features. +To use the LocalStack Pro image, you must configure an environment variable named `LOCALSTACK_AUTH_TOKEN` to contain your Auth Token. +The LocalStack Pro image will display a warning if you do not set an Auth Token (or if the license is invalid/expired) and will not activate the Pro features. LocalStack Pro gives you access to the complete set of LocalStack features, including the [LocalStack Web Application](https://app.localstack.cloud) and [dedicated customer support](https://docs.localstack.cloud/getting-started/help-and-support/#pro-support). You can use the Pro image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/). diff --git a/content/en/references/network-troubleshooting/transparent-endpoint-injection/_index.md b/content/en/references/network-troubleshooting/transparent-endpoint-injection/_index.md index 69b4c35af0..f4bfe17739 100644 --- a/content/en/references/network-troubleshooting/transparent-endpoint-injection/_index.md +++ b/content/en/references/network-troubleshooting/transparent-endpoint-injection/_index.md @@ -14,7 +14,7 @@ In such cases, there are different approaches you can take depending on your set {{< figure src="../images/2.svg" width="400" >}} -If you're using LocalStack with an [auth token]({{}}), then you can utilize the [DNS server]({{}}) to perform requests to LocalStack as if it were AWS. +If you're using LocalStack with an [Auth Token]({{}}), then you can utilize the [DNS server]({{}}) to perform requests to LocalStack as if it were AWS. You need to make two changes: * Publish port 53 from the LocalStack docker container to your host. diff --git a/content/en/references/usage-tracking.md b/content/en/references/usage-tracking.md index e525294463..e76d0ef9a5 100644 --- a/content/en/references/usage-tracking.md +++ b/content/en/references/usage-tracking.md @@ -23,7 +23,7 @@ Collecting basic anonymized usage of AWS services helps us better direct enginee The current usage event collection on the client side includes: - A randomly generated ID pertaining to the session -- The auth token or legacyAPI key (if any) +- The Auth Token or legacy API key (if any) - A randomly generated machine ID is kept throughout the session but deleted once the LocalStack cache directory is removed - The operating system (mostly Linux since LocalStack typically runs in our Debian container) - The LocalStack version being used @@ -88,7 +88,7 @@ For the community image, we only track service, operation, status code, and how ### CLI invocations We collect an anonymized event if a CLI command was invoked, but do not collect any of the parameter values. -This event is not connected to the session or the auth token. +This event is not connected to the session or the Auth Token. Here is an example of a CLI invocation event: diff --git a/content/en/tutorials/lambda-ecr-container-images/index.md b/content/en/tutorials/lambda-ecr-container-images/index.md index 66a1f2da59..1374fe0bbd 100644 --- a/content/en/tutorials/lambda-ecr-container-images/index.md +++ b/content/en/tutorials/lambda-ecr-container-images/index.md @@ -111,7 +111,7 @@ The resulting image will contain your function code and any specified dependenci Now that the initial setup is complete let's explore how to leverage LocalStack's AWS emulation by pushing our image to ECR and deploying the Lambda container image. Start LocalStack by executing the following command. -Make sure to replace `` with your actual auth token: +Make sure to replace `` with your actual Auth Token: {{< command >}} $ LOCALSTACK_AUTH_TOKEN= DEBUG=1 localstack start -d diff --git a/content/en/tutorials/using-terraform-with-testcontainers-and-localstack/index.md b/content/en/tutorials/using-terraform-with-testcontainers-and-localstack/index.md index 2ecec7cca5..45c813ef89 100644 --- a/content/en/tutorials/using-terraform-with-testcontainers-and-localstack/index.md +++ b/content/en/tutorials/using-terraform-with-testcontainers-and-localstack/index.md @@ -83,8 +83,8 @@ In the root folder of the demo project run: ```bash $ export LOCALSTACK_AUTH_TOKEN= -$ localstack start -e EXTENSION_AUTO_INSTALL=localstack-extension-terraform-init - -v ./terraform/main.tf:/etc/localstack/init/ready.d/main.tf +$ localstack start -e EXTENSION_AUTO_INSTALL=localstack-extension-terraform-init + -v ./terraform/main.tf:/etc/localstack/init/ready.d/main.tf -v ./target/product-lambda.jar:/etc/localstack/init/ready.d/target/product-lambda.jar ``` @@ -260,7 +260,7 @@ This configuration is abstracted in a superclass to be reusable across different Here's what each configuration line does: - **LAMBDA_REMOVE_CONTAINERS="1"**: Ensures that Lambda containers are removed after execution to free up resources and avoid clutter. - **EXTENSION_AUTO_INSTALL="localstack-extension-terraform-init"**: Automatically installs the Terraform init hooks extension. -- **LOCALSTACK_AUTH_TOKEN**: Fetches the LocalStack auth token from environment variables. +- **LOCALSTACK_AUTH_TOKEN**: Fetches the LocalStack Auth Token from environment variables. - **DEBUG="1"**: Enables verbose logging for troubleshooting and ensuring detailed logs are available for debugging. The `withFileSystemBind` commands mount the `product-lambda.jar` and the directory containing the Terraform files from the host machine into the appropriate init hook directory within the LocalStack container. diff --git a/content/en/user-guide/aws/cloudformation/index.md b/content/en/user-guide/aws/cloudformation/index.md index e384ff90b1..3141cedf94 100644 --- a/content/en/user-guide/aws/cloudformation/index.md +++ b/content/en/user-guide/aws/cloudformation/index.md @@ -6,13 +6,6 @@ persistence: supported with limitations --- -{{< callout >}} -With LocalStack 3.5 we've improved how the internal engine orders resources for deployment and deletion of stacks. -Specifically it now more accurately calculates dependencies between resources and doesn't try to deploy/delete resources which don't have their dependencies available yet. -Should you encounter any issues, please report them on [GitHub](https://github.com/localstack/localstack/issues/new/choose). -You can temporarily revert to the old behavior with `CFN_LEGACY_TEMPLATE_DEPLOYER=1`, but be aware that this is only a temporary option. -{{< /callout >}} - ## Introduction CloudFormation is a service provided by Amazon Web Services (AWS) that allows you to define and provision infrastructure as code. diff --git a/content/en/user-guide/aws/ec2/index.md b/content/en/user-guide/aws/ec2/index.md index 0bdd63cc43..74ece22047 100644 --- a/content/en/user-guide/aws/ec2/index.md +++ b/content/en/user-guide/aws/ec2/index.md @@ -468,13 +468,13 @@ This is often labelled as 'Virtualization Technology', 'VT-d' or 'VT-x' in UEFI/ If the Docker host and Libvirt host is the same, the Libvirt socket on the host must be mounted inside the LocalStack container. This can be done by including the volume mounts when the LocalStack container is started. -If you are using the [Docker Compose template]({{< ref "installation#starting-localstack-with-docker-compose" >}}), include the following line in `services.localstack.volumes` list: +If you are using the [Docker Compose template]({{< ref "getting-started/installation#docker-compose" >}}), include the following line in `services.localstack.volumes` list: ```text "/var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock" ``` -If you are using [Docker CLI]({{< ref "installation#starting-localstack-with-docker" >}}), include the following parameter in `docker run`: +If you are using [Docker CLI]({{< ref "getting-started/installation#docker" >}}), include the following parameter in `docker run`: ```text -v /var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock diff --git a/content/en/user-guide/aws/rds/index.md b/content/en/user-guide/aws/rds/index.md index 0e4ee51b0f..c8a95ff06b 100644 --- a/content/en/user-guide/aws/rds/index.md +++ b/content/en/user-guide/aws/rds/index.md @@ -171,7 +171,7 @@ For instance, the `storage-encrypted` flag is returned as configured, but active ### PostgreSQL Engine When you establish an RDS DB cluster or instance using the `postgres`/`aurora-postgresql` DB engine along with a specified `EngineVersion`, LocalStack will dynamically install and configure the corresponding PostgreSQL version as required. -Presently, you have the option to choose major versions ranging from 10 to 15. +Presently, you have the option to choose major versions ranging from 11 to 15. If you select a major version beyond this range, the system will automatically default to version 11. It's important to note that the selection of minor versions is not available. diff --git a/content/en/user-guide/ci/_index.md b/content/en/user-guide/ci/_index.md index fd382d6964..982a3e9e60 100644 --- a/content/en/user-guide/ci/_index.md +++ b/content/en/user-guide/ci/_index.md @@ -31,14 +31,14 @@ You can also pre-seed state into the local AWS services (e.g., DynamoDB entries After a successful test run, you can execute the more expensive AWS CodeBuild pipeline for deploying your application. You can enrich the test reports created by your testing framework with traces and analytics generated inside LocalStack. -## CI integrations - -The steps required for the integration differ slightly depending on your preferred CI platform. -Please refer to the relevant sections of the [CI keys settings page](https://app.localstack.cloud/workspace/ci-keys) in the [LocalStack Web app](https://app.localstack.cloud). - ## CI images -LocalStack Docker images can be used in your CI environment by adding a CI Key. +LocalStack Docker images can be used in your CI environment by adding a [CI Auth Token](https://app.localstack.cloud/workspace/auth-tokens). The images are available on [Docker Hub](https://hub.docker.com/r/localstack/localstack/tags), and comprehensive documentation is available on our [Docker images](https://docs.localstack.cloud/references/docker-images/) documentation. Community users can use the `localstack/localstack` image, while licensed users can use the `localstack/localstack-pro` image. For Big Data jobs that require services such as EMR, Athena, and Glue, we provide a mono-container that uses the `localstack/localstack-pro:2.0.2-bigdata` image, which bakes in the required dependencies, such as Hadoop, Hive, Presto, into the LocalStack image. + +## CI integrations + +The steps required for the integration differ slightly depending on your preferred CI provider. +Please refer to the relevant documentation below to configure LocalStack for your CI pipelines. diff --git a/content/en/user-guide/ci/bitbucket/index.md b/content/en/user-guide/ci/bitbucket/index.md index fa27546a49..c453d1fde0 100644 --- a/content/en/user-guide/ci/bitbucket/index.md +++ b/content/en/user-guide/ci/bitbucket/index.md @@ -53,18 +53,19 @@ pipelines: - awslocal s3 ls ``` -## Configuring a CI key +## Configuring a CI Auth Token -You can enable LocalStack Pro by using the `localstack/localstack-pro` image and adding your CI key to the project's environment variables. +You can enable LocalStack Pro by using the `localstack/localstack-pro` image and adding your CI Auth Token to the project's environment variables. The LocalStack container will automatically pick it up and activate the Pro features. -To add a CI key to your BitBucket Pipeline: +Go to the [CI Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) and copy your CI Auth Token. +To add a CI Auth Token to your BitBucket Pipeline: - Select a workspace from the BitBucket dashboard. - Select the **Settings** on the top navigation bar. - Select **Workspace settings** from the **Settings dropdown** menu. -- On left-hand menu, navigate to **Pipelines** and click on **Workspace variables**. -- Add a new variable with the name `LOCALSTACK_API_KEY` and the value of your CI key. +- On the left-hand menu, navigate to **Pipelines** and click on **Workspace variables**. +- Add a new variable with the name `LOCALSTACK_AUTH_TOKEN` and the value of your CI Auth Token. Navigate to your BitBucket Pipeline and add the following lines to the `bitbucket-pipelines.yaml` file: diff --git a/content/en/user-guide/ci/circle-ci/circleci-env-config.png b/content/en/user-guide/ci/circle-ci/circleci-env-config.png deleted file mode 100644 index d5b975059b..0000000000 Binary files a/content/en/user-guide/ci/circle-ci/circleci-env-config.png and /dev/null differ diff --git a/content/en/user-guide/ci/circle-ci/index.md b/content/en/user-guide/ci/circle-ci/index.md index 871e22ee43..1200bbe758 100644 --- a/content/en/user-guide/ci/circle-ci/index.md +++ b/content/en/user-guide/ci/circle-ci/index.md @@ -88,21 +88,19 @@ jobs: ... ``` -### Configuring a CI key +### Configuring a CI Auth Token -To enable LocalStack Pro+, you need to add your LocalStack CI key to the project's environment variables. +To enable LocalStack Pro+, you need to add your LocalStack CI Auth Token to the project's environment variables. The LocalStack container will automatically pick it up and activate the licensed features. -Go to the [CI Key Page](https://app.localstack.cloud/workspace/ci-keys) page and copy your CI key. -To add the CI key to your CircleCI project, follow these steps: +Go to the [CI Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) and copy your CI Auth Token. +To add the CI Auth Token to your CircleCI project, follow these steps: - Click on **Project Settings**. - Select **Environment Variables** from the left side menu. - Click **Add Environment Variable**. -- Name your environment variable `LOCALSTACK_API_KEY`. -- Paste your CI key into the input field. - -Adding the LocalStack CI key in CircleCI +- Name your environment variable `LOCALSTACK_AUTH_TOKEN`. +- Paste your CI Auth Token into the input field. After the above steps, just start up LocalStack using our official orb as usual. @@ -127,7 +125,7 @@ jobs: ### Store LocalStack state You can preserve your AWS infrastructure with LocalStack in various ways. -To be able to use any of the below samples, you must [set a valid CI key](#configuring-a-ci-key). +To be able to use any of the below samples, you must [set a valid CI Auth Token](#configuring-a-ci-auth-token). _Note: For best result we recommend to use a combination of the below techniques and you should familiarise yourself with CircleCI's data persistance approach, see their [official documentation](https://circleci.com/docs/persist-data/)._ diff --git a/content/en/user-guide/ci/codebuild/index.md b/content/en/user-guide/ci/codebuild/index.md index 1c4b228ea8..d4ddecc05b 100644 --- a/content/en/user-guide/ci/codebuild/index.md +++ b/content/en/user-guide/ci/codebuild/index.md @@ -88,17 +88,17 @@ phases: ... ``` -### Configuring a CI key +### Configuring a CI Auth Token -To enable LocalStack Pro features, you need to add your LocalStack CI API key to the project's environment variables. +To enable LocalStack Pro features, you need to add your LocalStack CI Auth Token to the project's environment variables. The LocalStack container will automatically pick it up and activate the licensed features. -Go to the [CI Key Page](https://app.localstack.cloud/workspace/ci-keys) page and copy your CI key. -To add the CI key to your CodeBuild project, follow these steps: +Go to the [CI Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) and copy your CI Auth Token. +To add the CI Auth Token to your CodeBuild project, follow these steps: - Navigate to your project dashboard, click **Edit** to open the dropdown, and select **Environment**. - Click on **Additional configuration** and navigate to the **Environment variables** section. -- Specify **Name** as `LOCALSTACK_API_KEY` and **Value** as your CI key. +- Specify **Name** as `LOCALSTACK_AUTH_TOKEN` and **Value** as your CI Auth Token. Specify **Type** as per your requirement. Click on **Update environment** to save your environment variables. diff --git a/content/en/user-guide/ci/github-actions/github-create-secret.png b/content/en/user-guide/ci/github-actions/github-create-secret.png deleted file mode 100644 index aedbf5f76c..0000000000 Binary files a/content/en/user-guide/ci/github-actions/github-create-secret.png and /dev/null differ diff --git a/content/en/user-guide/ci/github-actions/index.md b/content/en/user-guide/ci/github-actions/index.md index e857fc3e9e..8c5262065a 100644 --- a/content/en/user-guide/ci/github-actions/index.md +++ b/content/en/user-guide/ci/github-actions/index.md @@ -36,33 +36,29 @@ For example, to set the `DEBUG` configuration option, you can use the following You can add extra configuration options by separating them with a comma. -### Configure a CI key +### Configure a CI Auth Token -To enable LocalStack Pro+, you need to add your LocalStack CI API key to the project's environment variables. +To enable LocalStack Pro, you need to add your LocalStack CI Auth Token to the project's environment variables. The LocalStack container will automatically pick it up and activate the licensed features. -Go to the [CI Key Page](https://app.localstack.cloud/workspace/ci-keys) page and copy your CI key. -To add the CI key to your GitHub project, follow these steps: +Go to the [CI Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) and copy your CI Auth Token. +To add the CI Auth Token to your GitHub project, follow these steps: - Navigate to your repository **Settings > Secrets** and press **New repository secret**. -- Enter `LOCALSTACK_API_KEY` as the name of the secret and paste your CI key as the value. +- Enter `LOCALSTACK_AUTH_TOKEN` as the name of the secret and paste your CI Auth Token as the value. Click **Add secret** to save your secret. -Adding the LocalStack CI key as secret in GitHub -
-
- -Additionally, you need to modify your GitHub Action workflow to use the `localstack/localstack-pro` image and use the `LOCALSTACK_API_KEY` environment variable. +You can then use our [`setup-localstack`](https://github.com/localstack/setup-localstack) GitHub Action to start your LocalStack container, with the `LOCALSTACK_AUTH_TOKEN` environment variable: ```yaml - name: Start LocalStack - uses: LocalStack/setup-localstack@v0.2.2 + uses: LocalStack/setup-localstack@v0.2.3 with: image-tag: 'latest' install-awslocal: 'true' use-pro: 'true' env: - LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }} + LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }} ``` ### Dump Localstack logs @@ -156,7 +152,7 @@ Find out more about ephemeral instances [here](/user-guide/cloud-sandbox/). state-action: load state-name: my-ls-state env: - LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }} + LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }} ... @@ -168,7 +164,7 @@ Find out more about ephemeral instances [here](/user-guide/cloud-sandbox/). state-action: save state-name: my-ls-state env: - LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }} + LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }} ... ``` diff --git a/content/en/user-guide/ci/gitlab-ci/index.md b/content/en/user-guide/ci/gitlab-ci/index.md index 97402d0450..c7c9ad2650 100644 --- a/content/en/user-guide/ci/gitlab-ci/index.md +++ b/content/en/user-guide/ci/gitlab-ci/index.md @@ -75,20 +75,20 @@ job: - DOCKER_HOST="tcp://${dind_ip}:2375" localstack start -d ``` -### Configure a CI key +### Configure a CI Auth Token -You can easily enable LocalStack Pro by using the `localstack/localstack-pro` image and adding your CI key to the repository's environment variables. -Go to your project's **Settings > CI/CD** and expand the **Variables** section. -Select the **Add Variable** button and fill in the necessary details. -After you create a variable, you can use it in the `.gitlab-ci.yml` file. +You can easily enable LocalStack Pro by using the `localstack/localstack-pro` image and adding your [CI Auth Token](https://app.localstack.cloud/workspace/auth-tokens) to the repository's environment variables as `LOCALSTACK_AUTH_TOKEN`. +Go to your project's **Settings > CI/CD** and expand the **Variables** section. +Select the **Add Variable** button and fill in the necessary details with `LOCALSTACK_AUTH_TOKEN` as the key and your CI Auth Token as the value. +After you create the variable, you can use it in the `.gitlab-ci.yml` file. -However Variables set in the GitLab UI are not passed down to service containers. -We need to assign them to variables in the UI, and then re-assign them in our `.gitlab-ci.yml` +However, variables set in the GitLab UI are not automatically passed down to service containers. +You need to assign them as variables in the UI, and then re-assign them in your `.gitlab-ci.yml`. ```yaml ... variables: - LOCALSTACK_API_KEY: $LOCALSTACK_API_KEY + LOCALSTACK_AUTH_TOKEN: $LOCALSTACK_AUTH_TOKEN ... services: - name: localstack/localstack-pro:latest @@ -97,7 +97,7 @@ services: ``` You can check the logs of the LocalStack container to see if the activation was successful. -If the CI key activation fails, LocalStack container will exit with an error code. +If the CI Auth Token activation fails, LocalStack container will exit with an error code. ### Dump Localstack logs @@ -179,7 +179,7 @@ Find more information about cloud pods [here](/user-guide/state-management/cloud ```yaml ... variables: - LOCALSTACK_API_KEY: $LOCALSTACK_API_KEY + LOCALSTACK_AUTH_TOKEN: $LOCALSTACK_AUTH_TOKEN ... setup-job: stage: build diff --git a/content/en/user-guide/ci/travis-ci/index.md b/content/en/user-guide/ci/travis-ci/index.md index 8ee4bfe9b6..18136859ac 100644 --- a/content/en/user-guide/ci/travis-ci/index.md +++ b/content/en/user-guide/ci/travis-ci/index.md @@ -46,16 +46,14 @@ script: - echo "Execute your tests here :)" ``` -## Configuring a CI key +## Configuring a CI Auth Token -You can easily enable LocalStack Pro by using the `localstack/localstack-pro` image and adding your CI key to the project's environment variables. -The LocalStack CLI will automatically pick it up and activate the Pro features. +You can easily enable LocalStack Pro by using the `localstack/localstack-pro` image and adding your [CI Auth Token](https://app.localstack.cloud/workspace/auth-tokens) to the project's environment variables as `LOCALSTACK_AUTH_TOKEN`. +The LocalStack CLI will automatically detect it and activate the Pro features. -Just go to the project settings in Travis CI (`More options` β†’ `Settings`), scroll down to the `Environment Variables` section, and add your CI key: +To configure this in Travis CI, go to the project settings (`More options` β†’ `Settings`), scroll down to the `Environment Variables` section, and add your CI Auth Token as `LOCALSTACK_AUTH_TOKEN`. -![Adding the LocalStack CI key in Travis CI](travis-ci-env-config.png) - -Here is an example: +Here is an example workflow: ```yaml before_install: diff --git a/content/en/user-guide/ci/travis-ci/travis-ci-env-config.png b/content/en/user-guide/ci/travis-ci/travis-ci-env-config.png deleted file mode 100644 index d2b91d54a5..0000000000 Binary files a/content/en/user-guide/ci/travis-ci/travis-ci-env-config.png and /dev/null differ diff --git a/content/en/user-guide/cloud-sandbox/application-previews/index.md b/content/en/user-guide/cloud-sandbox/application-previews/index.md index 1b8f68d05b..4a34d4ffd4 100644 --- a/content/en/user-guide/cloud-sandbox/application-previews/index.md +++ b/content/en/user-guide/cloud-sandbox/application-previews/index.md @@ -40,7 +40,7 @@ A comment containing the preview link is automatically added to a Pull Request w This preview is available for 30 minutes ```yaml -uses: LocalStack/setup-localstack@v0.2.2 +uses: LocalStack/setup-localstack@v0.2.3 with: github-token: ${{ secrets.GITHUB_TOKEN }} state-backend: ephemeral diff --git a/content/en/user-guide/lambda-tools/debugging/index.md b/content/en/user-guide/lambda-tools/debugging/index.md index 1eaaa49af9..7c4d624d5d 100644 --- a/content/en/user-guide/lambda-tools/debugging/index.md +++ b/content/en/user-guide/lambda-tools/debugging/index.md @@ -23,6 +23,11 @@ More examples and tooling support for local Lambda debugging (including support * [Lambda Debug Mode (preview)](#lambda-debug-mode-preview) * [Resources](#resources) +{{< callout tip >}} +Due to the ports published by the Lambda container for the debugger, it is currently only possible to debug one Lambda function at a time. +For advanced debugging scenarios, such as those requiring multiple ports, refer to [Lambda Debug Mode (preview)]({{< relref "debugging#lambda-debug-mode-preview" >}}) section. +{{< /callout >}} + ## Debugging Python lambdas Lambda functions debugging used to be a difficult task. diff --git a/content/en/user-guide/localstack-enterprise/ci-analytics/index.md b/content/en/user-guide/localstack-enterprise/ci-analytics/index.md index ee48147b2a..63300f4438 100644 --- a/content/en/user-guide/localstack-enterprise/ci-analytics/index.md +++ b/content/en/user-guide/localstack-enterprise/ci-analytics/index.md @@ -96,7 +96,7 @@ jobs: steps: - name: Start LocalStack env: - LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }} + LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }} LS_CI_PROJECT: ls-platform-integration-tests run: | pip install localstack awscli-local[ver1] diff --git a/content/en/user-guide/localstack-enterprise/enterprise-support/index.md b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md index 335315d5f2..e4b1138e2a 100644 --- a/content/en/user-guide/localstack-enterprise/enterprise-support/index.md +++ b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md @@ -13,7 +13,7 @@ The key components of our enterprise support offering include: - **Direct Slack Connect Channel**: A dedicated Slack Connect channel is available to maintain a direct communication link with the LocalStack engineering team. This setup ensures quick issue resolution and streamlined collaboration, improving overall service efficiency. -- **Dedicated Customer Success Manager (CSM) and Solutions Architect (SA)**: Enterprise customers are assigned a CSM and SA. +- **Dedicated Customer Success Manager (CSM) and Technical Account Manager (TAM)**: Enterprise customers are assigned a CSM and SA. The CSM acts as a strategic advisor to help fully utilize LocalStack's offerings, while the SA provides expert technical assistance in designing and optimizing solutions tailored to your needs. - **Custom Service Level Agreements (SLAs)**: Tailor your service levels and response times to meet your organization's requirements. Custom SLAs can be negotiated to align with your business objectives and ensure optimal system performance. diff --git a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md index 423c55f897..6a2cafeb9a 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -32,7 +32,7 @@ spec: image: localstack/localstack-pro:3.5.0 debug: trace - authToken: "" # Set your LocalStack auth token here + authToken: "" # Set your LocalStack Auth Token here autoLoadPods: [""] # Set your Cloud Pods to automatically load them here (optional) dnsProvider: coredns diff --git a/content/en/user-guide/state-management/cloud-pods/index.md b/content/en/user-guide/state-management/cloud-pods/index.md index df1a2f44fb..cb4592a5cf 100644 --- a/content/en/user-guide/state-management/cloud-pods/index.md +++ b/content/en/user-guide/state-management/cloud-pods/index.md @@ -138,7 +138,7 @@ $ localstack pod versions s3-test ### Pull your Pod state -On a separate machine, start LocalStack while ensuring the auth token is properly configured. +On a separate machine, start LocalStack while ensuring the Auth Token is properly configured. Then, retrieve the previously created Cloud Pod by employing the `load` command, specifying the Cloud Pod name as the first argument: {{< command >}} @@ -592,7 +592,7 @@ However, state management might not yet work reliably for every service. ## Troubleshooting -### Unable to obtain auth token +### Unable to obtain Auth Token When you try to save a Cloud Pod and see the error in LocalStack logs like this: diff --git a/content/en/user-guide/web-application/ci-keys/ci-keys.png b/content/en/user-guide/web-application/ci-keys/ci-keys.png deleted file mode 100644 index 56e5124838..0000000000 Binary files a/content/en/user-guide/web-application/ci-keys/ci-keys.png and /dev/null differ diff --git a/content/en/user-guide/web-application/ci-keys/index.md b/content/en/user-guide/web-application/ci-keys/index.md index cf69759292..f365bf1f36 100644 --- a/content/en/user-guide/web-application/ci-keys/index.md +++ b/content/en/user-guide/web-application/ci-keys/index.md @@ -1,20 +1,35 @@ --- -title: "CI Keys" -linkTitle: "CI Keys" +title: "CI Keys (Deprecated)" +linkTitle: "CI Keys (Deprecated)" weight: 160 -description: A CI key is used to access LocalStack in CI or other machine environments. +description: A CI Key is used to access LocalStack in CI or other machine environments. aliases: - /user-guide/ci/ci-keys/ --- +{{< callout "warning">}} +LocalStack CI Keys are now deprecated, and the option to issue or retrieve a CI Key has been removed from the LocalStack Web Application. +Users are advised to switch to **CI Auth Tokens**, which are designed for use in CI environments and other non-developer contexts. +CI Auth Tokens can be managed on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens). + +To migrate to CI Auth Tokens, follow these steps: + +1. Retrieve your CI Auth Token from the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens). +2. Remove the existing CI key labeled as `LOCALSTACK_API_KEY` from your CI provider's secrets. +3. Enter the Auth Token value into the `LOCALSTACK_AUTH_TOKEN` environment variable of your CI provider. + +In early 2025, we will completely phase out legacy CI keys. +After the sunsetting period, legacy CI keys will no longer activate or function with LocalStack. +{{< /callout >}} + +## Introduction + LocalStack requires a **CI Key** for use in Continuous Integration (CI) or similar machine environments. Each instance startup in a CI or comparable environment consumes one CI token. CI Keys are administered on the [CI Keys page](https://app.localstack.cloud/workspace/ci-keys) of the LocalStack Web Application. These keys are linked to specific CI pipelines or projects, rather than individual developers. -A screenshot of the LocalStack web app. The screenshot shows the page to manage CI keys - CI Keys are not meant for individual developers. To grant a developer access to LocalStack and its advanced features, assign a license to them on the [Users & Licenses page](https://app.localstack.cloud/workspace/members). diff --git a/content/en/user-guide/web-application/users-licences/index.md b/content/en/user-guide/web-application/users-licences/index.md index afbd0f6c89..d7561b99ae 100644 --- a/content/en/user-guide/web-application/users-licences/index.md +++ b/content/en/user-guide/web-application/users-licences/index.md @@ -54,20 +54,16 @@ Changes to licenses take effect immediately and require no further action of the In the past, access to LocalStack and advanced features was granted to individual developers by providing them with a (now legacy) API key. With the recent change, now the recommended way is to assign a 'license' to a user instead. -Instead of using the legacy API key, the user sets up their personal auth token to access LocalStack advanced features. -Upon authentication, the the auth token is used to identify the user and to retrieve and activate an assigned license. +Instead of using the legacy API key, the user sets up their personal Auth Token to access LocalStack advanced features. +Upon authentication, the the Auth Token is used to identify the user and to retrieve and activate an assigned license. The benefits of this new systems are: - Auth tokens are longer and more secure (more bits of entropy) -- A user can freely rotate their auth token (if needed) without any changes to their license. +- A user can freely rotate their Auth Token (if needed) without any changes to their license. - An admin can manage users's licenses, not requiring any configuration change of the user. Previously users had to manually update their (legacy) API key. -{{< callout >}} -The transition to auth tokens only affects _developer_ API keys. **CI keys** are unaffected by this transition and are still the only way to activate a LocalStack instance for use in CI or other automated contexts. -{{< /callout >}} - ### Migrating Users to Auth Tokens and Licenses To migrate users from legacy API keys, assign a license to them in the 'Workspace Members' list. @@ -77,8 +73,8 @@ A user holding both a legacy API key and a license is only counted once when the If a user uses an API key that was not assigned to them, then it might be necessary to first remove the API key before a license can be assigned. -Once the license is assigned to the user, and the user set up their system to use the new auth token, their legacy API key can be deleted from the workspace. -A user can find their personal auth token either in the 'Auth Token' or in the 'Getting Started' section of the web app. +Once the license is assigned to the user, and the user set up their system to use the new Auth Token, their legacy API key can be deleted from the workspace. +A user can find their personal Auth Token either in the 'Auth Token' or in the 'Getting Started' section of the web app. ### Sunsetting legacy API keys