diff --git a/package-lock.json b/package-lock.json index d55d22ec..a54941cd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6562,9 +6562,9 @@ } }, "node_modules/prebuild-install/node_modules/tar-fs": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.2.tgz", - "integrity": "sha512-EsaAXwxmx8UB7FRKqeozqEPop69DXcmYwTQwXvyAPF352HJsPdkVhvTaDPYqfNgruveJIJy3TA2l+2zj8LJIJA==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.3.tgz", + "integrity": "sha512-090nwYJDmlhwFwEW3QQl+vaNnxsO2yVsd45eTKRBzSzu+hlb1w2K9inVq5b0ngXuLVqQ4ApvsUHHnu/zQNkWAg==", "license": "MIT", "dependencies": { "chownr": "^1.1.1", @@ -7505,9 +7505,9 @@ } }, "node_modules/tar-fs": { - "version": "3.0.8", - "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.0.8.tgz", - "integrity": "sha512-ZoROL70jptorGAlgAYiLoBLItEKw/fUxg9BSYK/dF/GAGYFJOJJJMvjPAKDJraCXFwadD456FCuvLWgfhMsPwg==", + "version": "3.0.9", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.0.9.tgz", + "integrity": "sha512-XF4w9Xp+ZQgifKakjZYmFdkLoSWd34VGKcsTCwlNWM7QG3ZbaxnTsaBwnjFZqHRf/rROxaR8rXnbtwdvaDI+lA==", "license": "MIT", "dependencies": { "pump": "^3.0.0", diff --git a/src/content/docs/aws/capabilities/chaos-engineering/chaos-api.md b/src/content/docs/aws/capabilities/chaos-engineering/chaos-api.md index 9ef84790..d988d03e 100644 --- a/src/content/docs/aws/capabilities/chaos-engineering/chaos-api.md +++ b/src/content/docs/aws/capabilities/chaos-engineering/chaos-api.md @@ -32,7 +32,7 @@ If you'd like to try it out, please [contact us](https://www.localstack.cloud/de The prerequisites for this guide are: -- LocalStack Pro with [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) & [LocalStack Auth Token](https://docs.localstack.cloud/getting-started/auth-token/) +- LocalStack Pro with [LocalStack CLI](/aws/getting-started/installation/) & [LocalStack Auth Token](/aws/getting-started/auth-token/) - [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) - [Python](https://www.python.org/downloads/) diff --git a/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md b/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md index 0a7f4e3e..523bfcc1 100644 --- a/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md +++ b/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md @@ -110,4 +110,4 @@ preview-cmd: | ## Examples -- [Creating ephemeral application previews with LocalStack and GitHub Actions](https://docs.localstack.cloud/tutorials/ephemeral-application-previews/) and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway) \ No newline at end of file +- [Creating ephemeral application previews with LocalStack and GitHub Actions](/aws/tutorials/ephemeral-application-previews/) and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway) \ No newline at end of file diff --git a/src/content/docs/aws/capabilities/cloud-sandbox/ephemeral-instances.md b/src/content/docs/aws/capabilities/cloud-sandbox/ephemeral-instances.md index 4332ec9f..ae82ce09 100644 --- a/src/content/docs/aws/capabilities/cloud-sandbox/ephemeral-instances.md +++ b/src/content/docs/aws/capabilities/cloud-sandbox/ephemeral-instances.md @@ -64,7 +64,7 @@ To query the list of S3 buckets in the Ephemeral Instance, run the following com aws --endpoint-url= s3 ls ``` -You can also use integrations, such as [CDK](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/), [SAM CLI](https://docs.localstack.cloud/user-guide/integrations/aws-sam/), and [Terraform](https://docs.localstack.cloud/user-guide/integrations/terraform/), to interact with the Ephemeral Instance. +You can also use integrations, such as [CDK](/aws/integrations/aws-native-tools/aws-cdk/), [SAM CLI](/aws/integrations/aws-native-tools/aws-sam/), and [Terraform](/aws/integrations/infrastructure-as-code/terraform/), to interact with the Ephemeral Instance. In these integrations, you can change the `AWS_ENDPOINT_URL` environment variable to the endpoint URL of the Ephemeral Instance. ### View the Logs of the Ephemeral Instance @@ -86,7 +86,7 @@ If you have created a Cloud Pod from an older version of LocalStack, you need to ## Ephemeral Instances CLI -The Ephemeral Instances CLI is included in the [LocalStack CLI installation](https://docs.localstack.cloud/getting-started/installation/#localstack-cli), so no additional installations are needed to start using it. +The Ephemeral Instances CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#installing-localstack-cli), so no additional installations are needed to start using it. If you're a licensed user, setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable is recommended to access all features of the Ephemeral Instances CLI. Access the Ephemeral Instances CLI by running the `localstack ephemeral` command from your terminal. diff --git a/src/content/docs/aws/capabilities/config/configuration.md b/src/content/docs/aws/capabilities/config/configuration.md index 36c07638..17346b7c 100644 --- a/src/content/docs/aws/capabilities/config/configuration.md +++ b/src/content/docs/aws/capabilities/config/configuration.md @@ -122,6 +122,18 @@ This section covers configuration options that are specific to certain AWS servi | - | - | - | | `PROVIDER_OVERRIDE_CLOUDWATCH` | `v1` | Use the old CloudWatch provider. | +### CodeBuild + +| Variable | Example Values | Description | +| - | - | - | +| `CODEBUILD_REMOVE_CONTAINERS` | `0`\|`1` (default) | Remove Docker containers associated with a CodeBuild build tasks after execution. Disabling this and dumping container logs might help with troubleshooting failing builds. | + +### CodePipeline + +| Variable | Example Values | Description | +| - | - | - | +| `CODEPIPELINE_GH_TOKEN` | | GitHub Personal Access Token to used by CodeConnections Source action to access private repositories on GitHub. | + ### DMS | Variable | Example Values | Description | @@ -224,6 +236,9 @@ Also see [OpenSearch configuration variables](#opensearch) which are used to man | `KINESIS_SHARD_LIMIT` | `100` (default), `Infinity` (to disable) | Integer value , causing the Kinesis API to start throwing exceptions to mimic the default shard limit. | | `KINESIS_ON_DEMAND_STREAM_COUNT_LIMIT` | `10` (default), `Infinity` (to disable) | Integer value , causing the Kinesis API to start throwing exceptions to mimic the default on demand stream count limit. | | `KINESIS_LATENCY` | `500` (default), `0` (to disable)| Integer value of milliseconds, causing the Kinesis API to delay returning a response in order to mimic latency from a live AWS call. | +| `KINESIS_MOCK_PROVIDER_ENGINE` | `node` (default) \| `scala` | String value of `node` (default) or `scala` that determines the underlying build of Kinesis Mock. | +| `KINESIS_MOCK_MAXIMUM_HEAP_SIZE` | `512m` (default) | JVM memory format string that sets the maximum memory size for the Kinesis Mock Scala server, corresponds to the JVM `-Xmx` flag. | +| `KINESIS_MOCK_INITIAL_HEAP_SIZE` | `256m` (default) | JVM memory format string that sets the initial memory size for the Kinesis Mock Scala server, corresponds to the JVM `-Xms` flag. | ### Lambda @@ -304,11 +319,12 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2 | Variable | Example Values | Description | | - | - | - | | `RDS_CLUSTER_ENDPOINT_HOST_ONLY` | `1` (default) \| `0` | Whether the cluster endpoint returns the host only (which is AWS parity). If set to `0` it will return `:`. | -| `RDS_PG_CUSTOM_VERSIONS` | `0` \| `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). | +| `RDS_PG_CUSTOM_VERSIONS` | `0` \| `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 15). | | `RDS_MYSQL_DOCKER` | `1` (default) \| `0` | Whether to disable MySQL engines (and use MariaDB instead). MySQL engine for cluster/instances will start in a new docker container. If you have troubles running MySQL in docker, you can disable the feature. | | `MYSQL_IMAGE` | `mysql:8.0` | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if `RDS_MYSQL_DOCKER` is enabled. | | `MSSQL_IMAGE` | `mcr.microsoft.com/mssql/server:2022-latest` | Defines a specific image that should be used when spinning up a SQL server engine. | | `MSSQL_ACCEPT_EULA` | `Y` | Set to `Y` if you accept the [EULA from MSSQL](https://hub.docker.com/_/microsoft-mssql-server). | +| `RDS_PG_MAX_CONNECTIONS` | `0` (default) | Sets the maximum number of connections for Postgres RDS instances. | ### S3 @@ -329,11 +345,17 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2 | - | - | - | | `SQS_DELAY_PURGE_RETRY` | `0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. | | `SQS_DELAY_RECENTLY_DELETED` | `0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. | -| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](https://docs.localstack.cloud/user-guide/aws/sqs/#enabling-messageretentionperiod) | -| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](https://docs.localstack.cloud/user-guide/aws/sqs/#queue-urls) | +| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](/aws/sqs/#enabling-messageretentionperiod) | +| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](/aws/sqs/#queue-urls) | | `SQS_DISABLE_CLOUDWATCH_METRICS` | `0` (default) | Disables the CloudWatch Metrics for SQS when set to `1` | | `SQS_CLOUDWATCH_METRICS_REPORT_INTERVAL` | `60` (default) | Configures the report interval (in seconds) for `Approximate*` metrics that are sent to CloudWatch periodically. Sending will be disabled if `SQS_DISABLE_CLOUDWATCH_METRICS=1` | +### Step Functions + +| Variable | Example Values | Description | +| - | - | - | +| `SFN_MOCK_CONFIG` | `/tmp/MockConfigFile.json` | Specifies the file path to the mock configuration file that defines mock service integrations for Step Functions. | + ## Security :::danger @@ -492,9 +514,9 @@ These configurations have already been removed and **won't have any effect** on | `DATA_DIR`| 2.0.0 | blank (disabled/default), `/tmp/localstack/data` | Local directory for saving persistent data. Use `PERSISTENCE` instead. | | `DISABLE_TERM_HANDLER` | 2.0.0 | `""` (default) \| `1` | Whether to disable signal passing to LocalStack when running in docker. Enabling this will prevent an orderly shutdown when running inside LS in docker. Setting this to anything else than an empty string will disable it. | `HOST_TMP_FOLDER` | 2.0.0 | `/some/path` | Temporary folder on the host that gets mounted as `$TMPDIR/localstack` into the LocalStack container. Required only for Lambda volume mounts when using `LAMBDA_REMOTE_DOCKER=false.` | -| `INIT_SCRIPTS_PATH` | 2.0.0 | `/some/path` | Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). | +| `INIT_SCRIPTS_PATH` | 2.0.0 | `/some/path` | Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system](/aws/capabilities/config/initialization-hooks/). | | `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem-layout). | -| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). | +| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](/aws/capabilities/config/initialization-hooks). | | `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) | | `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | | | `SYNCHRONOUS_API_GATEWAY_EVENTS` | 2.0.0 | `1` (default) \| `0` | Whether or not to handle API Gateway Lambda event sources as synchronous invocations. | diff --git a/src/content/docs/aws/capabilities/config/docker-images.md b/src/content/docs/aws/capabilities/config/docker-images.md index 49e92af9..c346eb56 100644 --- a/src/content/docs/aws/capabilities/config/docker-images.md +++ b/src/content/docs/aws/capabilities/config/docker-images.md @@ -21,12 +21,12 @@ docker pull localstack/localstack:latest 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 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 can be used to run [local AWS services](/aws/) with [integrations](/aws/integrations/) on your local machine or in your [continuous integration pipelines](/aws/integrations/continuous-integration/). -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. -You can use [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/) or [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/) to use LocalStack with a graphical user interface. +The Community image also covers a limited set of [LocalStack Tools](/aws/tooling/) to make your life as a cloud developer easier. +You can use [LocalStack Desktop](/aws/capabilities/web-app/localstack-desktop/) or [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension) to use LocalStack with a graphical user interface. -You can use the Community image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/). +You can use the Community image to start your LocalStack container using various [installation methods](/aws/getting-started/installation/). While configuring to run LocalStack with Docker or Docker Compose, run the `localstack/localstack` image with the appropriate tag you have pulled (if not `latest`). ## LocalStack Pro image @@ -41,9 +41,9 @@ docker pull localstack/localstack-pro:latest 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). +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](/aws/getting-started/help-support/#enterprise-support). -You can use the Pro image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/). +You can use the Pro image to start your LocalStack container using various [installation methods](/aws/getting-started/installation/). While configuring to run LocalStack with Docker or Docker Compose, run the `localstack/localstack-pro` image with the appropriate tag you have pulled (if not `latest`). :::note diff --git a/src/content/docs/aws/capabilities/config/internal-endpoints.md b/src/content/docs/aws/capabilities/config/internal-endpoints.md index eb211d99..1913b547 100644 --- a/src/content/docs/aws/capabilities/config/internal-endpoints.md +++ b/src/content/docs/aws/capabilities/config/internal-endpoints.md @@ -33,4 +33,4 @@ curl -v --request POST --header "Content-Type: application/json" --data '{"acti The API path for the AWS internal resources is `/_aws`. These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services. -For instance, `/aws/sqs/messages` conveniently access all messages withing a SQS queue, without deleting them. +For instance, `/aws/sqs/messages` conveniently access all messages within a SQS queue, without deleting them. diff --git a/src/content/docs/aws/capabilities/config/logging.md b/src/content/docs/aws/capabilities/config/logging.md index 843e2b99..9e690e57 100644 --- a/src/content/docs/aws/capabilities/config/logging.md +++ b/src/content/docs/aws/capabilities/config/logging.md @@ -63,5 +63,5 @@ With Docker/Docker-Compose, you can run `docker ps` to get the container ID of t To view the logs via a user interface, you can use the following options: -- [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/) -- [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/) +- [LocalStack Desktop](/aws/capabilities/web-app/localstack-desktop/) +- [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension/) diff --git a/src/content/docs/aws/capabilities/networking/internal-endpoints.md b/src/content/docs/aws/capabilities/networking/internal-endpoints.md index df008900..57552f77 100644 --- a/src/content/docs/aws/capabilities/networking/internal-endpoints.md +++ b/src/content/docs/aws/capabilities/networking/internal-endpoints.md @@ -35,4 +35,4 @@ $ curl -v --request POST --header "Content-Type: application/json" --data '{"ac The API path for the AWS internal resources is `/_aws`. These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services. -For instance, `/aws/sqs/messages` conveniently access all messages withing a SQS queue, without deleting them. +For instance, `/aws/sqs/messages` conveniently access all messages within a SQS queue, without deleting them. diff --git a/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md b/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md index a54d3e3b..afd4ff68 100644 --- a/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md +++ b/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md @@ -108,7 +108,7 @@ Make sure to use this only for local testing, and never in production. ## Current Limitations - The mechanism to disable certificate validation for these requests is not currently functional with Go Lambdas. - To work around this issue, you'll need to manually set your endpoint when creating your AWS SDK client, as detailed in our documentation on the [Go AWS SDK](https://docs.localstack.cloud/user-guide/integrations/sdks/go/). + To work around this issue, you'll need to manually set your endpoint when creating your AWS SDK client, as detailed in our documentation on the [Go AWS SDK](/aws/integrations/aws-sdks/go). ## Troubleshooting diff --git a/src/content/docs/aws/capabilities/state-management/cli-commands.md b/src/content/docs/aws/capabilities/state-management/cli-commands.md index da0ed03c..5c1a8a58 100644 --- a/src/content/docs/aws/capabilities/state-management/cli-commands.md +++ b/src/content/docs/aws/capabilities/state-management/cli-commands.md @@ -244,7 +244,7 @@ The CLI manual for the `version` command is as follows: The `remote` command group lets you manage custom Cloud Pod remotes, to enable alternative storage backends in addition to the default LocalStack managed platform. It offers 3 commands: `add`, `delete`, and `list`. -For more info about remote usage, check our [documentation](https://docs.localstack.cloud/user-guide/cloud-pods/remotes/). +For more info about remote usage, check our [documentation](/aws/capabilities/state-management/cloud-pods/#remotes). ```bash Usage: pod remote [OPTIONS] COMMAND [ARGS]... @@ -315,7 +315,7 @@ Usage: state [OPTIONS] COMMAND [ARGS]... The state command group allows you to interact with LocalStack's state backend. - Read more: https://docs.localstack.cloud/references/persistence-mechanism/#snapshot-based-persistence + Read more: https://docs.localstack.cloud/aws/capabilities/state-management/persistence/ Options: --help Show this message and exit. @@ -340,7 +340,7 @@ Usage: state export [OPTIONS] [DESTINATION] If you are looking for a managed solution to handle the state of your LocalStack container, please check out the Cloud Pods feature: - https://docs.localstack.cloud/user-guide/tools/cloud-pods/ + https://docs.localstack.cloud/aws/capabilities/state-management/cloud-pods/ Use the DESTINATION argument to specify an absolute path for the exported file or a filename in current working directory. diff --git a/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx b/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx index fbe05c23..60a8da19 100644 --- a/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx +++ b/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx @@ -26,7 +26,7 @@ You can save and load the persistent state of Cloud Pods, you can use the [Cloud LocalStack provides a remote storage backend that can be used to store the state of your running application and share it with your team members. You can interact with the Cloud Pods over the storage backend via the LocalStack Web Application. -Cloud Pods CLI is included in the [LocalStack CLI installation](https://docs.localstack.cloud/getting-started/installation/#localstack-cli), so there's no need for additional installations to begin using it. +Cloud Pods CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#installing-localstack-cli), so there's no need for additional installations to begin using it. If you're a licensed user, we suggest setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable. This enables you to access the complete range of LocalStack Cloud Pods features. @@ -197,7 +197,7 @@ localstack state inspect --format json } ``` -For comprehensive instructions, navigate to our [Command-Line Interface (CLI) Guide](/aws/capabilities/state-management/cli-commands). +For comprehensive instructions, navigate to our [Command-Line Interface (CLI) Guide](/aws/capabilities/state-management/cli-commands/). To access your Cloud Pods through the LocalStack Web Application, navigate to the [Cloud Pods browser](https://app.localstack.cloud/pods). :::note @@ -284,7 +284,7 @@ In addition to loading Cloud Pods through the Command-Line Interface (CLI) or th ### Environmental variables -To automatically load a Cloud Pod at startup, utilize the `AUTO_LOAD_POD` [configuration variable](https://docs.localstack.cloud/references/configuration/). +To automatically load a Cloud Pod at startup, utilize the `AUTO_LOAD_POD` [configuration variable](/aws/capabilities/config/configuration/). `AUTO_LOAD_POD` can accept multiple Cloud Pod names separated by commas. To autoload multiple Cloud Pods, such as `foo-pod` and `bar-pod`, use: `AUTO_LOAD_POD=foo-pod,bar-pod`. @@ -448,7 +448,7 @@ localstack pod list s3-storage-aws :::note Full S3 remotes support is available in the CLI from version 3.2.0. -If you experience any difficulties, update your [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#updating). +If you experience any difficulties, update your [LocalStack CLI](/aws/getting-started/installation/#updating-localstack-cli). ::: ### ORAS remote storage @@ -519,7 +519,7 @@ services: :::note The Auto Load from remote feature does not automatically configure the remote. This needs to be done with the `localstack pod remote add ...` command. -This commands creates a configuration file for the remote in the [LocalStack volume directory](https://docs.localstack.cloud/references/filesystem/#localstack-volume). +This commands creates a configuration file for the remote in the [LocalStack volume directory](/aws/capabilities/config/filesystem-layout/#localstack-volume-directory). ::: ## End-to-End Encryption (Enterprise) @@ -572,7 +572,7 @@ The process is the following: Unless explicitly specified, all Cloud Pods commands default to targeting the LocalStack Platform as the storage remote. It's important to note that the CLI must be authenticated correctly with our Platform. -Custom remote configurations are stored within the [LocalStack volume directory](https://docs.localstack.cloud/references/filesystem/#localstack-volume-directory) and are managed by the LocalStack container. +Custom remote configurations are stored within the [LocalStack volume directory](/aws/capabilities/config/filesystem-layout/#localstack-volume-directory) and are managed by the LocalStack container. Consequently, when sharing Cloud Pods among your team using a custom remote, each team member must define the identical remote configuration. Once added, a remote persists even after LocalStack restarts. @@ -710,4 +710,34 @@ An error occurred while checking remote management for pod "cloud-pod-product-ap Check if your machine's clock is set incorrectly or if the certificate store is outdated. This error can also occur if you use `localstack` as `LOCALSTACK_HOST`. -In this case, the DNS incorrectly resolves `api.localstack.cloud` to `localhost`, causing a certificate mismatch. \ No newline at end of file +In this case, the DNS incorrectly resolves `api.localstack.cloud` to `localhost`, causing a certificate mismatch. + +### `InvalidAccessKeyId` during `CreateBucket` API call + +You may see this error: + +```bash +An error occurred (InvalidAccessKeyId) when calling the CreateBucket operation: The AWS Access Key Id you provided does not exist in our records. +``` + +This usually means you're using temporary AWS credentials, but `AWS_SESSION_TOKEN` is missing from the environment. + +To fix this, ensure that you export the `AWS_SESSION_TOKEN` environment variable: + +```bash +export AWS_SESSION_TOKEN=... +``` + +Then, add `session_token` to the `pod remote add` URL: + +```bash +localstack pod remote add s3-storage-aws 's3://ls-pods-bucket-test/?access_key_id={access_key_id}&secret_access_key={secret_access_key}&session_token={session_token}' +``` + +If you're still unable to connect to the S3 bucket, add the bucket hostname to the upstream DNS resolution list: + +```bash +DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM=ls-pods-bucket-test.s3.amazonaws.com/ +``` + +For more details, see the [Skip LocalStack DNS Resolution](/aws/tooling/dns-server/#skip-localstack-dns-resolution) section. \ No newline at end of file diff --git a/src/content/docs/aws/capabilities/web-app/accounts.md b/src/content/docs/aws/capabilities/web-app/accounts.md index bef1cdf4..0d1983b2 100644 --- a/src/content/docs/aws/capabilities/web-app/accounts.md +++ b/src/content/docs/aws/capabilities/web-app/accounts.md @@ -24,20 +24,13 @@ This token is used to authenticate your requests to the LocalStack platform and ## Creating an Account -You can either: +To create an account for LocalStack for AWS, please visit our [pricing page](https://www.localstack.cloud/pricing) and click on "Get Started for Free". -- Sign up with GitHub, or -- Enter your email address and follow the prompts. +Follow the prompts to fill out your information and remember to verify your email to continue. -After submitting your email: +All new users are granted a 14-day free Trial of our Ultimate tier with no commitment. -1. Select whether you're working on **commercial** or **personal** projects. -2. Fill in your first and last name. -3. (**Optional**) Add company, job title, and GitHub username. -4. Agree to the terms and conditions to continue. - -A verification link will be sent to your email. -Once verified, you can log in using your email or GitHub account. +At the end of your free trial period, you may select your preferred plan. > Terms: [localstack.cloud/legal/tos](https://www.localstack.cloud/legal/tos) > Privacy Policy: [localstack.cloud/legal/privacy-policy](https://www.localstack.cloud/legal/privacy-policy) diff --git a/src/content/docs/aws/capabilities/web-app/instance-management.md b/src/content/docs/aws/capabilities/web-app/instance-management.md index 71a8532c..48a39369 100644 --- a/src/content/docs/aws/capabilities/web-app/instance-management.md +++ b/src/content/docs/aws/capabilities/web-app/instance-management.md @@ -49,6 +49,6 @@ Tools like [simpleproxy](https://manpages.ubuntu.com/manpages/trusty/man1/simple Alternatively, you can direct `localhost.localstack.cloud` to your target machine's IP address by modifying the `/etc/hosts` file, which is useful if you’re using the LocalStack Web UI on a macOS or Linux-based machine. :::note -To bind to a custom IP address and port, configure the ['GATEWAY_LISTEN' configuration variable](https://docs.localstack.cloud/references/configuration/#core). -For troubleshooting, refer to the [network troubleshooting guide](https://docs.localstack.cloud/references/network-troubleshooting/). +To bind to a custom IP address and port, configure the ['GATEWAY_LISTEN' configuration variable](/aws/capabilities/config/configuration/#core). +For troubleshooting, refer to the [network troubleshooting docs](/aws/capabilities/networking/). ::: \ No newline at end of file diff --git a/src/content/docs/aws/capabilities/web-app/resource-browser.md b/src/content/docs/aws/capabilities/web-app/resource-browser.md index 8a28bf13..e3417ef9 100644 --- a/src/content/docs/aws/capabilities/web-app/resource-browser.md +++ b/src/content/docs/aws/capabilities/web-app/resource-browser.md @@ -15,7 +15,7 @@ It provides an internal, integrated experience, similar to the AWS Management Co The Resource Browser provide an experience similar to the AWS Management Console. However, the Resource Browser is not a replacement for the AWS Management Console and only replicate some of the features of the AWS Management Console. -We recommend using our [integrations](https://docs.localstack.cloud/user-guide/integrations/) to create your resources, with the Resource Browser being used for quick viewing and management of your resources. +We recommend using our [integrations](/aws/integrations/) to create your resources, with the Resource Browser being used for quick viewing and management of your resources. The LocalStack Web Application connects to your LocalStack container and retrieves the information about your local resources directly via `localhost` without using the internet. None of the information is sent to the internet, or stored on any external servers maintained by LocalStack. diff --git a/src/content/docs/aws/getting-started/auth-token.mdx b/src/content/docs/aws/getting-started/auth-token.mdx index 2176a028..73f28076 100644 --- a/src/content/docs/aws/getting-started/auth-token.mdx +++ b/src/content/docs/aws/getting-started/auth-token.mdx @@ -97,7 +97,7 @@ You have the option to run your LocalStack container in the background by append The `localstack` CLI automatically detects the Auth Token and appropriately conveys it to the LocalStack container. :::note -If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image), which includes Pro services and several advanced features. +If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](aws/capabilities/config/docker-images/#localstack-pro-image), which includes Pro services and several advanced features. ::: ### Docker @@ -113,7 +113,7 @@ $ docker run \ localstack/localstack-pro ``` -For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide. +For more information about starting LocalStack with Docker, take a look at our [Docker installation](aws/getting-started/installation/#docker) guide. ### Docker Compose @@ -134,7 +134,7 @@ 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/). +You can find detailed examples in our [LocalStack in CI documentation](/aws/integrations/continuous-integration/). ## Rotating the Auth Token @@ -150,7 +150,7 @@ To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cl ## 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. +Refer to our [configuration guide](/aws/capabilities/config/configuration/#localstack-pro) for more information. The simplest method to verify if LocalStack is active is by querying the health endpoint for a list of running services: diff --git a/src/content/docs/aws/getting-started/faq.mdx b/src/content/docs/aws/getting-started/faq.mdx index ab0da931..b462a750 100644 --- a/src/content/docs/aws/getting-started/faq.mdx +++ b/src/content/docs/aws/getting-started/faq.mdx @@ -17,7 +17,7 @@ To resolve the issue follow the steps: This can be done by deleting the cached certificate file. For example, on Linux systems, you can locate and remove the file at `~/.cache/localstack/volume/cache/server.test.pem`. The exact path may differ depending on your operating system and how you’ve started LocalStack. - Please refer to our [documentation](https://docs.localstack.cloud/references/filesystem/#localstack-volume) for specific instructions. + Please refer to our [documentation](/aws/capabilities/config/filesystem-layout/#localstack-volume-directory) for specific instructions. **Workarounds for older (<v3.7.0) LocalStack versions:** diff --git a/src/content/docs/aws/getting-started/help-support.md b/src/content/docs/aws/getting-started/help-support.md index 0ba86ad8..6ec985d4 100644 --- a/src/content/docs/aws/getting-started/help-support.md +++ b/src/content/docs/aws/getting-started/help-support.md @@ -29,14 +29,22 @@ At the moment, we only provide support in `English`, as we are an international ## Support Coverage -| Plan | Tier | -|---------------------|----------------------------------------------------------| -| Community Edition | [Basic Support](#basic-support) | -| Hobby Subscription | [Basic Support](#basic-support) | -| Trial Subscription | [Standard Support](#standard-support) | -| Starter Subscription | [Standard Support](#standard-support) | -| Team Subscription | [Priority Support](#priority-support) | -| Enterprise Subscription | [Enterprise Support](#enterprise-support) | +| Plan | Tier | +| ---------- | ------------------------------------------------------------------------------- | +| Free | [**Basic Support**](/aws/getting-started/help-support/#basic-support) | +| Trial | [**Standard Support**](/aws/getting-started/help-support/#standard-support) | +| Base | [**Standard Support**](/aws/getting-started/help-support/#standard-support) | +| Ultimate | [**Priority Support**](/aws/getting-started/help-support/#priority-support) | +| Enterprise | [**Enterprise Support**](/aws/getting-started/help-support/#enterprise-support) | + +## Support Coverage for legacy plans + +| Plan | Tier | +| ---------- | ------------------------------------------------------------------------------- | +| Hobby | [**Basic Support**](/aws/getting-started/help-support/#basic-support) | +| Starter | [**Standard Support**](/aws/getting-started/help-support/#standard-support) | +| Teams | [**Priority Support**](/aws/getting-started/help-support//#priority-support) | +| Enterprise | [**Enterprise Support**](/aws/getting-started/help-support/#enterprise-support) | ## Support features @@ -189,11 +197,10 @@ To learn more about the support available to **Enterprise** plan users, refer to ## Support Business Hours -Our support team operates in the CET timezone, Monday to Friday, from 8 AM to 4 PM, excluding the following holidays: +Our support team operates in the CET and ET timezone, Monday to Friday, from 6 AM to 9 PM UTC, excluding the following holidays: - January 1st, - May 1st, -- August 15th, - November 1st, - December 24th, 25th and 31st @@ -215,8 +222,8 @@ To use LocalStack's diagnostics endpoint: - Set the environment variable `LS_LOG=trace` - Start LocalStack - Run the affected task(s) -- Call the diagnostic endpoint `curl -s localhost:4566/_localstack/diagnose | gzip -cf > diagnose.json.gz` (Endpoint URL depends on your configuration) -- Send the output file to our Slack chat +- Call the diagnostic endpoint `curl -s localhost:4566/_localstack/diagnose > diagnose.json && zip diagnose.zip diagnose.json && rm diagnose.json` (Endpoint URL depends on your configuration) +- Once you have the `diagnose.zip` file, please send it to our support team via our email support@localstack.cloud, or via your existing support ticket. ::: :::danger diff --git a/src/content/docs/aws/getting-started/index.md b/src/content/docs/aws/getting-started/index.md index cb6156bf..6c1859b9 100644 --- a/src/content/docs/aws/getting-started/index.md +++ b/src/content/docs/aws/getting-started/index.md @@ -11,10 +11,12 @@ With LocalStack, you can run your AWS applications or Lambdas entirely on your l Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow. -LocalStack supports a growing number of [AWS services]({{< ref "aws" >}}), like AWS [Lambda]({{< ref "user-guide/aws/lambda" >}}), [S3]({{< ref "user-guide/aws/s3" >}}), [DynamoDB]({{< ref "user-guide/aws/dynamodb" >}}), [Kinesis]({{< ref "user-guide/aws/kinesis" >}}), [SQS]({{< ref "user-guide/aws/sqs" >}}), [SNS]({{< ref "user-guide/aws/sns" >}}), and more! +LocalStack supports a growing number of [AWS services](/aws/) +, like AWS [Lambda](/aws/lambda), [S3](/aws/s3), [DynamoDB](/aws/dynamodb), [Kinesis](/aws/kinesis), [SQS](/aws/sqs), [SNS](/aws/sns), and more! [LocalStack Pro](https://localstack.cloud/pricing) supports additional APIs and advanced features to make your cloud development experience a breeze! -You can find a comprehensive list of supported APIs on our [Feature Coverage]({{< ref "references/coverage" >}}) page. +You can find a comprehensive list of supported APIs on each AWS service page. LocalStack also provides additional features to make your life as a cloud developer easier! + Check out LocalStack's [Cloud Developer Tools](/aws/tooling/). diff --git a/src/content/docs/aws/getting-started/installation.mdx b/src/content/docs/aws/getting-started/installation.mdx index 84f7dd6c..60114692 100644 --- a/src/content/docs/aws/getting-started/installation.mdx +++ b/src/content/docs/aws/getting-started/installation.mdx @@ -431,7 +431,7 @@ python3 -m localstack.cli.main #### The `localstack` CLI does not start the LocalStack container If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following: -- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](https://docs.localstack.cloud/user-guide/tools/dns-server/#system-dns-configuration) to disable it. +- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](aws/tooling/dns-server/#system-dns-configuration) to disable it. - Start LocalStack with a specific DNS address: ```bash DNS_ADDRESS=0 localstack start diff --git a/src/content/docs/aws/getting-started/quickstart.mdx b/src/content/docs/aws/getting-started/quickstart.mdx index 8b761dfe..d88e6e42 100644 --- a/src/content/docs/aws/getting-started/quickstart.mdx +++ b/src/content/docs/aws/getting-started/quickstart.mdx @@ -38,7 +38,7 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur ## Prerequisites -- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) +- [LocalStack CLI](/aws/getting-started/installation/#installing-localstack-cli) - [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/) - [Docker](https://docs.docker.com/get-docker/) - [Python 3.11+](https://www.python.org/downloads/) & `pip` @@ -104,7 +104,7 @@ pyenv global 3.11 ### Setup the serverless image resizer -This application enables serverless image resizing using [S3](https://docs.localstack.cloud/user-guide/aws/s3/), [SSM](https://docs.localstack.cloud/user-guide/aws/ssm/), [Lambda](https://docs.localstack.cloud/user-guide/aws/lambda/), [SNS](https://docs.localstack.cloud/user-guide/aws/sns/), and [SES](https://docs.localstack.cloud/user-guide/aws/ses/). +This application enables serverless image resizing using [S3](/aws/services/s3/), [SSM](/aws/services/ssm/), [Lambda](/aws/services/lambda/), [SNS](aws/services/sns/), and [SES](/aws/services/ses/). A simple web interface allows users to upload and view resized images. A Lambda function generates S3 pre-signed URLs for direct uploads, while S3 bucket notifications trigger image resizing. Another Lambda function lists and provides pre-signed URLs for browser display. @@ -127,7 +127,7 @@ deployment/awslocal/deploy.sh Alternatively, you can follow these instructions to deploy the sample application manually step-by-step. :::tip -In absence of the `awslocal` wrapper, you can use the `aws` CLI directly, by configuring an [endpoint URL](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-an-endpoint-url) or a [custom profile](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-a-custom-profile) like `localstack`. +In absence of the `awslocal` wrapper, you can use the `aws` CLI directly, by configuring an [endpoint URL](/aws/integrations/aws-native-tools/aws-cli/#configuring-an-endpoint-url) or a [custom profile](/aws/integrations/aws-native-tools/aws-cli/#configuring-a-custom-profile) like `localstack`. You can then swap `awslocal` with `aws --endpoint-url=http://localhost:4566` or `aws --profile=localstack` in the commands below. ::: diff --git a/src/content/docs/aws/tooling/aws-replicator.mdx b/src/content/docs/aws/tooling/aws-replicator.mdx index efe5cf1e..73b9da31 100644 --- a/src/content/docs/aws/tooling/aws-replicator.mdx +++ b/src/content/docs/aws/tooling/aws-replicator.mdx @@ -29,7 +29,7 @@ A valid `LOCALSTACK_AUTH_TOKEN` must be configured to start the LocalStack Pro i :::note The Replicator is in limited preview and is available from LocalStack CLI version 4.2.0. -If you encounter issues, update your [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#updating). +If you encounter issues, update your [LocalStack CLI](/aws/getting-started/installation/#updating-localstack-cli). ::: ### Retrieve credentials to access AWS @@ -72,7 +72,7 @@ Both methods have two steps: #### Using the LocalStack CLI The Replicator CLI is part of the LocalStack CLI. -Follow the [installation instructions](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) to set it up. +Follow the [installation instructions](/aws/getting-started/installation/#installing-localstack-cli) to set it up. To start a replication job, get the ARN of the resource to replicate. Then, trigger the job using the command: diff --git a/src/content/docs/aws/tooling/event-studio.md b/src/content/docs/aws/tooling/event-studio.md index f2b72262..534fff36 100644 --- a/src/content/docs/aws/tooling/event-studio.md +++ b/src/content/docs/aws/tooling/event-studio.md @@ -88,9 +88,9 @@ This is essential for effectively debugging complex event-driven architectures. The following services are supported on Event Studio: -- [S3](https://docs.localstack.cloud/user-guide/aws/s3/) -- [SQS](https://docs.localstack.cloud/user-guide/aws/sqs/) -- [SNS](https://docs.localstack.cloud/user-guide/aws/sns/) -- [DynamoDB](https://docs.localstack.cloud/user-guide/aws/dynamodb/) -- [Lambda](https://docs.localstack.cloud/user-guide/aws/lambda/) -- [EventBridge](https://docs.localstack.cloud/user-guide/aws/events/) +- [S3](/aws/services/s3) +- [SQS](/aws/services/sqs/) +- [SNS](/aws/services/sns/) +- [DynamoDB](/aws/services/dynamodb/) +- [Lambda](/aws/services/lambda/) +- [EventBridge](/aws/services//events/) diff --git a/src/content/docs/aws/tooling/lambda-tools/vscode-extension.md b/src/content/docs/aws/tooling/lambda-tools/vscode-extension.md index e4f6f6f8..7c278e45 100644 --- a/src/content/docs/aws/tooling/lambda-tools/vscode-extension.md +++ b/src/content/docs/aws/tooling/lambda-tools/vscode-extension.md @@ -14,7 +14,7 @@ sidebar: - [VS Code](https://code.visualstudio.com/) - [`samlocal`](https://github.com/localstack/aws-sam-cli-local) command line wrapper around the [AWS SAM CLI](https://github.com/aws/aws-sam-cli) for use with [LocalStack](https://github.com/localstack/localstack). -- [LocalStack](https://docs.localstack.cloud/getting-started/) running in the background. +- [LocalStack](/aws/getting-started/) running in the background. ## Getting Started @@ -22,11 +22,11 @@ You can use a [sample project](https://github.com/joe4dev/lambda-python) to get The sample project contains a simple Lambda function and a SAM template. Clone the repository and open the project in VSCode. -{{< command >}} -$ git clone https://github.com/joe4dev/lambda-python.git -$ cd lambda-python -$ code . -{{< /command >}} +```bash +git clone https://github.com/joe4dev/lambda-python.git +cd lambda-python +code . +``` Install the [LocalStack VSCode Extension](https://marketplace.visualstudio.com/items?itemName=localstack.localstack) as recommended by the project.