From 272f79665b4db9028bc7f99fe7c80f5aa0ebe30b Mon Sep 17 00:00:00 2001 From: Simon Wallner Date: Mon, 11 Nov 2024 14:04:10 +0000 Subject: [PATCH] unify casing --- .../en/getting-started/auth-token/index.md | 28 +++++++++---------- content/en/references/docker-images.md | 4 +-- .../transparent-endpoint-injection/_index.md | 2 +- content/en/references/usage-tracking.md | 4 +-- .../lambda-ecr-container-images/index.md | 2 +- .../index.md | 6 ++-- .../k8s-operator/index.md | 2 +- .../state-management/cloud-pods/index.md | 4 +-- .../web-application/users-licences/index.md | 10 +++---- 9 files changed, 31 insertions(+), 31 deletions(-) diff --git a/content/en/getting-started/auth-token/index.md b/content/en/getting-started/auth-token/index.md index 1044166bab..88f432a00a 100644 --- a/content/en/getting-started/auth-token/index.md +++ b/content/en/getting-started/auth-token/index.md @@ -2,23 +2,23 @@ title: "Auth Token" weight: 20 description: > - Configure your auth token to access and activate LocalStack. + Configure your Auth Token to access and activate LocalStack. --- ### Introduction Auth tokens allow you to activate the LocalStack emulator and are also used access your workspace and additional services like Cloud Pods. Auth tokens exist in 2 varieties. -A **personal developer auth token** and a **CI auth token:** +A **personal developer Auth Token** and a **CI Auth Token:** -- The **developer auth token** is closely associated with a specific user in a specific workspace. - Every user has an auth token. +- The **developer Auth Token** is closely associated with a specific user in a specific workspace. + Every user has an Auth Token. It can not be deleted, but it can be rotated for security purposes if required. It can be found on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) -- The **CI auth token** is not tied to a specific user and is intended for use in CI environments and other non developer related contexts. - CI auth tokens live in the workspace, and can be managed by members with the necessary permissions. - CI auth tokens can also be managed on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) +- The **CI Auth Token** is not tied to a specific user and is intended for use in CI environments and other non developer related contexts. + CI Auth Tokens live in the workspace, and can be managed by members with the necessary permissions. + CI Auth Tokens can also 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. @@ -29,10 +29,10 @@ A **personal developer auth token** and a **CI auth token:** ## Activating LocalStack -To activate LocalStack Pro and to access additional services, simply set the auth token in the `LOCALSTACK_AUTH_TOKEN` environment variable. +To activate LocalStack Pro and to access additional services, simply set the Auth Token in the `LOCALSTACK_AUTH_TOKEN` environment variable. This will make it also available to Docker/Docker Compose setups. -If you are only starting the LocalStack instance via the LocalStack CLI with `localstack start` then you can configure the auth token with `localstack auth set-token `. +If you are only starting the LocalStack instance via the LocalStack CLI with `localstack start` then you can configure the Auth Token with `localstack auth set-token `. ### Managing your License @@ -45,14 +45,14 @@ After starting your trial or subscribing to a plan, you can manage the license a ## Configuring CI environments -CI environments are also configured the same way but **require the use of a CI auth token**. A developer auth token can not be used in CI. -CI auth tokens can also be found on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) page and are configured similarly to develop auth tokens. +CI environments are also configured the same way but **require the use of a CI Auth Token**. A developer Auth Token can not be used in CI. +CI Auth Tokens can also be found on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) page and are configured similarly to develop Auth Tokens. ## Activating older versions of localstack ( < v3.0) -Before auth tokens were introduced, _API keys_ and the `LOCALSTACK_API_KEY` environment variable were used. +Before Auth Tokens were introduced, _API keys_ and the `LOCALSTACK_API_KEY` environment variable were used. -To allow backwards compatibility with the new auth tokens, we updated our back-end so that a new auth token can be used inside the `LOCALSTACK_API_KEY` variable. Just use the new auth token and configure it as you did with the API key in the past. +To allow backwards compatibility with the new Auth Tokens, we updated our back-end so that a new Auth Token can be used inside the `LOCALSTACK_API_KEY` variable. Just use the new Auth Token and configure it as you did with the API key in the past. ### Sunsetting legacy API keys (early 2025) @@ -62,6 +62,6 @@ After the sunsetting period, it will not be able to activate and use legacy API During the sunsetting period, the legacy service will undergo scheduled downtimes. This schedule will be designed to encourage the transition, but to limit the impact on users if they were not able to update yet. -The schedule will be communicated in advance, giving users enough time to make the switch to the new auth tokens. +The schedule will be communicated in advance, giving users enough time to make the switch to the new Auth Tokens. diff --git a/content/en/references/docker-images.md b/content/en/references/docker-images.md index 085199c1a8..4a34a8dd34 100644 --- a/content/en/references/docker-images.md +++ b/content/en/references/docker-images.md @@ -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..f8ec0b0f75 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 legacyAPI 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/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/users-licences/index.md b/content/en/user-guide/web-application/users-licences/index.md index d888534cfe..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,13 +54,13 @@ 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. @@ -73,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