diff --git a/README.md b/README.md index 06575161de..462f62160d 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,14 @@ Please follow these best practices when writing documentation in this repository If needed, you can also [highlight a specific line](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences). - **Internal links:** Use the [`ref` or `relref` shortcode](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) when creating non-external links (but still use the markdown native image linking, ref doesn't work there). You can either use `ref` or `relref`, the point is to have compile time internal-link checks (which works for both). + + ```text + # Do this + Configuration options are [here]({{< ref "/references/configuration" >}}) + + # Don't do this + Configuration options are [here](https://docs.localstack.cloud/references/configuration/) + ``` - **Code snippets:** For snippets, make sure you indicate the programming/markup language so that proper syntax highlighting is used. Use `bash` only for Bash scripts, and use `text` for shell outputs or command examples. The full list of the supported languages [here](https://gohugo.io/content-management/syntax-highlighting/). diff --git a/content/en/getting-started/auth-token/index.md b/content/en/getting-started/auth-token/index.md index 0a4a108383..00b35de74c 100644 --- a/content/en/getting-started/auth-token/index.md +++ b/content/en/getting-started/auth-token/index.md @@ -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. {{< callout "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]({{< ref "/references/docker-images/#localstack-pro-image" >}}), which includes Pro services and several advanced features. {{< /callout >}} ### Docker @@ -113,7 +113,7 @@ $ docker run \ localstack/localstack-pro {{< / command >}} -For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide. +For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "/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]({{< ref "/user-guide/ci/" >}}). ## 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]({{< ref "/references/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/content/en/getting-started/faq.md b/content/en/getting-started/faq.md index f0e9ea6499..c1e158b63b 100644 --- a/content/en/getting-started/faq.md +++ b/content/en/getting-started/faq.md @@ -18,7 +18,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]({{< ref "filesystem/#localstack-volume" >}}) for specific instructions. **Workarounds for older (}}) | +| Trial | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}}) | +| Base | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}}) | +| Ultimate | [**Priority Support**]({{< ref "/getting-started/help-and-support/#priority-support" >}}) | +| Enterprise | [**Enterprise Support**]({{< ref "/getting-started/help-and-support/#enterprise-support" >}}) | ## Support Coverage for legacy plans -| Plan | Tier | -| ---------- | ------------------------------------------------------------------------------------------------------------ | -| Hobby | [**Basic Support**](https://docs.localstack.cloud/getting-started/help-and-support/#basic-support) | -| Starter | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support) | -| Teams | [**Priority Support**](https://docs.localstack.cloud/getting-started/help-and-support/#priority-support) | -| Enterprise | [**Enterprise Support**](https://docs.localstack.cloud/getting-started/help-and-support/#enterprise-support) | +| Plan | Tier | +| ---------- | --------------------------------------------------------------------------------------------- | +| Hobby | [**Basic Support**]({{< ref "/getting-started/help-and-support/#basic-support" >}}) | +| Starter | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}}) | +| Teams | [**Priority Support**]({{< ref "/getting-started/help-and-support/#priority-support" >}}) | +| Enterprise | [**Enterprise Support**]({{< ref "/getting-started/help-and-support/#enterprise-support" >}}) | ## Support features diff --git a/content/en/getting-started/installation.md b/content/en/getting-started/installation.md index 8a3d811660..ea51cf1962 100644 --- a/content/en/getting-started/installation.md +++ b/content/en/getting-started/installation.md @@ -449,7 +449,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]({{< ref "dns-server/#system-dns-configuration" >}}) to disable it. - Start LocalStack with a specific DNS address: {{< command >}} $ DNS_ADDRESS=0 localstack start diff --git a/content/en/getting-started/quickstart/index.md b/content/en/getting-started/quickstart/index.md index b0477e7113..7a731c1e96 100644 --- a/content/en/getting-started/quickstart/index.md +++ b/content/en/getting-started/quickstart/index.md @@ -41,11 +41,11 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur ## Prerequisites -- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) -- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/) +- [LocalStack CLI]({{< ref "/getting-started/installation/#localstack-cli" >}}) +- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token]({{< ref "/getting-started/auth-token/" >}}) - [Docker](https://docs.docker.com/get-docker/) - [Python 3.11+](https://www.python.org/downloads/) & `pip` -- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal) +- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper]({{< ref "/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal" >}}) - `jq`, `zip` & `curl` You can start LocalStack using the `localstack` CLI. @@ -105,7 +105,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]({{< ref "/user-guide/aws/s3/" >}}), [SSM]({{< ref "/user-guide/aws/ssm" >}}/), [Lambda]({{< ref "/user-guide/aws/lambda" >}}/), [SNS]({{< ref "/user-guide/aws/sns" >}}/), and [SES]({{< ref "/user-guide/aws/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. @@ -128,7 +128,7 @@ $ deployment/awslocal/deploy.sh Alternatively, you can follow these instructions to deploy the sample application manually step-by-step. {{< callout "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]({{< ref "/user-guide/integrations/aws-cli/#configuring-an-endpoint-url" >}}) or a [custom profile]({{< ref "/user-guide/integrations/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. {{< /callout >}} diff --git a/content/en/references/api-key.md b/content/en/references/api-key.md index ca59f713dd..309effc94c 100644 --- a/content/en/references/api-key.md +++ b/content/en/references/api-key.md @@ -51,7 +51,7 @@ You can optionally run your LocalStack container in background mode by adding th The `localstack` CLI will detect the API key and properly pass it to the LocalStack container. {{< callout >}} -If you are using LocalStack with an API Key, you need to pull the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image) that includes the Pro services and several other advanced features. +If you are using LocalStack with an API Key, you need to pull the [LocalStack Pro image]({{< ref "docker-images/#localstack-pro-image" >}}) that includes the Pro services and several other advanced features. {{< /callout >}} ### Starting LocalStack via Docker @@ -67,7 +67,7 @@ $ docker run \ localstack/localstack-pro {{< / command >}} -For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide. +For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "installation/#docker" >}}) guide. ### Starting LocalStack via Docker-Compose diff --git a/content/en/references/configuration.md b/content/en/references/configuration.md index 2e568c824f..6b44352c9c 100644 --- a/content/en/references/configuration.md +++ b/content/en/references/configuration.md @@ -332,8 +332,8 @@ Please consult the [migration guide]({{< ref "user-guide/aws/lambda#migrating-to | - | - | - | | `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`]({{< ref "sqs/#enabling-messageretentionperiod" >}}) | +| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs]({{< ref "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` | @@ -501,9 +501,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]({{< ref "init-hooks" >}}). | | `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout]({{< ref "filesystem" >}}). | -| `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]({{< ref "init-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/content/en/references/docker-images.md b/content/en/references/docker-images.md index 4a34a8dd34..e1b15b7701 100644 --- a/content/en/references/docker-images.md +++ b/content/en/references/docker-images.md @@ -24,12 +24,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]({{< ref "user-guide/aws" >}}) with [integrations]({{< ref "/user-guide/integrations" >}}) on your local machine or in your [continuous integration pipelines]({{< ref "/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. -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]({{< ref "/user-guide/tools" >}}) to make your life as a cloud developer easier. +You can use [LocalStack Desktop]({{< ref "/user-guide/tools/localstack-desktop/" >}}) or [LocalStack Docker Extension]({{< ref "/user-guide/tools/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]({{< ref "/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 @@ -44,9 +44,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]({{< ref "/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/). +You can use the Pro image to start your LocalStack container using various [installation methods]({{< ref "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`). {{< callout >}} diff --git a/content/en/references/logging.md b/content/en/references/logging.md index f87ac91ee0..04cbd361d7 100644 --- a/content/en/references/logging.md +++ b/content/en/references/logging.md @@ -66,5 +66,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]({{< ref "localstack-desktop" >}}) +- [LocalStack Docker Extension]({{< ref "localstack-docker-extension" >}}) diff --git a/content/en/references/usage-tracking.md b/content/en/references/usage-tracking.md index e76d0ef9a5..006f2c8ed2 100644 --- a/content/en/references/usage-tracking.md +++ b/content/en/references/usage-tracking.md @@ -15,7 +15,7 @@ It is tracked regardless of whether the user disables event tracking since we co ## LocalStack usage statistics -For Pro users, most of the information is collected to populate the [Stack Insights](https://docs.localstack.cloud/user-guide/web-application/stack-insights) dashboard. +For Pro users, most of the information is collected to populate the [Stack Insights]({{ ref "stack-insights" >}}) dashboard. Collecting basic anonymized usage of AWS services helps us better direct engineering efforts to services that are used the most or cause the most issues. ### Session information diff --git a/content/en/tutorials/cloud-pods-collaborative-debugging/index.md b/content/en/tutorials/cloud-pods-collaborative-debugging/index.md index 00436ba07a..c48e63363e 100644 --- a/content/en/tutorials/cloud-pods-collaborative-debugging/index.md +++ b/content/en/tutorials/cloud-pods-collaborative-debugging/index.md @@ -44,9 +44,9 @@ The full sample application can be found [on GitHub](https://github.com/localsta ### **Prerequisites** -- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) (preferably using `pip`) +- [LocalStack CLI]({{< ref "/getting-started/installation/#localstack-cli" >}}) (preferably using `pip`) - [Docker](https://docs.docker.com/engine/install/) -- [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) or [OpenTofu](https://opentofu.org/docs/intro/install/) and [terraform-local](https://docs.localstack.cloud/user-guide/integrations/terraform/#install-the-tflocal-wrapper-script) +- [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) or [OpenTofu](https://opentofu.org/docs/intro/install/) and [terraform-local]({{< ref "/user-guide/integrations/terraform/#install-the-tflocal-wrapper-script" >}}) - Optional for Lambda build & editing: [Maven 3.9.4](https://maven.apache.org/install.html) & [Java 21](https://www.java.com/en/download/help/download_options.html) - Basic knowledge of AWS services (API Gateway, Lambda, DynamoDB, IAM) @@ -340,7 +340,7 @@ For organizations with specific data regulations, LocalStack offers multiple rem allowing full control with on-premises storage if needed. That way, Bob, Alice and Carol could collaborate using either an S3 bucket remote storage or an ORAS (OCI Registry as Storage) remote storage. The Cloud Pods command-line interface enables users to manage these remotes with ease, by following the instructions in the -[documentation](https://docs.localstack.cloud/user-guide/state-management/cloud-pods/#remotes). +[documentation]({{< ref "/user-guide/state-management/cloud-pods/#remotes" >}}). ## Conclusion @@ -353,5 +353,5 @@ resources in Continuous Integration (CI) for ultra-fast testing pipelines. ## Additional resources -- [Cloud Pods documentation](https://docs.localstack.cloud/user-guide/state-management/cloud-pods/) +- [Cloud Pods documentation]({{< ref "/user-guide/state-management/cloud-pods/" >}}) - [Terraform for AWS](https://developer.hashicorp.com/terraform/tutorials/aws-get-started) diff --git a/content/en/tutorials/gitlab_ci_testcontainers/index.md b/content/en/tutorials/gitlab_ci_testcontainers/index.md index aeb69274bd..1f7e6a8594 100644 --- a/content/en/tutorials/gitlab_ci_testcontainers/index.md +++ b/content/en/tutorials/gitlab_ci_testcontainers/index.md @@ -42,7 +42,7 @@ seamlessly with CI/CD pipelines like GitLab CI or GitHub Actions, allowing devel For this tutorial, you will need: -- [LocalStack Pro](https://docs.localstack.cloud/getting-started/auth-token/) to emulate the AWS services. +- [LocalStack Pro]({{< ref "/getting-started/auth-token/" >}}) to emulate the AWS services. If you don't have a subscription yet, you can just get a trial license for free. - [Docker](https://docker.io/) - [A GitLab account](https://gitlab.com/) diff --git a/content/en/tutorials/iam-policy-stream/index.md b/content/en/tutorials/iam-policy-stream/index.md index 6a7bba1f4c..f72e316c88 100644 --- a/content/en/tutorials/iam-policy-stream/index.md +++ b/content/en/tutorials/iam-policy-stream/index.md @@ -33,7 +33,7 @@ You'll generate the policy for the bucket notification configuration and insert ## Why use IAM Policy Stream? -LocalStack enables you to create and enforce local IAM roles and policies using the [`ENFORCE_IAM` feature](https://docs.localstack.cloud/user-guide/security-testing/iam-enforcement/). +LocalStack enables you to create and enforce local IAM roles and policies using the [`ENFORCE_IAM` feature]({{< ref "/user-guide/security-testing/iam-enforcement/" >}}). However, users often struggle to figure out the necessary permissions for different actions. It's important to find a balance, avoiding giving too many permissions while making sure the right ones are granted. @@ -46,7 +46,7 @@ Additionally, it serves as a useful learning tool, helping users understand the ## Prerequisites -- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) with [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/) +- [LocalStack CLI]({{< ref "/getting-started/installation/#localstack-cli" >}}) with [`LOCALSTACK_AUTH_TOKEN`]({{< ref "/getting-started/auth-token/">}}) - [Docker](https://docs.docker.com/get-docker/) - [Terraform](https://developer.hashicorp.com/terraform/install) & [`tflocal` wrapper](https://github.com/localstack/terraform-local) - [AWS](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-install.html) CLI with [`awslocal` wrapper](https://github.com/localstack/awscli-local) diff --git a/content/en/tutorials/lambda-ecr-container-images/index.md b/content/en/tutorials/lambda-ecr-container-images/index.md index f7209a0cc7..7e0cecad69 100644 --- a/content/en/tutorials/lambda-ecr-container-images/index.md +++ b/content/en/tutorials/lambda-ecr-container-images/index.md @@ -43,7 +43,7 @@ Before diving into this tutorial, make sure you have the following prerequisites - LocalStack Pro - [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}}) -- [`awslocal` CLI](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal) +- [`awslocal` CLI](<{{ ref "aws-cli/#localstack-aws-cli-awslocal" >}}) - [Python](https://www.python.org/downloads/) - [Docker](https://docker.io/) diff --git a/content/en/tutorials/replicate-aws-resources-localstack-extension/index.md b/content/en/tutorials/replicate-aws-resources-localstack-extension/index.md index aedbae5efe..62e87093fe 100644 --- a/content/en/tutorials/replicate-aws-resources-localstack-extension/index.md +++ b/content/en/tutorials/replicate-aws-resources-localstack-extension/index.md @@ -34,8 +34,8 @@ In this tutorial, you will learn how to install the AWS Replicator extension and ## Prerequisites -- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) with [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/) -- [Docker](https://docs.localstack.cloud/getting-started/auth-token/) +- [LocalStack CLI]({{< ref "installation/#localstack-cli" >}}) with [`LOCALSTACK_AUTH_TOKEN`]({{< ref "auth-token" >}}) +- [Docker](https://docs.docker.com/) - [AWS CLI](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-install.html) with [`awslocal` wrapper](https://github.com/localstack/awscli-local) - [LocalStack Web Application account](https://app.localstack.cloud/sign-up) - [AWS Account](https://aws.amazon.com/) with an [`AWS_ACCESS_KEY_ID` & `AWS_SECRET_ACCESS_KEY`](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) diff --git a/content/en/tutorials/schema-evolution-glue-msk/index.md b/content/en/tutorials/schema-evolution-glue-msk/index.md index 9ab2052b69..f6d763ab67 100644 --- a/content/en/tutorials/schema-evolution-glue-msk/index.md +++ b/content/en/tutorials/schema-evolution-glue-msk/index.md @@ -53,7 +53,7 @@ The following chart shows the integration of producers and consumers with Amazon 3. The consumer reads the serialized and compressed record. 4. The consumer requests the schema from the schema registry (if it is not already cached) and uses the schema to decompress and deserialize the record. -[AWS Glue Schema Registry](https://docs.localstack.cloud/user-guide/aws/glue/) is supported by LocalStack Pro as well, ultimately allowing you to test the evolution of your data streaming application completely on your local machine. +[AWS Glue Schema Registry]({{< ref "glue" >}}) is supported by LocalStack Pro as well, ultimately allowing you to test the evolution of your data streaming application completely on your local machine. It allows you develop and test your application's data schema evolution locally. The code for this tutorial (including a script to execute it step-by-step) can be found in our [LocalStack Pro samples over GitHub](https://github.com/localstack/localstack-pro-samples/tree/master/glue-msk-schema-registry). 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 9949587739..8df3d570f8 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 @@ -30,7 +30,7 @@ leadimage: "terraform-init-hooks.png" LocalStack is a robust tool that emulates a local AWS cloud stack, allowing engineers to test and develop apps using AWS services directly on their local environments. This tool is essential for enhancing developer experience, reducing development costs and increasing efficiency. -In LocalStack, [**initialization hooks**](https://docs.localstack.cloud/references/init-hooks/) are scripts that customize or initialize your LocalStack instance at different stages of its lifecycle. +In LocalStack, [**initialization hooks**]({{< ref "/references/init-hooks/" >}}) are scripts that customize or initialize your LocalStack instance at different stages of its lifecycle. Up until now, the supported hooks could be shell or Python scripts executed at predefined lifecycle phases — BOOT, START, READY, and SHUTDOWN. By placing scripts in the respective directories (/etc/localstack/init/{stage}.d), developers can automate tasks like setting up initial states, configuring services, or performing clean-up activities. @@ -45,10 +45,10 @@ This approach simplifies the development and testing cycle, making it more effic For this tutorial, you will need: -- [LocalStack Pro](https://docs.localstack.cloud/getting-started/auth-token/) to emulate the AWS services and to use LocalStack Extensions. +- [LocalStack Pro]({{< ref "/getting-started/auth-token/" >}}) to emulate the AWS services and to use LocalStack Extensions. If you don't have LocalStack Pro yet, you can sign up on our [webapp](https://app.localstack.cloud) to get a trial license for free. - [Docker](https://docker.io/) -- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/) +- [LocalStack CLI]({{< ref "/getting-started/installation/" >}}) - [AWS CLI](https://aws.amazon.com/cli/) - Optional for building the Lambda functions: [Java 17](https://openjdk.org/install/) - Optional for building the Lambda functions: [Apache Maven 3.9.8](https://maven.apache.org/install.html) @@ -136,7 +136,7 @@ services: Environment Variables: - **LOCALSTACK_AUTH_TOKEN**: Required for using LocalStack Pro. - **DEBUG**: Set to 1 to enable verbose logging of the container. -- **EXTENSION_AUTO_INSTALL**: Automatically installs specified LocalStack [extensions](https://docs.localstack.cloud/user-guide/extensions/), in this case, `localstack-extension-terraform-init` which allows Terraform files to be directly used as init hooks. +- **EXTENSION_AUTO_INSTALL**: Automatically installs specified LocalStack [extensions]({{< ref "/user-guide/extensions/" >}}), in this case, `localstack-extension-terraform-init` which allows Terraform files to be directly used as init hooks. Volumes: - Docker Socket: Mounts the Docker socket `/var/run/docker.sock` from the host into the container. diff --git a/content/en/user-guide/aws/account/index.md b/content/en/user-guide/aws/account/index.md index f49e5af0ed..a92cbc8f24 100644 --- a/content/en/user-guide/aws/account/index.md +++ b/content/en/user-guide/aws/account/index.md @@ -12,7 +12,7 @@ You can use the Account APIs to retrieve information about your account, manage Additionally, you can use the Account APIs to enable or disable a region for your account, and delete alternate contacts in your account. LocalStack allows you to use the Account API to retrieve information about your account. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_account/), which provides information on the extent of Account's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_account" >}}), which provides information on the extent of Account's integration with LocalStack. {{< callout >}} LocalStack's Account provider is mock-only and does not support any real AWS account. diff --git a/content/en/user-guide/aws/acm/index.md b/content/en/user-guide/aws/acm/index.md index 9b50368f46..bc4c6fb4f5 100644 --- a/content/en/user-guide/aws/acm/index.md +++ b/content/en/user-guide/aws/acm/index.md @@ -14,7 +14,7 @@ ACM supports securing multiple domain names and subdomains and can create wildca You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use. LocalStack allows you to use the ACM APIs to create, list, and delete certificates. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm/), which provides information on the extent of ACM's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_acm" >}}), which provides information on the extent of ACM's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/amplify/index.md b/content/en/user-guide/aws/amplify/index.md index 80fca92820..2b82955077 100644 --- a/content/en/user-guide/aws/amplify/index.md +++ b/content/en/user-guide/aws/amplify/index.md @@ -12,7 +12,7 @@ Amplify is a JavaScript-based development framework with libraries, UI component With Amplify, developers can build and host static websites, single-page applications, and full-stack serverless web applications using an abstraction layer over popular AWS services like DynamoDB, Cognito, AppSync, Lambda, S3, and more. LocalStack allows you to use the Amplify APIs to build and test their Amplify applications locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_amplify/), which provides information on the extent of Amplify's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_amplify" >}}), which provides information on the extent of Amplify's integration with LocalStack. {{< callout "note" >}} The `amplifylocal` CLI and the Amplify JS library have been deprecated and are no longer supported. diff --git a/content/en/user-guide/aws/apigateway/index.md b/content/en/user-guide/aws/apigateway/index.md index db1c0e300d..c7508523d5 100644 --- a/content/en/user-guide/aws/apigateway/index.md +++ b/content/en/user-guide/aws/apigateway/index.md @@ -15,7 +15,7 @@ API Gateway supports standard HTTP methods such as `GET`, `POST`, `PUT`, `PATCH` LocalStack supports API Gateway V1 (REST API) in the Free plan, and API Gateway V2 (HTTP, Management and WebSocket API) in the Base plan. LocalStack allows you to use the API Gateway APIs to create, deploy, and manage APIs on your local machine to invoke those exposed API endpoints. -The supported APIs are available on the API coverage page for [API Gateway V1](https://docs.localstack.cloud/references/coverage/coverage_apigateway/) & [API Gateway V2](https://docs.localstack.cloud/references/coverage/coverage_apigatewayv2/), which provides information on the extent of API Gateway's integration with LocalStack. +The supported APIs are available on the API coverage page for [API Gateway V1]({{< ref "coverage_apigateway" >}}) & [API Gateway V2]({{< ref "coverage_apigatewayv2" >}}), which provides information on the extent of API Gateway's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/appconfig/index.md b/content/en/user-guide/aws/appconfig/index.md index 00201e9f28..1917038ed2 100644 --- a/content/en/user-guide/aws/appconfig/index.md +++ b/content/en/user-guide/aws/appconfig/index.md @@ -10,7 +10,7 @@ AppConfig offers centralized management of configuration data and the ability to It allows you to avoid deploying the service repeatedly for smaller changes, enables controlled deployments to applications and includes built-in validation checks & monitoring. LocalStack allows you to use the AppConfig APIs in your local environment to define configurations for different environments and deploy them to your applications as needed. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_appconfig/), which provides information on the extent of AppConfig's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_appconfig" >}}), which provides information on the extent of AppConfig's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/applicationautoscaling/index.md b/content/en/user-guide/aws/applicationautoscaling/index.md index 6ee65f8673..0a35845374 100644 --- a/content/en/user-guide/aws/applicationautoscaling/index.md +++ b/content/en/user-guide/aws/applicationautoscaling/index.md @@ -14,7 +14,7 @@ With Application Auto Scaling, you can configure automatic scaling for services Auto scaling uses CloudWatch under the hood to configure scalable targets which a service namespace, resource ID, and scalable dimension can uniquely identify. LocalStack allows you to use the Application Auto Scaling APIs in your local environment to scale different resources based on scaling policies and scheduled scaling. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_application-autoscaling/), which provides information on the extent of Application Auto Scaling's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_application-autoscaling" >}}), which provides information on the extent of Application Auto Scaling's integration with LocalStack. ## Getting Started diff --git a/content/en/user-guide/aws/appsync/index.md b/content/en/user-guide/aws/appsync/index.md index 840327149e..6aaf0e1bb3 100644 --- a/content/en/user-guide/aws/appsync/index.md +++ b/content/en/user-guide/aws/appsync/index.md @@ -11,7 +11,7 @@ AppSync is a managed service provided by Amazon Web Services (AWS) that enables AppSync allows you to define your data models and business logic using a declarative approach, and connect to various data sources, including other AWS services, relational databases, and custom data sources. LocalStack allows you to use the AppSync APIs in your local environment to connect your applications and services to data and events. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_appsync/), which provides information on the extent of AppSync's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_appsync" >}}), which provides information on the extent of AppSync's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/athena/index.md b/content/en/user-guide/aws/athena/index.md index c4540496de..0480a8cb85 100644 --- a/content/en/user-guide/aws/athena/index.md +++ b/content/en/user-guide/aws/athena/index.md @@ -12,7 +12,7 @@ Athena allows users to create ad-hoc queries to perform data analysis, filter, a It supports various file formats, such as JSON, Parquet, and CSV, making it compatible with a wide range of data sources. LocalStack allows you to configure the Athena APIs with a Hive metastore that can connect to the S3 API and query your data directly in your local environment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_athena/), which provides information on the extent of Athena's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_athena" >}}), which provides information on the extent of Athena's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/autoscaling/index.md b/content/en/user-guide/aws/autoscaling/index.md index 73a3229283..ba7d4514db 100644 --- a/content/en/user-guide/aws/autoscaling/index.md +++ b/content/en/user-guide/aws/autoscaling/index.md @@ -11,7 +11,7 @@ Auto Scaling helps you maintain application availability and allows you to autom You can use Auto Scaling to ensure that you are running your desired number of instances. LocalStack allows you to use the Auto Scaling APIs locally to create and manage Auto Scaling groups locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_autoscaling/), which provides information on the extent of Auto Scaling's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_autoscaling" >}}), which provides information on the extent of Auto Scaling's integration with LocalStack. ## Getting started @@ -137,5 +137,5 @@ Replace `i-0d678c4ecf6018dde` with the instance ID that you fetched from the out ## Current Limitations -LocalStack does not support the `docker`/`libvirt` [VM manager for EC2](https://docs.localstack.cloud/user-guide/aws/ec2/#vm-managers). +LocalStack does not support the `docker`/`libvirt` [VM manager for EC2]({{< ref "/user-guide/aws/ec2/#vm-managers" >}}). It only works with the `mock` VM manager. diff --git a/content/en/user-guide/aws/backup/index.md b/content/en/user-guide/aws/backup/index.md index fb9c0dd5cc..e90413b0de 100644 --- a/content/en/user-guide/aws/backup/index.md +++ b/content/en/user-guide/aws/backup/index.md @@ -14,7 +14,7 @@ Backup supports a wide range of AWS resources, including Elastic Block Store (EB Backup enables you to set backup retention policies, allowing you to specify how long you want to retain your backup copies. LocalStack allows you to use the Backup APIs in your local environment to manage backup plans, create scheduled or on-demand backups of certain resource types. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_backup/), which provides information on the extent of Backup's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_backup" >}}), which provides information on the extent of Backup's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/batch/index.md b/content/en/user-guide/aws/batch/index.md index 385194f7c8..72a123f703 100644 --- a/content/en/user-guide/aws/batch/index.md +++ b/content/en/user-guide/aws/batch/index.md @@ -11,7 +11,7 @@ Batch is a cloud-based service provided by Amazon Web Services (AWS) that simpli Batch allows you to efficiently process large volumes of data and run batch jobs without the need to manage and provision underlying compute resources. LocalStack allows you to use the Batch APIs to automate and scale computational tasks in your local environment while handling batch workloads. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_batch/), which provides information on the extent of Batch integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_batch" >}}), which provides information on the extent of Batch integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/bedrock/index.md b/content/en/user-guide/aws/bedrock/index.md index 42e61ec062..fa1d2892ae 100644 --- a/content/en/user-guide/aws/bedrock/index.md +++ b/content/en/user-guide/aws/bedrock/index.md @@ -9,7 +9,7 @@ tags: ["Ultimate"] Bedrock is a fully managed service provided by Amazon Web Services (AWS) that makes foundation models from various LLM providers accessible via an API. LocalStack allows you to use the Bedrock APIs to test and develop AI-powered applications in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_bedrock/), which provides information on the extent of Bedrock's integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_bedrock" >}}), which provides information on the extent of Bedrock's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/ce/index.md b/content/en/user-guide/aws/ce/index.md index 620b460000..00f5cf757f 100644 --- a/content/en/user-guide/aws/ce/index.md +++ b/content/en/user-guide/aws/ce/index.md @@ -13,7 +13,7 @@ Cost Explorer offers options to filter and group data by dimensions such as serv With Cost Explorer, you can forecast costs, track budget progress, and set up alerts to receive notifications when spending exceeds predefined thresholds. LocalStack allows you to use the Cost Explorer APIs in your local environment to create and manage cost category definition, cost anomaly monitors & subscriptions. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ce/), which provides information on the extent of Cost Explorer's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_ce" >}}), which provides information on the extent of Cost Explorer's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/cloudformation/index.md b/content/en/user-guide/aws/cloudformation/index.md index b05ae936b9..96a8cad16f 100644 --- a/content/en/user-guide/aws/cloudformation/index.md +++ b/content/en/user-guide/aws/cloudformation/index.md @@ -14,7 +14,7 @@ With CloudFormation, you can use JSON or YAML templates to define your desired i You can specify resources, their configurations, dependencies, and relationships in these templates. LocalStack supports CloudFormation, allowing you to use the CloudFormation APIs in your local environment to declaratively define your architecture on the AWS, including resources such as S3 Buckets, Lambda Functions, and much more. -The [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_cloudformation/) and [feature coverage](#feature-coverage) provides information on the extent of CloudFormation's integration with LocalStack. +The [API coverage page]({{< ref "coverage_cloudformation" >}}) and [feature coverage](#feature-coverage) provides information on the extent of CloudFormation's integration with LocalStack. ## Getting started @@ -115,7 +115,7 @@ The Resource Browser allows you to perform the following actions: The following code snippets and sample applications provide practical examples of how to use CloudFormation in LocalStack for various use cases: - [Serverless Container-based APIs with Amazon ECS & API Gateway](https://github.com/localstack/serverless-api-ecs-apigateway-sample) -- [Deploying containers on ECS clusters using ECR and Fargate](https://docs.localstack.cloud/tutorials/ecs-ecr-container-app/) +- [Deploying containers on ECS clusters using ECR and Fargate]({{< ref "/tutorials/ecs-ecr-container-app" >}}) - [Messaging Processing application with SQS, DynamoDB, and Fargate](https://github.com/localstack/sqs-fargate-ddb-cdk-go) ## Feature coverage diff --git a/content/en/user-guide/aws/cloudfront/index.md b/content/en/user-guide/aws/cloudfront/index.md index 507ee7040b..74adac0fb3 100644 --- a/content/en/user-guide/aws/cloudfront/index.md +++ b/content/en/user-guide/aws/cloudfront/index.md @@ -13,7 +13,7 @@ CloudFront distributes its web content, videos, applications, and APIs with low CloudFront APIs allow you to configure distributions, customize cache behavior, secure content with access controls, and monitor the CDN's performance through real-time metrics. LocalStack allows you to use the CloudFront APIs in your local environment to create local CloudFront distributions to transparently access your applications and file artifacts. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_cloudfront/), which provides information on the extent of CloudFront's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_cloudfront" >}}), which provides information on the extent of CloudFront's integration with LocalStack. ## Getting started @@ -77,7 +77,7 @@ You can enable this feature by setting `CLOUDFRONT_LAMBDA_EDGE=1` in your LocalS ### Current limitations -- The [`UpdateDistribution`](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html), [`DeleteDistribution`](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DeleteDistribution.html), and [`Persistence Restore`](https://docs.localstack.cloud/user-guide/state-management/persistence/) features are not yet supported for Lambda@Edge. +- The [`UpdateDistribution`](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html), [`DeleteDistribution`](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_DeleteDistribution.html), and [`Persistence Restore`]({{< ref "persistence" >}}) features are not yet supported for Lambda@Edge. - The `origin-request` and `origin-response` event types currently trigger for each request because caching is not implemented in CloudFront. ## Using custom URLs diff --git a/content/en/user-guide/aws/cloudtrail/index.md b/content/en/user-guide/aws/cloudtrail/index.md index 0bff2c2129..820ae216cd 100644 --- a/content/en/user-guide/aws/cloudtrail/index.md +++ b/content/en/user-guide/aws/cloudtrail/index.md @@ -12,7 +12,7 @@ CloudTrail is a service provided by Amazon Web Services (AWS) that enables you t It records API calls and actions made on your AWS resources, offering an audit trail that helps you understand changes, diagnose issues, and maintain compliance. LocalStack allows you to use the CloudTrail APIs in your local environment to create and manage Event history and trails. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_cloudtrail/), which provides information on the extent of CloudTrail's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_cloudtrail" >}}), which provides information on the extent of CloudTrail's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/cloudwatch/index.md b/content/en/user-guide/aws/cloudwatch/index.md index 5624528258..32e14d3b9b 100644 --- a/content/en/user-guide/aws/cloudwatch/index.md +++ b/content/en/user-guide/aws/cloudwatch/index.md @@ -11,10 +11,10 @@ It allows you to collect and track metrics, collect and monitor log files, and s CloudWatch provides valuable insights into your AWS resources, applications, and services, enabling you to troubleshoot issues, optimize performance, and make informed decisions. LocalStack allows you to use CloudWatch APIs on your local machine to create and manage CloudWatch resources, such as custom metrics, alarms, and log groups, for local development and testing purposes. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_cloudwatch/), which provides information on the extent of CloudWatch's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_cloudwatch" >}}), which provides information on the extent of CloudWatch's integration with LocalStack. {{< callout >}} -We have introduced an all-new LocalStack-native [CloudWatch provider](https://docs.localstack.cloud/user-guide/aws/cloudwatch/) and recently made this one the default. +We have introduced an all-new LocalStack-native [CloudWatch provider]({{< ref "/user-guide/aws/cloudwatch" >}}) and recently made this one the default. With the new provider we have migrated from storing data in Python objects within the Moto backend to a more robust system. diff --git a/content/en/user-guide/aws/codecommit/index.md b/content/en/user-guide/aws/codecommit/index.md index 3a0a8bb105..caeb667221 100644 --- a/content/en/user-guide/aws/codecommit/index.md +++ b/content/en/user-guide/aws/codecommit/index.md @@ -19,7 +19,7 @@ You can also use standard Git commands or CodeCommit APIs (using AWS CLI or SDKs CodeCommit also uses identity-based policies, which can be attached to IAM users, groups, and roles, ensuring secure and granular access control. LocalStack allows you to use the CodeCommit APIs in your local environment to create new repositories, push your commits, and manage the repositories. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_codecommit/), which provides information on the extent of CodeCommit's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_codecommit" >}}), which provides information on the extent of CodeCommit's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/cognito/index.md b/content/en/user-guide/aws/cognito/index.md index 585208bdb2..af0d15a9c2 100644 --- a/content/en/user-guide/aws/cognito/index.md +++ b/content/en/user-guide/aws/cognito/index.md @@ -13,7 +13,7 @@ Cognito enables developers to add user sign-up, sign-in, and access control func Cognito supports various authentication methods, including social identity providers, SAML-based identity providers, and custom authentication flows. LocalStack allows you to use the Cognito APIs in your local environment to manage authentication and access control for your local application and resources. -The supported APIs are available on our [Cognito Identity coverage page](https://docs.localstack.cloud/references/coverage/coverage_cognito-identity/) and [Cognito User Pools coverage page](https://docs.localstack.cloud/references/coverage/coverage_cognito-idp/), which provides information on the extent of Cognito's integration with LocalStack. +The supported APIs are available on our [Cognito Identity coverage page]({{< ref "coverage_cognito-identity" >}}) and [Cognito User Pools coverage page]({{< ref "coverage_cognito-idp" >}}), which provides information on the extent of Cognito's integration with LocalStack. ## Getting started @@ -338,7 +338,7 @@ The client credentials grant allows for scope-based authorization from a non-int Your app can directly request client credentials from the token endpoint to receive an access token. To request the token from the LocalStack URL, use the following endpoint: `://cognito-idp.localhost.localstack.cloud:4566/_aws/cognito-idp/oauth2/token`. -For additional information on our endpoints, refer to our [Internal Endpoints](https://docs.localstack.cloud/references/internal-endpoints/) documentation. +For additional information on our endpoints, refer to our [Internal Endpoints]({{< ref "/references/internal-endpoints" >}}) documentation. If there are multiple user pools, LocalStack identifies the appropriate one by examining the `clientid` of the request. diff --git a/content/en/user-guide/aws/config/index.md b/content/en/user-guide/aws/config/index.md index b32328c176..9c28d46d10 100644 --- a/content/en/user-guide/aws/config/index.md +++ b/content/en/user-guide/aws/config/index.md @@ -13,7 +13,7 @@ Config provides a comprehensive view of the resource configuration across your A Config continuously records configuration changes and allows you to retain a historical record of these changes. LocalStack allows you to use the Config APIs in your local environment to assesses resource configurations and notifies you of any non-compliant items to mitigate potential security risks. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_config/), which provides information on the extent of Config's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_config" >}}), which provides information on the extent of Config's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/dms/index.md b/content/en/user-guide/aws/dms/index.md index 24b1498090..b2e26fe9ba 100644 --- a/content/en/user-guide/aws/dms/index.md +++ b/content/en/user-guide/aws/dms/index.md @@ -11,7 +11,7 @@ AWS Database Migration Service provides migration solution from databases, data The migration can be homogeneous (source and target have the same type), but often times is heterogeneous as it supports migration from various sources to various targets (self-hosted and AWS services). LocalStack only supports selected use cases for DMS at the moment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_dms/), which provides information on the extent of DMS integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_dms" >}}), which provides information on the extent of DMS integration with LocalStack. {{< callout "note">}} DMS is in a preview state, supporting only [selected use cases](#supported-use-cases). diff --git a/content/en/user-guide/aws/docdb/index.md b/content/en/user-guide/aws/docdb/index.md index f4d9cb539e..7f89ade5f0 100644 --- a/content/en/user-guide/aws/docdb/index.md +++ b/content/en/user-guide/aws/docdb/index.md @@ -11,7 +11,7 @@ DocumentDB is a fully managed, non-relational database service that supports Mon DocumentDB is compatible with MongoDB, meaning you can use the same MongoDB drivers, applications, and tools to run, manage, and scale workloads on DocumentDB without having to worry about managing the underlying infrastructure. LocalStack allows you to use the DocumentDB APIs to create and manage DocumentDB clusters and instances. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_docdb/), which provides information on the extent of DocumentDB's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_docdb" >}}), which provides information on the extent of DocumentDB's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/dynamodb/index.md b/content/en/user-guide/aws/dynamodb/index.md index 9454f58b93..82e8be9966 100644 --- a/content/en/user-guide/aws/dynamodb/index.md +++ b/content/en/user-guide/aws/dynamodb/index.md @@ -11,7 +11,7 @@ It offers a flexible and highly scalable way to store and retrieve data, making DynamoDB provides a fast and scalable key-value datastore with support for replication, automatic scaling, data encryption at rest, and on-demand backup, among other capabilities. LocalStack allows you to use the DynamoDB APIs in your local environment to manage key-value and document data models. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_dynamodb/), which provides information on the extent of DynamoDB's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_dynamodb" >}}), which provides information on the extent of DynamoDB's integration with LocalStack. DynamoDB emulation is powered by [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html). diff --git a/content/en/user-guide/aws/dynamodbstreams/index.md b/content/en/user-guide/aws/dynamodbstreams/index.md index fef6bcc32f..89bd856c14 100644 --- a/content/en/user-guide/aws/dynamodbstreams/index.md +++ b/content/en/user-guide/aws/dynamodbstreams/index.md @@ -11,7 +11,7 @@ The stream records are written to a DynamoDB stream, which is an ordered flow of DynamoDB Streams records data in near-real time, enabling you to develop workflows that process these streams and respond based on their contents. LocalStack supports DynamoDB Streams, allowing you to create and manage streams in a local environment. -The supported APIs are available on our [DynamoDB Streams coverage page](https://docs.localstack.cloud/references/coverage/coverage_dynamodbstreams/), which provides information on the extent of DynamoDB Streams integration with LocalStack. +The supported APIs are available on our [DynamoDB Streams coverage page]({{< ref "coverage_dynamodbstreams" >}}), which provides information on the extent of DynamoDB Streams integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/ec2/index.md b/content/en/user-guide/aws/ec2/index.md index f12abb21ed..fc77a441ac 100644 --- a/content/en/user-guide/aws/ec2/index.md +++ b/content/en/user-guide/aws/ec2/index.md @@ -12,7 +12,7 @@ Elastic Compute Cloud (EC2) is a core service within Amazon Web Services (AWS) t EC2 enables users to launch and manage virtual machines, referred to as instances. LocalStack allows you to use the EC2 APIs in your local environment to create and manage EC2 instances and related resources such as VPCs, EBS volumes, etc. -The list of supported APIs can be found on the [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ec2/). +The list of supported APIs can be found on the [API coverage page]({{< ref "coverage_ec2" >}}). ## Getting started diff --git a/content/en/user-guide/aws/ecr/index.md b/content/en/user-guide/aws/ecr/index.md index 0e8569af93..f9b7da45bc 100644 --- a/content/en/user-guide/aws/ecr/index.md +++ b/content/en/user-guide/aws/ecr/index.md @@ -13,7 +13,7 @@ ECR enables you to store, manage, and deploy Docker container images to build, s ECR integrates with other AWS services, such as Lambda, ECS, and EKS. LocalStack allows you to use the ECR APIs in your local environment to build & push Docker images to a local ECR registry. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ecr/), which provides information on the extent of ECR's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_ecr" >}}), which provides information on the extent of ECR's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/ecs/index.md b/content/en/user-guide/aws/ecs/index.md index 88145aa195..b6f80bcc70 100644 --- a/content/en/user-guide/aws/ecs/index.md +++ b/content/en/user-guide/aws/ecs/index.md @@ -13,7 +13,7 @@ It allows you to run, stop, and manage Docker containers on a cluster. ECS eliminates the need for you to install, operate, and scale your own cluster management infrastructure. LocalStack allows you to use the ECS APIs in your local environment to create & manage ECS clusters, tasks, and services. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ecs/), which provides information on the extent of ECS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_ecs" >}}), which provides information on the extent of ECS's integration with LocalStack. ## Getting Started @@ -336,7 +336,7 @@ services: - ~/.docker/config.json:/config.json:ro ``` -Alternatively, you can download the image from the private registry before using it or employ an [Initialization Hook](https://docs.localstack.cloud/references/init-hooks/) to install the Docker client and use these credentials to download the image. +Alternatively, you can download the image from the private registry before using it or employ an [Initialization Hook]({{< ref "/references/init-hooks" >}}) to install the Docker client and use these credentials to download the image. ## Firelens for ECS Tasks diff --git a/content/en/user-guide/aws/efs/index.md b/content/en/user-guide/aws/efs/index.md index 2290b0ef72..69571e1150 100644 --- a/content/en/user-guide/aws/efs/index.md +++ b/content/en/user-guide/aws/efs/index.md @@ -12,7 +12,7 @@ EFS offers scalable and shared file storage that can be accessed by multiple EC2 EFS utilizes the Network File System protocol to allow it to be used as a data source for various applications and workloads. LocalStack allows you to use the EFS APIs in your local environment to create local file systems, lifecycle configurations, and file system policies. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_efs/), which provides information on the extent of EFS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_efs" >}}), which provides information on the extent of EFS's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/eks/index.md b/content/en/user-guide/aws/eks/index.md index 9aff4ccfc8..53518df507 100644 --- a/content/en/user-guide/aws/eks/index.md +++ b/content/en/user-guide/aws/eks/index.md @@ -12,7 +12,7 @@ Elastic Kubernetes Service (EKS) is a managed Kubernetes service that makes it e Kubernetes is an open-source system for automating containerized applications' deployment, scaling, and management. LocalStack allows you to use the EKS APIs in your local environment to spin up embedded Kubernetes clusters in your local Docker engine or use an existing Kubernetes installation you can access from your local machine (defined in `$HOME/.kube/config`). -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_eks/), which provides information on the extent of EKS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_eks" >}}), which provides information on the extent of EKS's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/elasticbeanstalk/index.md b/content/en/user-guide/aws/elasticbeanstalk/index.md index e133a64517..95950ae42a 100644 --- a/content/en/user-guide/aws/elasticbeanstalk/index.md +++ b/content/en/user-guide/aws/elasticbeanstalk/index.md @@ -13,7 +13,7 @@ Elastic Beanstalk orchestrates various AWS services, including EC2, S3, SNS, and Elastic Beanstalk also supports various application environments, such as Java, .NET, Node.js, PHP, Python, Ruby, Go, and Docker. LocalStack allows you to use the Elastic Beanstalk APIs in your local environment to create and manage applications, environments and versions. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_elasticbeanstalk/), which provides information on the extent of Elastic Beanstalk's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_elasticbeanstalk" >}}), which provides information on the extent of Elastic Beanstalk's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/elastictranscoder/index.md b/content/en/user-guide/aws/elastictranscoder/index.md index 8dd61fd40a..4094f4541e 100644 --- a/content/en/user-guide/aws/elastictranscoder/index.md +++ b/content/en/user-guide/aws/elastictranscoder/index.md @@ -12,7 +12,7 @@ Elastic Transcoder manages the underlying resources, ensuring high availability It also supports a wide range of input and output formats, enabling users to efficiently process and deliver video content at scale. LocalStack allows you to mock the Elastic Transcoder APIs in your local environment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_elastictranscoder/), which provides information on the extent of Elastic Transcoder's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_elastictranscoder" >}}), which provides information on the extent of Elastic Transcoder's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/elb/index.md b/content/en/user-guide/aws/elb/index.md index a75982e5d2..ba65a5507b 100644 --- a/content/en/user-guide/aws/elb/index.md +++ b/content/en/user-guide/aws/elb/index.md @@ -12,7 +12,7 @@ It also monitors the health of its registered targets and ensures that it routes You can check [the official AWS documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/what-is-load-balancing.html) to understand the basic terms and concepts used in the ELB. Localstack allows you to use the Elastic Load Balancing APIs in your local environment to create, edit, and view load balancers, target groups, listeners, and rules. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_elbv2/), which provides information on the extent of ELB's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_elbv2" >}}), which provides information on the extent of ELB's integration with LocalStack. ## Getting started @@ -175,7 +175,7 @@ http(s)://localhost.localstack.cloud:4566/_aws/elb/example-lb/test/path The following code snippets and sample applications provide practical examples of how to use ELB in LocalStack for various use cases: -- [Setting up Elastic Load Balancing (ELB) Application Load Balancers using LocalStack, deployed via the Serverless framework](https://docs.localstack.cloud/tutorials/elb-load-balancing/) +- [Setting up Elastic Load Balancing (ELB) Application Load Balancers using LocalStack, deployed via the Serverless framework]({{< ref "/tutorials/elb-load-balancing" >}}) ## Current Limitations diff --git a/content/en/user-guide/aws/elementalmediaconvert/index.md b/content/en/user-guide/aws/elementalmediaconvert/index.md index 5b3c7de9b1..662330d75a 100644 --- a/content/en/user-guide/aws/elementalmediaconvert/index.md +++ b/content/en/user-guide/aws/elementalmediaconvert/index.md @@ -11,7 +11,7 @@ Elemental MediaConvert is a file-based video transcoding service with broadcast- It enables you to easily create high-quality video streams for broadcast and multiscreen delivery. LocalStack allows you to mock the MediaConvert APIs in your local environment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_mediaconvert/), which provides information on the extent of MediaConvert's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_mediaconvert" >}}), which provides information on the extent of MediaConvert's integration with LocalStack. {{< callout "note">}} Elemental MediaConvert is in a preview state. diff --git a/content/en/user-guide/aws/emr/index.md b/content/en/user-guide/aws/emr/index.md index bc36dcdd3a..1553dd4ea0 100644 --- a/content/en/user-guide/aws/emr/index.md +++ b/content/en/user-guide/aws/emr/index.md @@ -16,12 +16,12 @@ LocalStack supports EMR and allows developers to run data analytics workloads lo EMR utilizes various tools in the [Hadoop](https://hadoop.apache.org/) and [Spark](https://spark.apache.org) ecosystem, and your EMR instance is automatically configured to connect seamlessly to LocalStack's S3 API. LocalStack also supports EMR Serverless to create applications and job runs, to run your Spark/PySpark jobs locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_emr/), which provides information on the extent of EMR's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{ ref "coverage_emr" >}}), which provides information on the extent of EMR's integration with LocalStack. {{< callout >}} To utilize the EMR API, certain additional dependencies need to be downloaded from the network (including Hadoop, Hive, Spark, etc). These dependencies are fetched automatically during service startup, hence it is important to ensure a reliable internet connection when retrieving the dependencies for the first time. -Alternatively, you can use one of our `*-bigdata` Docker image tags which already ship with the required libraries baked in and may provide better stability (see [here](https://docs.localstack.cloud/user-guide/ci/#ci-images) for more details). +Alternatively, you can use one of our `*-bigdata` Docker image tags which already ship with the required libraries baked in and may provide better stability (see [here]({{< ref "/user-guide/ci/#ci-images" >}}) for more details). {{< /callout >}} ## Getting started diff --git a/content/en/user-guide/aws/events/index.md b/content/en/user-guide/aws/events/index.md index 73edcdc553..b3c943f55f 100644 --- a/content/en/user-guide/aws/events/index.md +++ b/content/en/user-guide/aws/events/index.md @@ -14,7 +14,7 @@ EventBridge rules are tied to an Event Bus to manage event-driven workflows. You can use either identity-based or resource-based policies to control access to EventBridge resources, where the former can be attached to IAM users, groups, and roles, and the latter can be attached to specific AWS resources. LocalStack allows you to use the EventBridge APIs in your local environment to create rules that route events to a target. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_events/), which provides information on the extent of EventBridge's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_events" >}}), which provides information on the extent of EventBridge's integration with LocalStack. For information on EventBridge Pipes, please refer to the [EventBridge Pipes]({{< ref "user-guide/aws/pipes" >}}) section. {{< callout >}} diff --git a/content/en/user-guide/aws/firehose/index.md b/content/en/user-guide/aws/firehose/index.md index 73d5e8dae3..e66924a723 100644 --- a/content/en/user-guide/aws/firehose/index.md +++ b/content/en/user-guide/aws/firehose/index.md @@ -16,7 +16,7 @@ Data Firehose is a service provided by AWS that allows you to extract, transform With Data Firehose, you can ingest and deliver real-time data from different sources as it automates data delivery, handles buffering and compression, and scales according to the data volume. LocalStack allows you to use the Data Firehose APIs in your local environment to load and transform real-time data. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_firehose/), which provides information on the extent of Data Firehose's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_firehose" >}}), which provides information on the extent of Data Firehose's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/fis/index.md b/content/en/user-guide/aws/fis/index.md index b01492d974..9f30687e18 100644 --- a/content/en/user-guide/aws/fis/index.md +++ b/content/en/user-guide/aws/fis/index.md @@ -13,7 +13,7 @@ FIS simulates faults such as resource unavailability and service errors to asses The full list of such possible fault injections is available in the [AWS docs](https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html). LocalStack allows you to use the FIS APIs in your local environment to introduce faults in other services, in order to check how your setup behaves when parts of it stop working locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_fis/), which provides information on the extent of FIS API's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_fis" >}}), which provides information on the extent of FIS API's integration with LocalStack. {{< callout "tip" >}} LocalStack also features its own powerful chaos engineering tool, [Chaos API]({{< ref "chaos-api" >}}). diff --git a/content/en/user-guide/aws/glacier/index.md b/content/en/user-guide/aws/glacier/index.md index cd52965ae5..836f7ff79b 100644 --- a/content/en/user-guide/aws/glacier/index.md +++ b/content/en/user-guide/aws/glacier/index.md @@ -16,7 +16,7 @@ Glacier uses Jobs to retrieve the data in an Archive or list the inventory of a LocalStack allows you to use the Glacier APIs in your local environment to manage Vaults and Archives. You can use the Glacier API to configure and set up vaults where you can store archives and manage them. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_glacier/), which provides information on the extent of Glacier's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_glacier" >}}), which provides information on the extent of Glacier's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/identitystore/index.md b/content/en/user-guide/aws/identitystore/index.md index a2d97ccba5..a5503799b1 100644 --- a/content/en/user-guide/aws/identitystore/index.md +++ b/content/en/user-guide/aws/identitystore/index.md @@ -11,7 +11,7 @@ Identity Store is a managed service that enables the creation and management of Groups are used to manage access to AWS resources, and Identity Store provides a central location to create and manage groups across your AWS accounts. LocalStack allows you to use the Identity Store APIs to create and manage groups in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_identitystore/), which provides information on the extent of Identity Store integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_identitystore" >}}), which provides information on the extent of Identity Store integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/iot/index.md b/content/en/user-guide/aws/iot/index.md index d3696822c9..49c1c78985 100644 --- a/content/en/user-guide/aws/iot/index.md +++ b/content/en/user-guide/aws/iot/index.md @@ -12,7 +12,7 @@ AWS IoT provides cloud services to manage IoT devices and integrate them with ot LocalStack supports IoT Core, IoT Data, IoT Analytics. Common operations for creating and updating things, groups, policies, certificates and other entities are implemented with full CloudFormation support. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_iot/). +The supported APIs are available on our [API coverage page]({{< ref "coverage_iot" >}}). LocalStack ships a [Message Queuing Telemetry Transport (MQTT)](https://mqtt.org/) broker powered by [Eclipse Mosquitto](https://mosquitto.org/) which supports both pure MQTT and MQTT-over-WSS (WebSockets Secure) protocols. diff --git a/content/en/user-guide/aws/iotanalytics/index.md b/content/en/user-guide/aws/iotanalytics/index.md index 94655662c6..51b773727d 100644 --- a/content/en/user-guide/aws/iotanalytics/index.md +++ b/content/en/user-guide/aws/iotanalytics/index.md @@ -16,7 +16,7 @@ IoT Analytics is a managed service that enables you to collect, store, process, It provides a set of tools to build IoT applications without having to manage the underlying infrastructure. LocalStack allows you to use the IoT Analytics APIs to create and manage channels, data stores, and pipelines in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_iotanalytics/), which provides information on the extent of IoT Analytics integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_iotanalytics" >}}), which provides information on the extent of IoT Analytics integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/iotdata/index.md b/content/en/user-guide/aws/iotdata/index.md index 2ddf33ee28..175d8d0493 100644 --- a/content/en/user-guide/aws/iotdata/index.md +++ b/content/en/user-guide/aws/iotdata/index.md @@ -11,7 +11,7 @@ IoT Data provides secure, bi-directional communication between Internet-connecte It allows you to connect your devices to the cloud and interact with them using the AWS Management Console, AWS CLI, or AWS SDKs. LocalStack allows you to use the IoT Data APIs to update, get, and delete the shadow of a thing in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_iot-data/), which provides information on the extent of IoT Data integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_iot-data" >}}), which provides information on the extent of IoT Data integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/iotwireless/index.md b/content/en/user-guide/aws/iotwireless/index.md index fbec3bcfb5..ccae3523ff 100644 --- a/content/en/user-guide/aws/iotwireless/index.md +++ b/content/en/user-guide/aws/iotwireless/index.md @@ -11,7 +11,7 @@ AWS IoT Wireless is a managed service that enables customers to connect and mana The service provides a set of APIs to manage wireless devices, gateways, and destinations. LocalStack allows you to use the IoT Wireless APIs in your local environment from creating wireless devices and gateways. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_iotwireless/), which provides information on the extent of IoT Wireless's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_iotwireless" >}}), which provides information on the extent of IoT Wireless's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/kinesis/index.md b/content/en/user-guide/aws/kinesis/index.md index 99f51e4467..500d2066f3 100644 --- a/content/en/user-guide/aws/kinesis/index.md +++ b/content/en/user-guide/aws/kinesis/index.md @@ -12,7 +12,7 @@ Kinesis Data Streams is an AWS service for ingesting, buffering, and processing It is used for applications that require real-time processing and deriving insights from data streams such as logs, metrics, user interactions, and sensor readings. LocalStack allows you to use the Kinesis Data Streams APIs in your local environment from setting up data streams and configuring data processing to building real-time applications. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_kinesis/). +The supported APIs are available on our [API coverage page]({{< ref "coverage_kinesis" >}}). Emulation for Kinesis is powered by [Kinesis Mock](https://github.com/etspaceman/kinesis-mock). diff --git a/content/en/user-guide/aws/kinesisanalytics/index.md b/content/en/user-guide/aws/kinesisanalytics/index.md index 084a53565a..53e715ad7d 100644 --- a/content/en/user-guide/aws/kinesisanalytics/index.md +++ b/content/en/user-guide/aws/kinesisanalytics/index.md @@ -17,7 +17,7 @@ Kinesis Data Analytics for SQL Applications is a service offered by Amazon Web S It allows you to apply transformations, filtering, and enrichment to streaming data using standard SQL syntax. LocalStack allows you to use the Kinesis Data Analytics APIs in your local environment. -The supported APIs is available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_kinesisanalytics/). +The supported APIs is available on our [API coverage page]({{< ref "coverage_kinesisanalytics" >}}). ## Getting started diff --git a/content/en/user-guide/aws/kinesisanalyticsv2/index.md b/content/en/user-guide/aws/kinesisanalyticsv2/index.md index 5d0b017575..a6c00da72e 100644 --- a/content/en/user-guide/aws/kinesisanalyticsv2/index.md +++ b/content/en/user-guide/aws/kinesisanalyticsv2/index.md @@ -15,7 +15,7 @@ This service was formerly known as 'Kinesis Data Analytics for Apache Flink'. [Apache Flink](https://flink.apache.org/) is a framework for building applications that process and analyze streaming data. [Managed Service for Apache Flink (MSF)](https://docs.aws.amazon.com/managed-flink/latest/java/what-is.html) is an AWS service that provides the underlying infrastructure and a hosted Apache Flink cluster that can run Apache Flink applications. -LocalStack lets you to run Flink applications locally and implements several [AWS-compatible API operations](https://docs.localstack.cloud/references/coverage/coverage_kinesisanalyticsv2/). +LocalStack lets you to run Flink applications locally and implements several [AWS-compatible API operations]({{< ref "coverage_kinesisanalyticsv2" >}}). A separate Apache Flink cluster is started in [application mode](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/deployment/overview/#application-mode) for every Managed Flink application created. Flink cluster deployment on LocalStack consists of two separate containers for [JobManager](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/concepts/flink-architecture/#jobmanager) and [TaskManager](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/concepts/flink-architecture/#taskmanagers). diff --git a/content/en/user-guide/aws/kms/index.md b/content/en/user-guide/aws/kms/index.md index 11a72cfc51..47de0f4b92 100644 --- a/content/en/user-guide/aws/kms/index.md +++ b/content/en/user-guide/aws/kms/index.md @@ -14,7 +14,7 @@ KMS allows you to create, delete, list, and update aliases, friendly names for y You can check [the official AWS documentation](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) to understand the basic terms and concepts used in the KMS. LocalStack allows you to use the KMS APIs in your local environment to create, edit, and view symmetric and asymmetric KMS keys, including HMAC keys. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_kms/), which provides information on the extent of KMS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_kms" >}}), which provides information on the extent of KMS's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/lakeformation/index.md b/content/en/user-guide/aws/lakeformation/index.md index 43ba9744d2..feac678b30 100644 --- a/content/en/user-guide/aws/lakeformation/index.md +++ b/content/en/user-guide/aws/lakeformation/index.md @@ -11,7 +11,7 @@ Lake Formation is a managed service that allows users to build, secure, and mana Lake Formation allows users to define and enforce fine-grained access controls, manage metadata, and discover and share data across multiple data sources. LocalStack allows you to use the Lake Formation APIs in your local environment to register resources, grant permissions, and list resources and permissions. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_lakeformation/), which provides information on the extent of Lake Formation's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_lakeformation" >}}), which provides information on the extent of Lake Formation's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/lambda/index.md b/content/en/user-guide/aws/lambda/index.md index 1772d51caa..05cf56ba71 100644 --- a/content/en/user-guide/aws/lambda/index.md +++ b/content/en/user-guide/aws/lambda/index.md @@ -13,7 +13,7 @@ AWS Lambda automatically scales your code to meet demand and handles server prov AWS Lambda allows you to break down your application into smaller, independent functions that integrate seamlessly with AWS services. LocalStack allows you to use the Lambda APIs to create, deploy, and test your Lambda functions. -The supported APIs are available on our [Lambda coverage page](https://docs.localstack.cloud/references/coverage/coverage_lambda/), which provides information on the extent of Lambda's integration with LocalStack. +The supported APIs are available on our [Lambda coverage page]({{< ref "coverage_lambda" >}}), which provides information on the extent of Lambda's integration with LocalStack. ## Getting started @@ -170,7 +170,7 @@ The following event sources are supported in LocalStack: The table below shows feature coverage for all supported event sources for the latest version of LocalStack. -Unlike [API operation coverage](https://docs.localstack.cloud/references/coverage/coverage_lambda/), this table illustrates the **functional and behavioural coverage** of LocalStack's Lambda Event Source Mapping implementation. +Unlike [API operation coverage]({{< ref "coverage_lambda" >}}), this table illustrates the **functional and behavioural coverage** of LocalStack's Lambda Event Source Mapping implementation. Where necessary, footnotes are used to provide additional context. @@ -211,7 +211,7 @@ Feature availability and coverage is categorized with the following system: [^1]: Read more at [Control which events Lambda sends to your function](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) [^2]: The available Metadata properties may not have full parity with AWS depending on the event source (read more at [Understanding event filtering basics](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics)). -Create a [GitHub issue](https://github.com/localstack/localstack/issues/new/choose) or reach out to [LocalStack support](https://docs.localstack.cloud/getting-started/help-and-support/) if you experience any challenges. +Create a [GitHub issue](https://github.com/localstack/localstack/issues/new/choose) or reach out to [LocalStack support]({{< ref "/getting-started/help-and-support" >}}) if you experience any challenges. ## Lambda Layers (Pro) @@ -319,7 +319,7 @@ LocalStack provides various tools to help you develop, debug, and test your AWS ## Resource Browser -The LocalStack Web Application provides a [Resource Browser](https://docs.localstack.cloud/user-guide/web-application/resource-browser/) for managing Lambda resources. +The LocalStack Web Application provides a [Resource Browser]({{< ref "/user-guide/web-application/resource-browser/" >}}) for managing Lambda resources. You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the **Resources** section, and then clicking on **Lambda** under the **Compute** section. The Resource Browser displays [Functions](https://app.localstack.cloud/resources/lambda/functions) and [Layers](https://app.localstack.cloud/resources/lambda/layers) resources. @@ -345,7 +345,7 @@ With the new implementation, the following changes have been introduced: - To run Lambda functions in LocalStack, mount the Docker socket into the LocalStack container. Add the following Docker volume mount to your LocalStack startup configuration: `/var/run/docker.sock:/var/run/docker.sock`. - You can find an example of this configuration in our official [`docker-compose.yml` file](https://docs.localstack.cloud/getting-started/installation/#starting-localstack-with-docker-compose). + You can find an example of this configuration in our official [`docker-compose.yml` file]({{< ref "/getting-started/installation/#starting-localstack-with-docker-compose" >}}). - The `v2` provider discontinues Lambda Executor Modes such as `LAMBDA_EXECUTOR=local`. Previously, this mode was used as a fallback when the Docker socket was unavailable in the LocalStack container, but many users unintentionally used it instead of the configured `LAMBDA_EXECUTOR=docker`. The new provider now behaves similarly to the old `docker-reuse` executor and does not require such configuration. @@ -369,7 +369,7 @@ With the new implementation, the following changes have been introduced: The configuration `LAMBDA_SYNCHRONOUS_CREATE=1` can force synchronous function creation, but it is not recommended. - LocalStack's Lambda implementation, allows you to customize the Lambda execution environment using the [Lambda Extensions API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-extensions-api.html). This API allows for advanced monitoring, observability, or developer tooling, providing greater control and flexibility over your Lambda functions. - Lambda functions can also be run on hosts with [multi-architecture support](https://docs.localstack.cloud/references/arm64-support/#lambda-multi-architecture-support), allowing you to leverage LocalStack's Lambda API to develop and test Lambda functions with high parity. + Lambda functions can also be run on hosts with [multi-architecture support]({{< ref "/references/arm64-support/#lambda-multi-architecture-support" >}}), allowing you to leverage LocalStack's Lambda API to develop and test Lambda functions with high parity. The following configuration options from the old provider are discontinued in the new provider: diff --git a/content/en/user-guide/aws/managedblockchain/index.md b/content/en/user-guide/aws/managedblockchain/index.md index 813662c320..c87ea6f015 100644 --- a/content/en/user-guide/aws/managedblockchain/index.md +++ b/content/en/user-guide/aws/managedblockchain/index.md @@ -10,7 +10,7 @@ Managed Blockchain (AMB) is a managed service that enables the creation and mana Blockchain enables the development of applications in which multiple entities can conduct transactions and exchange data securely and transparently, eliminating the requirement for a central, trusted authority. LocalStack allows you to use the AMB APIs to develop and deploy decentralized applications in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_managedblockchain/), which provides information on the extent of AMB integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_managedblockchain" >}}), which provides information on the extent of AMB integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/mediastore/index.md b/content/en/user-guide/aws/mediastore/index.md index caa7f6f4ce..1e4c070407 100644 --- a/content/en/user-guide/aws/mediastore/index.md +++ b/content/en/user-guide/aws/mediastore/index.md @@ -12,7 +12,7 @@ It provides a reliable way to store, manage, and serve media assets, such as aud MediaStore seamlessly integrates with other AWS services like Elemental MediaConvert, Elemental MediaLive, Elemental MediaPackage, and CloudFront. LocalStack allows you to use the Elemental MediaStore APIs as a high-performance storage solution for media content in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_mediastore/), which provides information on the extent of Elemental MediaStore integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_mediastore" >}}), which provides information on the extent of Elemental MediaStore integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/memorydb/index.md b/content/en/user-guide/aws/memorydb/index.md index 2cd6bd850c..1822265453 100644 --- a/content/en/user-guide/aws/memorydb/index.md +++ b/content/en/user-guide/aws/memorydb/index.md @@ -11,7 +11,7 @@ MemoryDB is a fully managed, Redis-compatible, in-memory database tailored for w It streamlines the deployment and management of in-memory databases within the AWS cloud environment, acting as a replacement for using a cache in front of a database for improved durability and performance. LocalStack provides support for the main MemoryDB APIs surrounding cluster creation, allowing developers to utilize the MemoryDB functionalities in their local development environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_memorydb/), which provides information on the extent of MemoryDB's integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_memorydb" >}}), which provides information on the extent of MemoryDB's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/mq/index.md b/content/en/user-guide/aws/mq/index.md index 1f839092c1..86ab8fe56a 100644 --- a/content/en/user-guide/aws/mq/index.md +++ b/content/en/user-guide/aws/mq/index.md @@ -12,7 +12,7 @@ It facilitates the exchange of messages between various components of distribute AWS MQ supports popular messaging protocols like MQTT, AMQP, and STOMP, making it suitable for a wide range of messaging use cases. LocalStack allows you to use the MQ APIs to implement pub/sub messaging, request/response patterns, or distributed event-driven architectures in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_mq/), which provides information on the extent of MQ integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_mq" >}}), which provides information on the extent of MQ integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/msk/index.md b/content/en/user-guide/aws/msk/index.md index e6454a067e..e1c7e33b3c 100644 --- a/content/en/user-guide/aws/msk/index.md +++ b/content/en/user-guide/aws/msk/index.md @@ -13,7 +13,7 @@ MSK offers a centralized platform to facilitate seamless communication between v MSK also features automatic scaling and built-in monitoring, allowing users to build robust, high-throughput data pipelines. LocalStack allows you to use the MSK APIs in your local environment to spin up Kafka clusters on the local machine, create topics for exchanging messages, and define event source mappings that trigger Lambda functions when messages are received on a certain topic. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_kafka/), which provides information on the extent of MSK's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_kafka" >}}), which provides information on the extent of MSK's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/mwaa/index.md b/content/en/user-guide/aws/mwaa/index.md index 2a7131d55e..457b980163 100644 --- a/content/en/user-guide/aws/mwaa/index.md +++ b/content/en/user-guide/aws/mwaa/index.md @@ -12,7 +12,7 @@ Managed Workflows for Apache Airflow (MWAA) is a fully managed service by AWS th MWAA leverages the familiar Airflow features and integrations while integrating with S3, Glue, Redshift, Lambda, and other AWS services to build data pipelines and orchestrate data processing workflows in the cloud. LocalStack allows you to use the MWAA APIs in your local environment to allow the setup and operation of data pipelines. -The supported APIs are available on the [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_mwaa/). +The supported APIs are available on the [API coverage page]({{< ref "coverage_mwaa" >}}). ## Getting started diff --git a/content/en/user-guide/aws/neptune/index.md b/content/en/user-guide/aws/neptune/index.md index c0a9af3ea6..58f8469933 100644 --- a/content/en/user-guide/aws/neptune/index.md +++ b/content/en/user-guide/aws/neptune/index.md @@ -13,7 +13,7 @@ It is designed for storing and querying highly connected data for applications t Neptune supports popular graph query languages like Gremlin and SPARQL, making it compatible with a wide range of graph applications and tools. LocalStack allows you to use the Neptune APIs in your local environment to support both property graph and RDF graph models. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_neptune/), which provides information on the extent of Neptune's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_neptune" >}}), which provides information on the extent of Neptune's integration with LocalStack. The following versions of Neptune engine are supported by LocalStack: @@ -144,7 +144,7 @@ if __name__ == '__main__': Amazon Neptune resources with IAM DB authentication enabled require all requests to use AWS Signature Version 4. -When LocalStack starts with [IAM enforcement enabled](https://docs.localstack.cloud/user-guide/security-testing/), the Neptune database checks user permissions before granting access. +When LocalStack starts with [IAM enforcement enabled]({{< ref "/user-guide/security-testing" >}}), the Neptune database checks user permissions before granting access. The following Gremlin query actions are available for database engine versions `1.3.2.0` and higher: ```json @@ -221,7 +221,7 @@ $ awscurl "https://localhost.localstack.cloud:4510/gremlin?gremlin=g.V().count() {{< callout "note" >}} If Gremlin Server is installed in your LocalStack environment, you must delete it and restart LocalStack. -You can find your LocalStack volume location on the [LocalStack filesystem documentation](https://docs.localstack.cloud/references/filesystem/#localstack-volume). +You can find your LocalStack volume location on the [LocalStack filesystem documentation]({{< ref "/references/filesystem/#localstack-volume" >}}). {{< command >}} $ rm -rf /lib/tinkerpop {{< /command >}} diff --git a/content/en/user-guide/aws/opensearch/index.md b/content/en/user-guide/aws/opensearch/index.md index 70199ba4a6..9a94b81df7 100644 --- a/content/en/user-guide/aws/opensearch/index.md +++ b/content/en/user-guide/aws/opensearch/index.md @@ -12,7 +12,7 @@ OpenSearch Service is an open-source search and analytics engine, offering devel OpenSearch Service also offers log analytics, real-time application monitoring, and clickstream analysis. LocalStack allows you to use the OpenSearch Service APIs in your local environment to create, manage, and operate the OpenSearch clusters. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_opensearch/), which provides information on the extent of OpenSearch's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_opensearch" >}}), which provides information on the extent of OpenSearch's integration with LocalStack. The following versions of OpenSearch Service are supported by LocalStack: diff --git a/content/en/user-guide/aws/pca/index.md b/content/en/user-guide/aws/pca/index.md index 3320b9631e..ec778e853f 100644 --- a/content/en/user-guide/aws/pca/index.md +++ b/content/en/user-guide/aws/pca/index.md @@ -12,7 +12,7 @@ ACM PCA extends ACM's certificate management capabilities to private certificate LocalStack allows you to use the ACM PCA APIs to create, list, and delete private certificates. You can creating, describing, tagging, and listing tags for a CA using ACM PCA. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm-pca/), which provides information on the extent of ACM PCA's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_acm-pca" >}}), which provides information on the extent of ACM PCA's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/pinpoint/index.md b/content/en/user-guide/aws/pinpoint/index.md index 79732063b7..d11d67f16a 100644 --- a/content/en/user-guide/aws/pinpoint/index.md +++ b/content/en/user-guide/aws/pinpoint/index.md @@ -18,7 +18,7 @@ Pinpoint is a customer engagement service to facilitate communication across mul Pinpoint allows developers to create and manage customer segments based on various attributes, such as user behavior and demographics, while integrating with other AWS services to send targeted messages to customers. LocalStack allows you to mock the Pinpoint APIs in your local environment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_pinpoint/), which provides information on the extent of Pinpoint's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_pinpoint" >}}), which provides information on the extent of Pinpoint's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/ram/index.md b/content/en/user-guide/aws/ram/index.md index cb50d48c13..4d1db6dd03 100644 --- a/content/en/user-guide/aws/ram/index.md +++ b/content/en/user-guide/aws/ram/index.md @@ -9,9 +9,7 @@ tags: ["Ultimate"] Resource Access Manager (RAM) helps resources to be shared across AWS accounts, within or across organizations. On AWS, RAM is an abstraction on top of AWS Identity and Access Management (IAM) which can manage resource-based policies to supported resource types. - -RAM is available in LocalStack. -The supported API operations can be found on the [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ram/). +The API operations supported by LocalStack can be found on the [API coverage page]({{< ref "coverage_ram" >}}). ## Getting started diff --git a/content/en/user-guide/aws/rds/index.md b/content/en/user-guide/aws/rds/index.md index 95c0282ba8..8a772feaf9 100644 --- a/content/en/user-guide/aws/rds/index.md +++ b/content/en/user-guide/aws/rds/index.md @@ -13,7 +13,7 @@ RDS allows you to deploy and manage various relational database engines like MyS RDS handles routine database tasks such as provisioning, patching, backup, recovery, and scaling. LocalStack allows you to use the RDS APIs in your local environment to create and manage RDS clusters and instances for testing & integration purposes. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_rds/), which provides information on the extent of RDS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_rds" >}}), which provides information on the extent of RDS's integration with LocalStack. {{< callout >}} We’ve introduced a new native RDS provider in LocalStack and made it the default. diff --git a/content/en/user-guide/aws/redshift/index.md b/content/en/user-guide/aws/redshift/index.md index f82f202191..507b9e8c50 100644 --- a/content/en/user-guide/aws/redshift/index.md +++ b/content/en/user-guide/aws/redshift/index.md @@ -12,7 +12,7 @@ RedShift is fully managed by AWS and serves as a petabyte-scale service which al The query results can be saved to an S3 Data Lake while additional analytics can be provided by Athena or SageMaker. LocalStack allows you to use the RedShift APIs in your local environment to analyze structured and semi-structured data across local data warehouses and data lakes. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_redshift/), which provides information on the extent of RedShift's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_redshift" >}}), which provides information on the extent of RedShift's integration with LocalStack. {{< callout "Note" >}} Users on Free plan can use RedShift APIs in LocalStack for basic mocking and testing. diff --git a/content/en/user-guide/aws/resource_groups/index.md b/content/en/user-guide/aws/resource_groups/index.md index 6b49ce30d4..b37292298a 100644 --- a/content/en/user-guide/aws/resource_groups/index.md +++ b/content/en/user-guide/aws/resource_groups/index.md @@ -14,7 +14,7 @@ Resource Groups in AWS provide two types of queries that developers can use to b With Tag-based queries, developers can organize resources based on common attributes or characteristics, while CloudFormation stack-based queries allow developers to group resources that are deployed together as part of a CloudFormation stack. LocalStack allows you to use the Resource Groups APIs in your local environment to group and categorize resources based on criteria such as tags, resource types, regions, or custom attributes. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_resource-groups/), which provides information on the extent of Resource Group's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_resource-groups" >}}), which provides information on the extent of Resource Group's integration with LocalStack. ## Getting Started diff --git a/content/en/user-guide/aws/route53/index.md b/content/en/user-guide/aws/route53/index.md index 03928be4ca..8496ab9468 100644 --- a/content/en/user-guide/aws/route53/index.md +++ b/content/en/user-guide/aws/route53/index.md @@ -14,8 +14,8 @@ In addition to basic DNS functionality, Route 53 offers advanced features like h Route 53 integrates seamlessly with other AWS services, such as route traffic to CloudFront distributions, S3 buckets configured for static website hosting, EC2 instances, and more. LocalStack allows you to use the Route53 APIs in your local environment to create hosted zones and to manage DNS entries. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_route53/), which provides information on the extent of Route53's integration with LocalStack. -LocalStack also integrates with our DNS server to respond to DNS queries with these domains. +The supported APIs are available on our [API coverage page]({{< ref "coverage_route53" >}}), which provides information on the extent of Route53's integration with LocalStack. +LocalStack also integrates with its DNS server to respond to DNS queries with these domains. {{< callout "note">}} LocalStack CLI does not publish port `53` anymore by default. diff --git a/content/en/user-guide/aws/route53resolver/index.md b/content/en/user-guide/aws/route53resolver/index.md index 5347282610..dfebf69c53 100644 --- a/content/en/user-guide/aws/route53resolver/index.md +++ b/content/en/user-guide/aws/route53resolver/index.md @@ -13,7 +13,7 @@ Route 53 Resolver forwards DNS queries for domain names to the appropriate DNS s Route 53 Resolver can be used to resolve domain names between your VPC and your network, and to resolve domain names between your VPCs. LocalStack allows you to use the Route 53 Resolver endpoints in your local environment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_route53resolver/), which provides information on the extent of Route 53 Resolver's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_route53resolver" >}}), which provides information on the extent of Route 53 Resolver's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/s3/index.md b/content/en/user-guide/aws/s3/index.md index f61e8c37d0..118d83d499 100644 --- a/content/en/user-guide/aws/s3/index.md +++ b/content/en/user-guide/aws/s3/index.md @@ -14,13 +14,13 @@ Each object or file within S3 encompasses essential attributes such as a unique S3 can store unlimited objects, allowing you to store, retrieve, and manage your data in a highly adaptable and reliable manner. LocalStack allows you to use the S3 APIs in your local environment to create new buckets, manage your S3 objects, and test your S3 configurations locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_s3/), which provides information on the extent of S3's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_s3" >}}), which provides information on the extent of S3's integration with LocalStack. ## Getting started This guide is designed for users new to S3 and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script. -Start your LocalStack container using your [preferred method](https://docs.localstack.cloud/getting-started/installation/). +Start your LocalStack container using your [preferred method]({{< ref "getting-started/installation" >}}). We will demonstrate how you can create an S3 bucket, manage S3 objects, and generate pre-signed URLs for S3 objects. ### Create an S3 bucket @@ -143,12 +143,12 @@ By default, most SDKs will try to use **Virtual-Hosted style** requests and prep However, if the endpoint is not prefixed by `s3.`, LocalStack will not be able to understand the request and it will most likely result in an error. You can either change the endpoint to an S3-specific one, or configure your SDK to use **Path style** requests instead. -Check out our [SDK documentation](https://docs.localstack.cloud/user-guide/integrations/sdks/) to learn how you can configure AWS SDKs to access LocalStack and S3. +Check out our [SDK documentation]({{< ref "sdks" >}}) to learn how you can configure AWS SDKs to access LocalStack and S3. {{< callout "tip" >}} While using [AWS SDKs](https://aws.amazon.com/developer/tools/#SDKs), you would need to configure the `ForcePathStyle` parameter to `true` in the S3 client configuration to use **Path style** requests. If you want to use virtual host addressing of buckets, you can remove `ForcePathStyle` from the configuration. -The `ForcePathStyle` parameter name can vary between SDK and languages, please check our [SDK documentation](https://docs.localstack.cloud/user-guide/integrations/sdks/) +The `ForcePathStyle` parameter name can vary between SDK and languages, please check our [SDK documentation]({{< ref "sdks" >}}) {{< /callout >}} If your endpoint is not prefixed with `s3.`, all requests are treated as **Path style** requests. @@ -277,7 +277,7 @@ docker run \ {{< /tabpane >}} The S3 Docker image has similar parity with the S3 APIs supported by LocalStack Docker image. -You can use similar [configuration options](https://docs.localstack.cloud/references/configuration/#s3) to alter the behaviour of the S3 Docker image, such as `DEBUG` or `S3_SKIP_SIGNATURE_VALIDATION`. +You can use similar [configuration options]({{< ref "configuration/#s3" >}}) to alter the behaviour of the S3 Docker image, such as `DEBUG` or `S3_SKIP_SIGNATURE_VALIDATION`. {{< callout >}} The S3 Docker image does not support persistence, and all data is lost when the container is stopped. @@ -303,7 +303,7 @@ However, LocalStack does not support the actual encryption and decryption of obj ## Resource Browser -The LocalStack Web Application provides a [Resource Browser](https://docs.localstack.cloud/user-guide/web-application/resource-browser/) for managing S3 buckets & configurations. +The LocalStack Web Application provides a [Resource Browser]({{< ref "resource-browser" >}}) for managing S3 buckets & configurations. You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the **Resources** section, and then clicking on **S3** under the **Storage** section. S3 Resource Browser @@ -324,4 +324,4 @@ The following code snippets and sample applications provide practical examples o - [Serverless Transcription application using Transcribe, S3, Lambda, SQS, and SES](https://github.com/localstack/sample-transcribe-app) - [Query data in S3 Bucket with Amazon Athena, Glue Catalog & CloudFormation](https://github.com/localstack/query-data-s3-athena-glue-sample) - [Serverless Image Resizer with Lambda, S3, SNS, and SES](https://github.com/localstack/serverless-image-resizer) -- [Host a static website locally using Simple Storage Service (S3) and Terraform with LocalStack](https://docs.localstack.cloud/tutorials/s3-static-website-terraform/) +- [Host a static website locally using Simple Storage Service (S3) and Terraform with LocalStack]({{< ref "s3-static-website-terraform" >}}) diff --git a/content/en/user-guide/aws/sagemaker/index.md b/content/en/user-guide/aws/sagemaker/index.md index eb4c42efde..6ff02246f1 100644 --- a/content/en/user-guide/aws/sagemaker/index.md +++ b/content/en/user-guide/aws/sagemaker/index.md @@ -11,7 +11,7 @@ Amazon SageMaker is a fully managed service provided by Amazon Web Services (AWS It streamlines the machine learning development process, reduces the time and effort required to build and deploy models, and offers the scalability and flexibility needed for large-scale machine learning projects in the AWS cloud. LocalStack provides a local version of the SageMaker API, which allows running jobs to create machine learning models (e.g., using PyTorch) and to deploy them. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_sagemaker/), which provides information on the extent of Sagemaker's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_sagemaker" >}}), which provides information on the extent of Sagemaker's integration with LocalStack. {{< callout >}} LocalStack supports custom-built models in SageMaker. @@ -92,7 +92,7 @@ You can also invoke a serverless endpoint, by navigating to `main.py` and uncomm ## Resource Browser -The LocalStack Web Application provides a [Resource Browser](https://docs.localstack.cloud/user-guide/web-application/resource-browser/) for managing Lambda resources. +The LocalStack Web Application provides a [Resource Browser]({{< ref "resource-browser" >}}) for managing Lambda resources. You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the **Resources** section, and then clicking on **Sagemaker** under the **Compute** section. The Resource Browser displays Models, Endpoint Configurations and Endpoint. diff --git a/content/en/user-guide/aws/scheduler/index.md b/content/en/user-guide/aws/scheduler/index.md index 58b00fc6b8..09ebf360c5 100644 --- a/content/en/user-guide/aws/scheduler/index.md +++ b/content/en/user-guide/aws/scheduler/index.md @@ -12,7 +12,7 @@ You can use EventBridge Scheduler to create schedules that run at a specific tim You can also use EventBridge Scheduler to create schedules that run within a flexible time window. LocalStack allows you to use the Scheduler APIs in your local environment to create and run schedules. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_scheduler/), which provides information on the extent of EventBridge Scheduler's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_scheduler" >}}), which provides information on the extent of EventBridge Scheduler's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/secretsmanager/index.md b/content/en/user-guide/aws/secretsmanager/index.md index 5adb6e4174..bc05e4335d 100644 --- a/content/en/user-guide/aws/secretsmanager/index.md +++ b/content/en/user-guide/aws/secretsmanager/index.md @@ -13,7 +13,7 @@ Secrets Manager integrates seamlessly with AWS services, making it easier to man Secrets Manager supports automatic secret rotation, replacing long-term secrets with short-term ones to mitigate the risk of compromise without requiring application updates. LocalStack allows you to use the Secrets Manager APIs in your local environment to manage, retrieve, and rotate secrets. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_secretsmanager/), which provides information on the extent of Secrets Manager's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_secretsmanager" >}}), which provides information on the extent of Secrets Manager's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/serverlessrepo/index.md b/content/en/user-guide/aws/serverlessrepo/index.md index ebd0f2daab..c7f3f860a7 100644 --- a/content/en/user-guide/aws/serverlessrepo/index.md +++ b/content/en/user-guide/aws/serverlessrepo/index.md @@ -13,7 +13,7 @@ Using Serverless Application Repository, developers can build & publish applicat Serverless Application Repository provides a user-friendly interface to search, filter, and browse through a diverse catalog of serverless applications. LocalStack allows you to use the Serverless Application Repository APIs in your local environment to create, update, delete, and list serverless applications and components. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_serverlessrepo/), which provides information on the extent of Serverless Application Repository's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_serverlessrepo" >}}), which provides information on the extent of Serverless Application Repository's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/servicediscovery/index.md b/content/en/user-guide/aws/servicediscovery/index.md index ede2f6151c..acc5c8f0c1 100644 --- a/content/en/user-guide/aws/servicediscovery/index.md +++ b/content/en/user-guide/aws/servicediscovery/index.md @@ -13,7 +13,7 @@ Service Discovery allows for a centralized mechanism for dynamically registering Service discovery uses Cloud Map API actions to manage HTTP and DNS namespaces for services, enabling automatic registration and discovery of services running in the cluster. LocalStack allows you to use the Service Discovery APIs in your local environment to monitor and manage your services across various environments and network topologies. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_servicediscovery/), which provides information on the extent of Service Discovery's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_servicediscovery" >}}), which provides information on the extent of Service Discovery's integration with LocalStack. ## Getting Started diff --git a/content/en/user-guide/aws/ses/index.md b/content/en/user-guide/aws/ses/index.md index cb8bc61e29..f4509be4db 100644 --- a/content/en/user-guide/aws/ses/index.md +++ b/content/en/user-guide/aws/ses/index.md @@ -11,7 +11,7 @@ persistence: supported Simple Email Service (SES) is an emailing service that can be integrated with other cloud-based services. It provides API to facilitate email templating, sending bulk emails and more. -The supported APIs are available on the API coverage page for [SESv1](https://docs.localstack.cloud/references/coverage/coverage_ses/) and [SESv2](https://docs.localstack.cloud/references/coverage/coverage_sesv2/). +The supported APIs are available on the API coverage page for [SESv1]({{< ref "coverage_ses" >}}) and [SESv2]({{< ref "coverage_sesv2" >}}). {{< callout "Note" >}} Users on Free plan can use SES V1 APIs in LocalStack for basic mocking and testing. diff --git a/content/en/user-guide/aws/shield/index.md b/content/en/user-guide/aws/shield/index.md index fe6eec0289..3b32f837c4 100644 --- a/content/en/user-guide/aws/shield/index.md +++ b/content/en/user-guide/aws/shield/index.md @@ -12,7 +12,7 @@ Shield provides always-on detection and inline mitigations that minimize applica Shield detection and mitigation is designed to protect against threats, including ones that are not known to the service at the time of detection. LocalStack allows you to use the Shield APIs in your local environment, and provides a simple way to mock and test the Shield service locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_shield/), which provides information on the extent of Shield's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_shield" >}}), which provides information on the extent of Shield's integration with LocalStack. ## Getting Started diff --git a/content/en/user-guide/aws/sns/index.md b/content/en/user-guide/aws/sns/index.md index f9f299f8dc..7b09136866 100644 --- a/content/en/user-guide/aws/sns/index.md +++ b/content/en/user-guide/aws/sns/index.md @@ -12,7 +12,7 @@ Simple Notification Service (SNS) is a serverless messaging service that can dis SNS employs the Publish/Subscribe, an asynchronous messaging pattern that decouples services that produce events from services that process events. LocalStack allows you to use the SNS APIs in your local environment to coordinate the delivery of messages to subscribing endpoints or clients. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_sns/), which provides information on the extent of SNS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_sns" >}}), which provides information on the extent of SNS's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/sqs/index.md b/content/en/user-guide/aws/sqs/index.md index 455db885cb..0b46990bbc 100644 --- a/content/en/user-guide/aws/sqs/index.md +++ b/content/en/user-guide/aws/sqs/index.md @@ -14,7 +14,7 @@ It allows you to decouple different components of your applications by enabling SQS allows you to reliably send, store, and receive messages with support for standard and FIFO queues. LocalStack allows you to use the SQS APIs in your local environment to integrate and decouple distributed systems via hosted queues. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_sqs/), which provides information on the extent of SQS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_sqs" >}}), which provides information on the extent of SQS's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/ssm/index.md b/content/en/user-guide/aws/ssm/index.md index 99503f9b02..60560f3877 100644 --- a/content/en/user-guide/aws/ssm/index.md +++ b/content/en/user-guide/aws/ssm/index.md @@ -12,7 +12,7 @@ Systems Manager (SSM) is a management service provided by Amazon Web Services th SSM simplifies tasks related to system and application management, patching, configuration, and automation, allowing you to maintain the health and compliance of your environment. LocalStack allows you to use the SSM APIs in your local environment to run operational tasks on the Dockerized instances. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ssm/), which provides information on the extent of SSM's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_ssm" >}}), which provides information on the extent of SSM's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/stepfunctions/index.md b/content/en/user-guide/aws/stepfunctions/index.md index 3353f6f577..d5ae8d21c9 100644 --- a/content/en/user-guide/aws/stepfunctions/index.md +++ b/content/en/user-guide/aws/stepfunctions/index.md @@ -13,7 +13,7 @@ It provides a JSON-based structured language called Amazon States Language (ASL) Thus making it easier to build and maintain complex and distributed applications. LocalStack allows you to use the Step Functions APIs in your local environment to create, execute, update, and delete state machines locally. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_stepfunctions/), which provides information on the extent of Step Function's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_stepfunctions" >}}), which provides information on the extent of Step Function's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/sts/index.md b/content/en/user-guide/aws/sts/index.md index 4cc81481f9..c8e0dd5264 100644 --- a/content/en/user-guide/aws/sts/index.md +++ b/content/en/user-guide/aws/sts/index.md @@ -13,7 +13,7 @@ STS implements fine-grained access control and reduce the exposure of your long- The temporary credentials, known as security tokens, can be used to access AWS services and resources based on the permissions specified in the associated policies. LocalStack allows you to use the STS APIs in your local environment to request security tokens, manage permissions, integrate with identity providers, and more. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_sts/), which provides information on the extent of STS's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_sts" >}}), which provides information on the extent of STS's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/support/index.md b/content/en/user-guide/aws/support/index.md index 1d3869eeeb..63e618908f 100644 --- a/content/en/user-guide/aws/support/index.md +++ b/content/en/user-guide/aws/support/index.md @@ -14,10 +14,10 @@ You can further automate your support workflow using various AWS services, such LocalStack allows you to use the Support APIs in your local environment to create and manage new cases, while testing your configurations locally. LocalStack provides a mock implementation via a mock Support Center provided by [Moto](https://docs.getmoto.org/en/latest/docs/services/support.html), and does not create real cases in the AWS. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_support/), which provides information on the extent of Support API's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_support" >}}), which provides information on the extent of Support API's integration with LocalStack. {{< callout >}} -For technical support with LocalStack, you can reach out through our [support channels](https://docs.localstack.cloud/getting-started/help-and-support/). +For technical support with LocalStack, you can reach out through our [support channels]({{< ref "help-and-support" >}}). It's important to note that LocalStack doesn't offer a programmatic interface to create support cases, and this documentation is only intended to demonstrate how you can use and mock the AWS Support APIs in your local environment. {{< /callout >}} diff --git a/content/en/user-guide/aws/swf/index.md b/content/en/user-guide/aws/swf/index.md index 930b002ce2..0403858965 100644 --- a/content/en/user-guide/aws/swf/index.md +++ b/content/en/user-guide/aws/swf/index.md @@ -13,7 +13,7 @@ SWF allows you to define workflows in a way that's separate from the actual appl SWF also provides a programming framework to design, coordinate, and execute workflows that involve multiple tasks, steps, and decision points. LocalStack allows you to use the SWF APIs in your local environment to monitor and manage workflow design, task coordination, activity implementation, and error handling. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_swf/), which provides information on the extent of SWF's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_swf" >}}), which provides information on the extent of SWF's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/textract/index.md b/content/en/user-guide/aws/textract/index.md index c813b35c1f..0f218da3bf 100644 --- a/content/en/user-guide/aws/textract/index.md +++ b/content/en/user-guide/aws/textract/index.md @@ -10,7 +10,7 @@ Textract is a machine learning service that automatically extracts text, forms, It simplifies the process of extracting valuable information from a variety of document types, enabling applications to quickly analyze and understand document content. LocalStack allows you to mock Textract APIs in your local environment. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_textract/), providing details on the extent of Textract's integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_textract" >}}), providing details on the extent of Textract's integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/timestream/index.md b/content/en/user-guide/aws/timestream/index.md index 6e94adf479..bf5c3cf3f4 100644 --- a/content/en/user-guide/aws/timestream/index.md +++ b/content/en/user-guide/aws/timestream/index.md @@ -15,7 +15,7 @@ LocalStack contains basic support for Timestream time series databases, includin * Writing records to tables * Querying timeseries data from tables -The supported APIs are available on our API Coverage Page ([Timestream-Query](https://docs.localstack.cloud/references/coverage/coverage_timestream-query/)/[Timestream-Write](https://docs.localstack.cloud/references/coverage/coverage_timestream-write/)), which provides information on the extent of Timestream integration with LocalStack. +The supported APIs are available on our API Coverage Page ([Timestream-Query]({{< ref "coverage_timestream-query" >}})/[Timestream-Write]({{< ref "coverage_timestream-write" >}})), which provides information on the extent of Timestream integration with LocalStack. ## Getting Started @@ -70,6 +70,6 @@ The Resource Browser allows you to perform the following actions: ## Current Limitations -LocalStack's Timestream implementation is under active development and only supports a limited set of operations, please refer to the API Coverage pages for an up-to-date list of implemented and tested functions within [Timestream-Query](https://docs.localstack.cloud/references/coverage/coverage_timestream-query/) and [Timestream-Write](https://docs.localstack.cloud/references/coverage/coverage_timestream-write/). +LocalStack's Timestream implementation is under active development and only supports a limited set of operations, please refer to the API Coverage pages for an up-to-date list of implemented and tested functions within [Timestream-Query]({{< ref "coverage_timestream-query" >}}) and [Timestream-Write]({{< ref "coverage_timestream-write" >}}). If you have a usecase that uses Timestream but doesn't work with our implementation yet, we encourage you to [get in touch](https://localstack.cloud/contact/), so we can streamline any operations you rely on. diff --git a/content/en/user-guide/aws/transcribe/index.md b/content/en/user-guide/aws/transcribe/index.md index e2a34c1f9a..331c4c58b7 100644 --- a/content/en/user-guide/aws/transcribe/index.md +++ b/content/en/user-guide/aws/transcribe/index.md @@ -12,7 +12,7 @@ Transcribe is a service provided by AWS that offers automatic speech recognition It enables developers to convert spoken language into written text, making it valuable for a wide range of applications, from transcription services to voice analytics. LocalStack allows you to use the Transcribe APIs for offline speech-to-text jobs in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_transcribe/), which provides information on the extent of Transcribe integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_transcribe" >}}), which provides information on the extent of Transcribe integration with LocalStack. LocalStack Transcribe uses an offline speech-to-text library called [Vosk](https://alphacephei.com/vosk/). It requires an active internet connection to download the language model. diff --git a/content/en/user-guide/aws/verifiedpermissions/index.md b/content/en/user-guide/aws/verifiedpermissions/index.md index 927ab5007b..c94cf47c99 100644 --- a/content/en/user-guide/aws/verifiedpermissions/index.md +++ b/content/en/user-guide/aws/verifiedpermissions/index.md @@ -12,7 +12,7 @@ It helps secure applications by moving authorization logic outside the app and m It checks if a principal can take an action on a resource in a specific context in your application. LocalStack allows you to use the Verified Permissions APIs in your local environment to test your authorization logic, with integrations with other AWS services like Cognito. -The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_verifiedpermissions/), which provides information on the extent of Verified Permissions' integration with LocalStack. +The supported APIs are available on our [API coverage page]({{< ref "coverage_verifiedpermissions" >}}), which provides information on the extent of Verified Permissions' integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/waf/index.md b/content/en/user-guide/aws/waf/index.md index 666f283958..ca7b2ce3b1 100644 --- a/content/en/user-guide/aws/waf/index.md +++ b/content/en/user-guide/aws/waf/index.md @@ -11,7 +11,7 @@ Web Application Firewall (WAF) is a service provided by Amazon Web Services (AWS WAFv2 is the latest version of WAF, and it allows you to specify a single set of rules to protect your web applications, APIs, and mobile applications from common attack patterns, such as SQL injection and cross-site scripting. LocalStack allows you to use the WAFv2 APIs for offline web application firewall jobs in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_wafv2/), which provides information on the extent of WAFv2 integration with LocalStack. +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_wafv2" >}}), which provides information on the extent of WAFv2 integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/aws/xray/index.md b/content/en/user-guide/aws/xray/index.md index 54adb1c38c..16f28f68fa 100644 --- a/content/en/user-guide/aws/xray/index.md +++ b/content/en/user-guide/aws/xray/index.md @@ -20,7 +20,7 @@ The X-Ray API can then be used to retrieve traces originating from different app LocalStack allows you to use the X-Ray APIs to send and retrieve trace segments in your local environment. -The supported APIs are available on our [API Coverage Page](https://docs.localstack.cloud/references/coverage/coverage_xray/), +The supported APIs are available on our [API Coverage Page]({{< ref "coverage_xray" >}}), which provides information on the extent of X-Ray integration with LocalStack. ## Getting started diff --git a/content/en/user-guide/chaos-engineering/chaos-api/index.md b/content/en/user-guide/chaos-engineering/chaos-api/index.md index 362af22c0f..0928f82299 100644 --- a/content/en/user-guide/chaos-engineering/chaos-api/index.md +++ b/content/en/user-guide/chaos-engineering/chaos-api/index.md @@ -26,7 +26,7 @@ Furthermore, the Chaos API can also be configured to add a network latency for a 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]({{< ref "/getting-started/installation/#localstack-cli" >}}) & [LocalStack Auth Token]({{< ref "/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/content/en/user-guide/ci/_index.md b/content/en/user-guide/ci/_index.md index 982a3e9e60..07fb75733f 100644 --- a/content/en/user-guide/ci/_index.md +++ b/content/en/user-guide/ci/_index.md @@ -34,7 +34,7 @@ You can enrich the test reports created by your testing framework with traces an ## CI images 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. +The images are available on [Docker Hub](https://hub.docker.com/r/localstack/localstack/tags), and comprehensive documentation is available on our [Docker images]({{< ref "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. diff --git a/content/en/user-guide/ci/github-actions/index.md b/content/en/user-guide/ci/github-actions/index.md index 8c5262065a..f0fea9421e 100644 --- a/content/en/user-guide/ci/github-actions/index.md +++ b/content/en/user-guide/ci/github-actions/index.md @@ -175,7 +175,7 @@ More information about state import and export [here](/user-guide/state-manageme ### Running Lambdas targeting the `arm64` architecture Deploying Lambdas targeting the `arm64` architecture on GitHub Actions can pose challenges. -While the [`LAMBDA_IGNORE_ARCHITECTURE` configuration](https://docs.localstack.cloud/references/configuration/#lambda) is an option for cross-architecture compatible Lambdas, it may not be suitable for statically compiled Lambdas. +While the [`LAMBDA_IGNORE_ARCHITECTURE` configuration]({{< ref "/references/configuration/#lambda" >}}) is an option for cross-architecture compatible Lambdas, it may not be suitable for statically compiled Lambdas. To address this, users are recommended to leverage Docker's [`setup-qemu-action`](https://github.com/docker/setup-qemu-action) to enable emulation for the `arm64` architecture. It's important to note that using this approach may result in significantly slower build times. 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 c6930fb08f..4a3754b84c 100644 --- a/content/en/user-guide/cloud-sandbox/application-previews/index.md +++ b/content/en/user-guide/cloud-sandbox/application-previews/index.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) +- [Creating ephemeral application previews with LocalStack and GitHub Actions]({{< ref "/tutorials/ephemeral-application-previews" >}}) and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway) diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md b/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md index 994cc8149c..bafbbd924d 100644 --- a/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md +++ b/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.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 {{< /command >}} -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]({{< ref "/user-guide/integrations/aws-cdk" >}}), [SAM CLI]({{< ref "/user-guide/integrations/aws-sam" >}}), and [Terraform]({{< ref "/user-guide/integrations/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]({{< ref "/getting-started/installation/#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/content/en/user-guide/integrations/cloud-custodian/index.md b/content/en/user-guide/integrations/cloud-custodian/index.md index 38430bca20..ec38ad46ac 100644 --- a/content/en/user-guide/integrations/cloud-custodian/index.md +++ b/content/en/user-guide/integrations/cloud-custodian/index.md @@ -28,7 +28,7 @@ To install Cloud Custodian, run the following command: $ pip install c7n {{< / command >}} -After installing Cloud Custodian, you can configure a [custom LocalStack profile](http://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-a-custom-profile) in your AWS CLI configuration file. +After installing Cloud Custodian, you can configure a [custom LocalStack profile]({{< ref "/user-guide/integrations/aws-cli/#configuring-a-custom-profile" >}}) in your AWS CLI configuration file. ### Create an EC2 instance diff --git a/content/en/user-guide/integrations/crossplane/index.md b/content/en/user-guide/integrations/crossplane/index.md index 30fe8f850e..d1db87f1dd 100644 --- a/content/en/user-guide/integrations/crossplane/index.md +++ b/content/en/user-guide/integrations/crossplane/index.md @@ -24,7 +24,7 @@ In the following, we provide a step-by-step guide for installing Crossplane in a * LocalStack running in local Docker * A local Kubernetes cluster: * We can use the [embedded Kubernetes cluster](https://docs.docker.com/desktop/kubernetes) that ships with modern versions of Docker Desktop (can be easily enabled in the Docker settings) - * Alternatively, you can [create a local EKS cluster](https://docs.localstack.cloud/user-guide/aws/elastic-kubernetes-service/#create-an-embedded-kubernetes-cluster) in LocalStack directly, which will spin up a light-weight embedded `k3d` Kubernetes cluster in your Docker environment + * Alternatively, you can [create a local EKS cluster]({{< ref "/user-guide/aws/eks/#create-an-embedded-kubernetes-cluster" >}}) in LocalStack directly, which will spin up a light-weight embedded `k3d` Kubernetes cluster in your Docker environment * The [`helm`](https://helm.sh) and [`kubectl`](https://kubernetes.io/docs/tasks/tools/#kubectl) command-line clients installed ## Installing Crossplane in local Kubernetes @@ -226,9 +226,9 @@ You can refer to the additional reading material to learn and explore more advan ## Further Reading -* Kubernetes on Docker Desktop: https://docs.docker.com/desktop/kubernetes -* Kubernetes getting started guide: https://kubernetes.io/docs/setup -* EKS Kubernetes clusters on LocalStack: https://docs.localstack.cloud/user-guide/aws/elastic-kubernetes-service -* Crossplane user docs: https://docs.crossplane.io -* Crossplane AWS provider family: https://marketplace.upbound.io/providers/upbound/provider-family-aws -* Crossplane AWS provider source code: https://github.com/upbound/provider-aws +* [Kubernetes on Docker Desktop](https://docs.docker.com/desktop/kubernetes) +* [Kubernetes getting started guide](https://kubernetes.io/docs/setup) +* [EKS Kubernetes clusters on LocalStack]({{< ref "/user-guide/aws/eks" >}}) +* [Crossplane user docs](https://docs.crossplane.io) +* [Crossplane AWS provider family](https://marketplace.upbound.io/providers/upbound/provider-family-aws) +* [Crossplane AWS provider source code](https://github.com/upbound/provider-aws) diff --git a/content/en/user-guide/integrations/eksctl/index.md b/content/en/user-guide/integrations/eksctl/index.md index c878c3dd84..56b64c2047 100644 --- a/content/en/user-guide/integrations/eksctl/index.md +++ b/content/en/user-guide/integrations/eksctl/index.md @@ -31,7 +31,7 @@ We will demonstrate how you can create a local EKS cluster using `eksctl` and fe ### Create a cluster To create a cluster, you can use the `eksctl create cluster` command. -You can use the `--profile` flag to [specify the LocalStack profile](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-a-custom-profile) to use for the cluster. +You can use the `--profile` flag to [specify the LocalStack profile]({{< ref "/user-guide/integrations/aws-cli/#configuring-a-custom-profile" >}}) to use for the cluster. Run the following command to create a cluster: diff --git a/content/en/user-guide/integrations/openshift/index.md b/content/en/user-guide/integrations/openshift/index.md index e562004c5e..e8f3567eb0 100644 --- a/content/en/user-guide/integrations/openshift/index.md +++ b/content/en/user-guide/integrations/openshift/index.md @@ -93,7 +93,7 @@ Since we are running LocalStack on OpenShift, we need to specify the route URL o You can swap `awslocal` with the AWS CLI, by specifying the additional `--endpoint-url` parameter. {{< /callout >}} -You can further 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 further use integrations, such as [CDK]({{< ref "/user-guide/integrations/aws-cdk" >}}), [SAM CLI]({{< ref "/user-guide/integrations/aws-sam" >}}), and [Terraform]({{< ref "/user-guide/integrations/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. ### Deleting the LocalStack deployment diff --git a/content/en/user-guide/integrations/quarkus/index.md b/content/en/user-guide/integrations/quarkus/index.md index f92d867820..6ee904624d 100644 --- a/content/en/user-guide/integrations/quarkus/index.md +++ b/content/en/user-guide/integrations/quarkus/index.md @@ -20,7 +20,7 @@ The Lambda extension is based on [AWS Java SDK 2.x](https://docs.aws.amazon.com/ ### Prerequisites -- [LocalStack](https://docs.localstack.cloud/getting-started/installation) installed and running +- [LocalStack]({{< ref "/getting-started/installation" >}}) installed and running - [JDK 17+](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) with `JAVA_HOME` configured properly - [Maven 3.8.1+](https://maven.apache.org/download.cgi) - [Docker](https://docs.docker.com/get-docker/) diff --git a/content/en/user-guide/integrations/serverless-framework/index.md b/content/en/user-guide/integrations/serverless-framework/index.md index 6416b1f615..29e9d2d8ac 100644 --- a/content/en/user-guide/integrations/serverless-framework/index.md +++ b/content/en/user-guide/integrations/serverless-framework/index.md @@ -21,7 +21,7 @@ In particular, the setup consists of the following two steps. This guide assumes that you have the following tools installed. -* LocalStack ([Install](https://docs.localstack.cloud/get-started/#installation)) +* LocalStack ([Install]({{< ref "/getting-started/#installation" >}})) * Serverless ([Install](https://www.serverless.com/framework/docs/getting-started/)) It also assumes that you already have a Serverless app set up consisting of a couple of Lambda functions and a `serverless.yml` file similar to the following. diff --git a/content/en/user-guide/lambda-tools/vscode-extension/index.md b/content/en/user-guide/lambda-tools/vscode-extension/index.md index a97f2882cd..5a0d10be7c 100644 --- a/content/en/user-guide/lambda-tools/vscode-extension/index.md +++ b/content/en/user-guide/lambda-tools/vscode-extension/index.md @@ -15,7 +15,7 @@ aliases: - [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]({{< ref "getting-started" >}}) running in the background. ## Getting Started 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 63300f4438..3d200a1b77 100644 --- a/content/en/user-guide/localstack-enterprise/ci-analytics/index.md +++ b/content/en/user-guide/localstack-enterprise/ci-analytics/index.md @@ -47,11 +47,11 @@ In this example, we will configure CI Analytics with an existing application tha ### Prerequisites -- A [LocalStack Account](https://app.localstack.cloud/) and a [LocalStack API key](https://docs.localstack.cloud/getting-started/api-key/). +- A [LocalStack Account](https://app.localstack.cloud/) and a [LocalStack API key]({{< ref "api-key" >}}). - A [GitHub Account](https://github.com/). For practical testing, you can use an existing application that employs LocalStack for cloud infrastructure deployment on GitHub Actions. -Alternatively, you can start by forking one of the [Developer Hub samples](https://docs.localstack.cloud/applications/). +Alternatively, you can start by forking one of the [Developer Hub samples]({{< ref "/applications" >}}). ### Create a CI project @@ -80,7 +80,7 @@ Click **Create** to finalize your CI project. ### Configure the CI pipeline Go to the GitHub Action workflow where you intend to monitor CI analytics for your application stack. -If you haven't already set up a CI pipeline using LocalStack for infrastructure deployments and tests, follow the instructions in our [GitHub Actions documentation](https://docs.localstack.cloud/user-guide/ci/github-actions/). +If you haven't already set up a CI pipeline using LocalStack for infrastructure deployments and tests, follow the instructions in our [GitHub Actions documentation]({{< ref "/user-guide/ci/github-actions" >}}). To link your CI pipeline to the project you created, use the `LS_CI_PROJECT` configuration variable. For instance, if your CI project is named `ls-platform-integration-tests`, include the line `LS_CI_PROJECT: ls-platform-integration-tests` in your GitHub Action workflow. @@ -115,7 +115,7 @@ jobs: The LocalStack CLI utilizes a LocalStack CI key for authentication with the LocalStack Platform. This process enables the storage of logs and request/response traces from your CI run in the LocalStack Web Application. -For setting up an CI key, refer our [documentation on configuring a CI key](https://docs.localstack.cloud/user-guide/ci/github-actions/#configure-a-ci-key). +For setting up an CI key, refer our [documentation on configuring a CI key]({{< ref "/user-guide/ci/github-actions/#configure-a-ci-key" >}}). ### Review the Analytics 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 e198912d7d..b7fd0181f0 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -59,7 +59,7 @@ _Appears in:_ | `shutdownConfigName` _string_ | | | `startConfigName` _string_ | | -Use as described in the [Initialization Hooks](https://docs.localstack.cloud/references/init-hooks/) reference. +Use as described in the [Initialization Hooks]({{< ref "/references/init-hooks" >}}) reference. #### LocalStack diff --git a/content/en/user-guide/localstack-enterprise/kubernetes-executor/index.md b/content/en/user-guide/localstack-enterprise/kubernetes-executor/index.md index f6c1a11755..e72b4732a4 100644 --- a/content/en/user-guide/localstack-enterprise/kubernetes-executor/index.md +++ b/content/en/user-guide/localstack-enterprise/kubernetes-executor/index.md @@ -61,9 +61,9 @@ Lambda hot reloading & remote debugging are not supported in the Kubernetes exec You can run the following services on Kubernetes clusters using the LocalStack Enterprise image: -- [DocumentDB](https://docs.localstack.cloud/user-guide/aws/docdb/) -- [MWAA](https://docs.localstack.cloud/user-guide/aws/docdb/) -- [RDS](https://docs.localstack.cloud/user-guide/aws/rds/) ([MySQL](https://docs.localstack.cloud/user-guide/aws/rds/#mysql-engine) & [MSSQL](https://docs.localstack.cloud/user-guide/aws/rds/#microsoft-sql-server-engine)) +- [DocumentDB]({{< ref "/user-guide/aws/docdb/" >}}) +- [MWAA]({{< ref "/user-guide/aws/docdb/" >}}) +- [RDS]({{< ref "/user-guide/aws/rds/" >}}) ([MySQL]({{< ref "/user-guide/aws/rds/#mysql-engine" >}}) & [MSSQL]({{< ref "/user-guide/aws/rds/#microsoft-sql-server-engine" >}})) To use Kubernetes as the runtime backend, set the `CONTAINER_RUNTIME` configuration variable to `kubernetes`. Note that there are no service-specific configuration variables for these services. 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 7ad95d52f0..6a8248dd4e 100644 --- a/content/en/user-guide/state-management/cloud-pods/index.md +++ b/content/en/user-guide/state-management/cloud-pods/index.md @@ -23,7 +23,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]({{< ref "/getting-started/installation/#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. @@ -275,7 +275,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]({{< ref "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`. @@ -434,7 +434,7 @@ $ localstack pod list s3-storage-aws {{< callout >}} 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]({{< ref "/getting-started/installation/#updating" >}}). {{< /callout >}} ### ORAS remote storage @@ -505,7 +505,7 @@ services: {{< callout >}} 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]({{< ref "/references/filesystem/#localstack-volume" >}}). {{< /callout >}} ## End-to-End Encryption (Enterprise) @@ -559,7 +559,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]({{< ref "/references/filesystem/#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. diff --git a/content/en/user-guide/state-management/pods-cli/index.md b/content/en/user-guide/state-management/pods-cli/index.md index d7dc283493..30d5504170 100644 --- a/content/en/user-guide/state-management/pods-cli/index.md +++ b/content/en/user-guide/state-management/pods-cli/index.md @@ -260,7 +260,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]({{< ref "/user-guide/state-management/pods-cli/#remote" >}}). {{< command >}} diff --git a/content/en/user-guide/tools/aws-replicator/index.md b/content/en/user-guide/tools/aws-replicator/index.md index 992a3ac6d5..4139ede2e6 100644 --- a/content/en/user-guide/tools/aws-replicator/index.md +++ b/content/en/user-guide/tools/aws-replicator/index.md @@ -26,7 +26,7 @@ A valid `LOCALSTACK_AUTH_TOKEN` must be configured to start LocalStack. {{< callout "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]({{< ref "/getting-started/installation/#updating" >}}). {{< /callout >}} ### Retrieve credentials to access AWS @@ -75,7 +75,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]({{< ref "installation/#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/content/en/user-guide/tools/event-studio/index.md b/content/en/user-guide/tools/event-studio/index.md index dc475e3c24..68d53d800d 100644 --- a/content/en/user-guide/tools/event-studio/index.md +++ b/content/en/user-guide/tools/event-studio/index.md @@ -89,9 +89,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]({{< ref "/user-guide/aws/s3" >}}) +- [SQS]({{< ref "sqs" >}}) +- [SNS]({{< ref "sns" >}}) +- [DynamoDB]({{< ref "/user-guide/aws/dynamodb" >}}) +- [Lambda]({{< ref "/user-guide/aws/lambda" >}}) +- [EventBridge]({{< ref "events" >}}) diff --git a/content/en/user-guide/tools/transparent-endpoint-injection/index.md b/content/en/user-guide/tools/transparent-endpoint-injection/index.md index 72189c1663..d09c9c9575 100644 --- a/content/en/user-guide/tools/transparent-endpoint-injection/index.md +++ b/content/en/user-guide/tools/transparent-endpoint-injection/index.md @@ -109,4 +109,4 @@ 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]({{< ref "/user-guide/integrations/sdks/go/" >}}). diff --git a/content/en/user-guide/web-application/instance-management/index.md b/content/en/user-guide/web-application/instance-management/index.md index 5c2efa4b89..352ca44ece 100644 --- a/content/en/user-guide/web-application/instance-management/index.md +++ b/content/en/user-guide/web-application/instance-management/index.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. {{< callout >}} -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]({{< ref "configuration/#core" >}}). +For troubleshooting, refer to the [network troubleshooting guide]({{< ref "network-troubleshooting" >}}). {{< /callout >}} diff --git a/content/en/user-guide/web-application/resource-browser/index.md b/content/en/user-guide/web-application/resource-browser/index.md index 4730e34d0a..e16d25a603 100644 --- a/content/en/user-guide/web-application/resource-browser/index.md +++ b/content/en/user-guide/web-application/resource-browser/index.md @@ -14,7 +14,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]({{< ref "/user-guide/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.