From 97e83948c3ef89ba0599090923dc6a1a7abd5a5e Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Fri, 20 Jun 2025 09:37:54 +0530 Subject: [PATCH 1/3] add link validator --- astro.config.mjs | 4 ++++ package-lock.json | 40 ++++++++++++++++++++++++++++++++++++++++ package.json | 1 + 3 files changed, 45 insertions(+) diff --git a/astro.config.mjs b/astro.config.mjs index 9ecc7902..85941cda 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -2,6 +2,7 @@ import { defineConfig, envField } from 'astro/config'; import starlight from '@astrojs/starlight'; import starlightUtils from '@lorenzo_lewis/starlight-utils'; +import starlightLinksValidator from 'starlight-links-validator' import markdoc from '@astrojs/markdoc'; @@ -60,6 +61,9 @@ export default defineConfig({ alt: 'LocalStack', }, plugins: [ + starlightLinksValidator({ + errorOnRelativeLinks: false, + }), starlightUtils({ multiSidebar: { switcherStyle: 'dropdown', diff --git a/package-lock.json b/package-lock.json index a5c6cd55..ea917898 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,6 +26,7 @@ "react": "^19.1.0", "react-dom": "^19.1.0", "sharp": "^0.32.5", + "starlight-links-validator": "^0.17.0", "tailwind-merge": "^3.2.0", "tailwindcss": "^4.1.6" }, @@ -2406,6 +2407,11 @@ "undici-types": "~6.21.0" } }, + "node_modules/@types/picomatch": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@types/picomatch/-/picomatch-3.0.2.tgz", + "integrity": "sha512-n0i8TD3UDB7paoMMxA3Y65vUncFJXjcUf7lQY7YyKGl6031FNjfsLs6pdLFCy2GNFxItPJG8GvvpbZc2skH7WA==" + }, "node_modules/@types/react": { "version": "19.1.3", "resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.3.tgz", @@ -4536,6 +4542,17 @@ "url": "https://github.com/sponsors/brc-dd" } }, + "node_modules/is-absolute-url": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-absolute-url/-/is-absolute-url-4.0.1.tgz", + "integrity": "sha512-/51/TKE88Lmm7Gc4/8btclNXWS+g50wXhYJq8HWIBAGUBnoAdRu1aXeh364t/O7wXDAcTJDP8PNuNKWUDWie+A==", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-alphabetical": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", @@ -7371,6 +7388,29 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/starlight-links-validator": { + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/starlight-links-validator/-/starlight-links-validator-0.17.0.tgz", + "integrity": "sha512-D+j0W7Z6CVSxPlt8jskBcApqaAU16JmuxE4c483Xj2sWJteiz0wW2xvk0cG3o/cW1q9x44Ezc668OnUi3a5LAA==", + "dependencies": { + "@types/picomatch": "^3.0.1", + "github-slugger": "^2.0.0", + "hast-util-from-html": "^2.0.3", + "hast-util-has-property": "^3.0.0", + "is-absolute-url": "^4.0.1", + "kleur": "^4.1.5", + "mdast-util-mdx-jsx": "^3.1.3", + "mdast-util-to-string": "^4.0.0", + "picomatch": "^4.0.2", + "unist-util-visit": "^5.0.0" + }, + "engines": { + "node": ">=18.17.1" + }, + "peerDependencies": { + "@astrojs/starlight": ">=0.32.0" + } + }, "node_modules/stream-replace-string": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/stream-replace-string/-/stream-replace-string-2.0.0.tgz", diff --git a/package.json b/package.json index fbd91067..d6a6109a 100644 --- a/package.json +++ b/package.json @@ -28,6 +28,7 @@ "react": "^19.1.0", "react-dom": "^19.1.0", "sharp": "^0.32.5", + "starlight-links-validator": "^0.17.0", "tailwind-merge": "^3.2.0", "tailwindcss": "^4.1.6" }, From d1be6f88241d2364f1e1bea095a064e60810e89b Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Fri, 20 Jun 2025 10:35:06 +0530 Subject: [PATCH 2/3] fix several links --- astro.config.mjs | 1 + .../capabilities/cloud-sandbox/app-preview.md | 2 +- .../aws/capabilities/config/configuration.md | 18 +++++++++--------- .../config/initialization-hooks.mdx | 2 +- .../capabilities/config/internal-endpoints.md | 2 +- .../docs/aws/capabilities/event-studio.md | 2 +- .../networking/external-port-range.mdx | 4 ++-- .../networking/internal-endpoints.md | 2 +- .../transparent-endpoint-injection.md | 2 +- .../custom-tls-certificates.mdx | 4 ++-- .../security-testing/iam-policy-enforcement.md | 2 +- .../state-management/cloud-pods.mdx | 4 ++-- .../capabilities/state-management/launchpad.md | 2 +- src/content/docs/aws/getting-started/faq.mdx | 4 ++-- .../docs/aws/getting-started/help-support.md | 2 +- src/content/docs/aws/getting-started/index.md | 2 +- .../docs/aws/getting-started/installation.mdx | 4 ++-- .../app-frameworks/serverless-framework.md | 2 +- .../app-frameworks/spring-cloud-function.mdx | 2 +- .../integrations/aws-native-tools/aws-cdk.md | 15 --------------- .../containers/rancher-desktop.mdx | 8 ++++---- .../continuous-integration/circleci.md | 10 +++++----- .../continuous-integration/codebuild.md | 8 ++++---- .../continuous-integration/github-actions.md | 6 +++--- .../continuous-integration/gitlab-ci.md | 8 ++++---- .../messaging/selfmanaged-kafka-cluster.md | 2 +- src/content/docs/aws/services/batch.mdx | 2 +- src/content/docs/aws/services/ecs.mdx | 4 ++-- src/content/docs/aws/services/lambda.mdx | 4 ++-- src/content/docs/aws/services/s3.mdx | 4 ++-- .../docs/aws/tooling/aws-replicator.mdx | 2 +- src/content/docs/aws/tooling/dns-server.md | 2 +- src/content/docs/aws/tooling/event-studio.md | 2 +- .../tooling/extensions/managing-extensions.mdx | 4 ++-- .../snowflake/getting-started/quickstart.md | 2 +- src/content/docs/snowflake/index.md | 2 +- 36 files changed, 67 insertions(+), 81 deletions(-) diff --git a/astro.config.mjs b/astro.config.mjs index 85941cda..2ed8cf3b 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -63,6 +63,7 @@ export default defineConfig({ plugins: [ starlightLinksValidator({ errorOnRelativeLinks: false, + errorOnLocalLinks: false, }), starlightUtils({ multiSidebar: { diff --git a/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md b/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md index 523bfcc1..52ff8fd0 100644 --- a/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md +++ b/src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md @@ -110,4 +110,4 @@ preview-cmd: | ## Examples -- [Creating ephemeral application previews with LocalStack and GitHub Actions](/aws/tutorials/ephemeral-application-previews/) and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway) \ No newline at end of file +- [Creating ephemeral application previews with LocalStack and GitHub Actions]() and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway) diff --git a/src/content/docs/aws/capabilities/config/configuration.md b/src/content/docs/aws/capabilities/config/configuration.md index 17346b7c..5a7b89a6 100644 --- a/src/content/docs/aws/capabilities/config/configuration.md +++ b/src/content/docs/aws/capabilities/config/configuration.md @@ -31,7 +31,7 @@ Options that affect the core LocalStack system. | `GATEWAY_LISTEN`| `0.0.0.0:4566` (default in Docker mode) `127.0.0.1:4566` (default in host mode) | Configures the bind addresses of LocalStack. It has the form `:(,:)*`. LocalStack Pro adds port `443`. | | `LOCALSTACK_HOST`| `localhost.localstack.cloud:4566` (default) | This is interpolated into URLs and addresses that are returned by LocalStack. It has the form `:`. | | `USE_SSL` | `0` (default) | Whether to return URLs using HTTP (`0`) or HTTPS (`1`). Changed with 3.0.0. In earlier versions this was toggling SSL support on or off. | -| `PERSISTENCE` | `0` (default) | Enable persistence. See [Persistence Mechanism](/aws/capabilities/state-management/persistence) and [Filesystem Layout](/aws/capabilities/config/filesystem-layout). | +| `PERSISTENCE` | `0` (default) | Enable persistence. See [Persistence Mechanism](/aws/capabilities/state-management/persistence) and [Filesystem Layout](/aws/capabilities/config/filesystem). | | `MAIN_CONTAINER_NAME` | `localstack-main` (default) | Specify the main docker container name | | `LS_LOG` | `trace`, `trace-internal`, `debug`, `info`, `warn`, `error`, `warning`| Specify the log level. Currently overrides the `DEBUG` configuration. `trace` for detailed request/response, `trace-internal` for internal calls, too. | | `EXTERNAL_SERVICE_PORTS_START` | `4510` (default) | Start of the [External Service Port Range](/aws/capabilities/networking/external-port-range) (inclusive). | @@ -47,7 +47,7 @@ These options are applicable when using the CLI to start LocalStack. | Variable | Example Values | Description | | - | - | - | -| `LOCALSTACK_VOLUME_DIR` | `~/.cache/localstack/volume` (on Linux) | The location on the host of the LocalStack volume directory mount. See [Filesystem Layout](/aws/capabilities/config/filesystem-layout#using-the-cli) | +| `LOCALSTACK_VOLUME_DIR` | `~/.cache/localstack/volume` (on Linux) | The location on the host of the LocalStack volume directory mount. See [Filesystem Layout](/aws/capabilities/config/filesystem#using-the-cli) | | `CONFIG_PROFILE` | | The configuration profile to load. See [Profiles](#profiles) | | `CONFIG_DIR` | `~/.localstack` | The path where LocalStack can find configuration profiles and other CLI-specific configuration | @@ -226,7 +226,7 @@ Also see [OpenSearch configuration variables](#opensearch) which are used to man | Variable | Example Values | Description | | - | - | - | | `ENFORCE_IAM` (pro) | `0` (default)\|`1` | Enable IAM policy evaluation and enforcement. If this is disabled (the default), IAM policies will have no effect to your requests. | -| `IAM_SOFT_MODE` (pro) | `0` (default)\|`1` | Enable IAM soft mode. This leads to policy evaluation without actually denying access. Needs `ENFORCE_IAM` enabled as well. For more information, see [Identity and Access Management](/aws/servicesiam).| +| `IAM_SOFT_MODE` (pro) | `0` (default)\|`1` | Enable IAM soft mode. This leads to policy evaluation without actually denying access. Needs `ENFORCE_IAM` enabled as well. For more information, see [Identity and Access Management](/aws/services/iam).| ### Kinesis @@ -252,7 +252,7 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2 | `BUCKET_MARKER_LOCAL` | `hot-reload` (default) | Magic S3 bucket name for [Hot Reloading](/aws/tooling/lambda-tools/hot-reloading). The S3Key points to the source code on the local file system. | | `HOSTNAME_FROM_LAMBDA` | `localstack` | Endpoint host under which APIs are accessible from Lambda containers (optional). This can be useful in docker-compose stacks to use the local container hostname if neither IP address nor container name of the main container are available (e.g., in CI). Often used in combination with `LAMBDA_DOCKER_NETWORK`.| | `LAMBDA_DISABLE_AWS_ENDPOINT_URL` | `0` (default) \| `1` | Whether to disable injecting the environment variable `AWS_ENDPOINT_URL`, which automatically configures [supported AWS SDKs](https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html). | -| `LAMBDA_DISABLE_JAVA_SDK_V2_CERTIFICATE_VALIDATION` | `1` (default) | Whether to disable the certificate name validation for [AWS Java SDK v2](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html) calls when using [transparent endpoint injection](/aws/tooling/transparent-endpoint-injection).| +| `LAMBDA_DISABLE_JAVA_SDK_V2_CERTIFICATE_VALIDATION` | `1` (default) | Whether to disable the certificate name validation for [AWS Java SDK v2](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html) calls when using [transparent endpoint injection](/aws/capabilities/networking/transparent-endpoint-injection).| | `LAMBDA_DOCKER_DNS` | `""` (default) | Optional custom DNS server for the container running your Lambda function. Overwrites the default LocalStack [DNS Server](/aws/tooling/dns-server). Hence, resolving `localhost.localstack.cloud` requires additional configuration. | | `LAMBDA_DOCKER_FLAGS` | `-e KEY=VALUE`, `-v host:container`, `-p host:container`, `--add-host domain:ip` | Additional flags passed to Docker `run`\|`create` commands. Supports environment variables (also with `--env-file`, but the file has to be mounted into the LocalStack container), ports, volume mounts, extra hosts, networks, DNS servers, labels, ulimits, user, platform, and privileged mode. The `--env-file` argument for Docker `run` and Docker Compose have different feature sets. To provide both, we support the `--env-file` for environment files with the docker run syntax, while `--compose-env-file` supports the full docker compose features, like placeholders with `${}`, replacing quotes, etc. | | `LAMBDA_DOCKER_NETWORK` | `bridge` (Docker default) | [Docker network driver](https://docs.docker.com/network/) for the Lambda and ECS containers. Needs to be set to the network the LocalStack container is connected to. Limitation: `host` mode currently not supported. | @@ -310,7 +310,7 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2 | - | - | - | | `OPENSEARCH_CUSTOM_BACKEND` | `http://opensearch:9200` | URL to a custom OpenSearch backend cluster. If this is set to a valid URL, then LocalStack will not create OpenSearch cluster instances, but instead forward all domains to the given backend (see [Custom Opensearch Backends](/aws/services/opensearch#custom-opensearch-backends). | | `OPENSEARCH_MULTI_CLUSTER` | `1`\| `0` | When activated, LocalStack will spawn one OpenSearch cluster per domain. Otherwise all domains will share a single cluster instance. This is ignored if `OPENSEARCH_CUSTOM_BACKEND` is set. | -| `OPENSEARCH_ENDPOINT_STRATEGY` | `path`\|`domain`\|`port` | Governs how domain endpoints are created to access a cluster (see [Opensearch Endpoints](/aws/services/opensearch#endpoints)). | +| `OPENSEARCH_ENDPOINT_STRATEGY` | `path`\|`domain`\|`port` | Governs how domain endpoints are created to access a cluster (see [Opensearch Endpoints](/aws/services/opensearch#domain-endpoints)). | | `SKIP_INFRA_DOWNLOADS` | `1` \| `0` (default) | **Deprecated since 1.3.0** Whether to skip downloading additional infrastructure components (e.g., specific Elasticsearch versions) | | `IGNORE_OS_DOWNLOAD_ERRORS` | `0`\|`1` | Whether to ignore errors (e.g., network/SSL) when downloading OpenSearch plugins | @@ -345,8 +345,8 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2 | - | - | - | | `SQS_DELAY_PURGE_RETRY` | `0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. | | `SQS_DELAY_RECENTLY_DELETED` | `0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. | -| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](/aws/sqs/#enabling-messageretentionperiod) | -| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](/aws/sqs/#queue-urls) | +| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](/aws/services/sqs/#enabling-messageretentionperiod) | +| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](/aws/services/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` | @@ -449,7 +449,7 @@ To learn more about these configuration options, see [DNS Server](/aws/tooling/d | Variable | Example Values | Description | | - | - | - | -| `DISABLE_TRANSPARENT_ENDPOINT_INJECTION` | `0` (default in Pro) \| `1` | Whether to disable DNS resolution of AWS hostnames to the LocalStack container. Pro feature. (see [Transparent Endpoint Injection](/aws/tooling/transparent-endpoint-injection)) +| `DISABLE_TRANSPARENT_ENDPOINT_INJECTION` | `0` (default in Pro) \| `1` | Whether to disable DNS resolution of AWS hostnames to the LocalStack container. Pro feature. (see [Transparent Endpoint Injection](/aws/capabilities/networking/transparent-endpoint-injection)) ## LocalStack Pro @@ -515,7 +515,7 @@ These configurations have already been removed and **won't have any effect** on | `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](/aws/capabilities/config/initialization-hooks/). | -| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem-layout). | +| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem). | | `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](/aws/capabilities/config/initialization-hooks). | | `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) | | `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | | diff --git a/src/content/docs/aws/capabilities/config/initialization-hooks.mdx b/src/content/docs/aws/capabilities/config/initialization-hooks.mdx index 6d26dc3a..37e3b244 100644 --- a/src/content/docs/aws/capabilities/config/initialization-hooks.mdx +++ b/src/content/docs/aws/capabilities/config/initialization-hooks.mdx @@ -230,7 +230,7 @@ The logs should show something like: 2024-06-26T20:36:26.864 DEBUG --- [ady_monitor)] localstack.utils.run : Executing command: ['tflocal', '-chdir=/etc/localstack/init/ready.d', 'apply', '-auto-approve'] ``` -For a more complex demo project, on how to use Terraform init hooks for your testing environments, you can check out [this example](/aws/tutorials/using-terraform-with-testcontainers-and-localstack/) in the Tutorials section. +For a more complex demo project, on how to use Terraform init hooks for your testing environments, you can check out [this example]() in the Tutorials section. ## Troubleshooting diff --git a/src/content/docs/aws/capabilities/config/internal-endpoints.md b/src/content/docs/aws/capabilities/config/internal-endpoints.md index 1913b547..7d13eaf5 100644 --- a/src/content/docs/aws/capabilities/config/internal-endpoints.md +++ b/src/content/docs/aws/capabilities/config/internal-endpoints.md @@ -33,4 +33,4 @@ curl -v --request POST --header "Content-Type: application/json" --data '{"acti The API path for the AWS internal resources is `/_aws`. These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services. -For instance, `/aws/sqs/messages` conveniently access all messages within a SQS queue, without deleting them. +For instance, `/aws/services/sqs/messages` conveniently access all messages within a SQS queue, without deleting them. diff --git a/src/content/docs/aws/capabilities/event-studio.md b/src/content/docs/aws/capabilities/event-studio.md index 1e9b39e7..a91536ce 100644 --- a/src/content/docs/aws/capabilities/event-studio.md +++ b/src/content/docs/aws/capabilities/event-studio.md @@ -89,7 +89,7 @@ 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/) +- [SQS](https://docs.localstack.cloud/user-guide/aws/services/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/) diff --git a/src/content/docs/aws/capabilities/networking/external-port-range.mdx b/src/content/docs/aws/capabilities/networking/external-port-range.mdx index 43be153a..c75c753b 100644 --- a/src/content/docs/aws/capabilities/networking/external-port-range.mdx +++ b/src/content/docs/aws/capabilities/networking/external-port-range.mdx @@ -18,13 +18,13 @@ This documentation discusses two approaches to access these external services wi LocalStack offers a proxy functionality to access external services indirectly. In this approach, LocalStack assigns local domains to the external services based on the individual service's configuration. -For instance, if OpenSearch is configured to use the [`OPENSEARCH_ENDPOINT_STRATEGY=domain`](/aws/services/opensearch#endpoints) setting, a cluster can be reached using the domain name `...localhost.localstack.cloud`. +For instance, if OpenSearch is configured to use the [`OPENSEARCH_ENDPOINT_STRATEGY=domain`](/aws/services/opensearch#domain-endpoints) setting, a cluster can be reached using the domain name `...localhost.localstack.cloud`. Incoming messages to these domains are relayed to servers running on ports that do not require external accessibility. ## Direct Access with External Service Port Range An alternative approach to accessing external services is by utilizing the _external service port range_. -This method, applicable to services like OpenSearch, is activated using the [`OPENSEARCH_ENDPOINT_STRATEGY=port`](/aws/services/opensearch#endpoints) configuration. +This method, applicable to services like OpenSearch, is activated using the [`OPENSEARCH_ENDPOINT_STRATEGY=port`](/aws/services/opensearch#domain-endpoints) configuration. The external service port range is pre-defined and set to `4510-4559` by default. When a LocalStack service starts an external service, it automatically selects an available port from within the specified range. diff --git a/src/content/docs/aws/capabilities/networking/internal-endpoints.md b/src/content/docs/aws/capabilities/networking/internal-endpoints.md index 57552f77..c64050ed 100644 --- a/src/content/docs/aws/capabilities/networking/internal-endpoints.md +++ b/src/content/docs/aws/capabilities/networking/internal-endpoints.md @@ -35,4 +35,4 @@ $ curl -v --request POST --header "Content-Type: application/json" --data '{"ac The API path for the AWS internal resources is `/_aws`. These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services. -For instance, `/aws/sqs/messages` conveniently access all messages within a SQS queue, without deleting them. +For instance, `/aws/services/sqs/messages` conveniently access all messages within a SQS queue, without deleting them. diff --git a/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md b/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md index afd4ff68..54e446ba 100644 --- a/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md +++ b/src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md @@ -58,7 +58,7 @@ If Transparent Endpoint Injection is _not_ used, the AWS SDK within Lambda funct Transparent Endpoint Injection is only available in LocalStack Pro. Alternatively, specific AWS endpoints can be resolved to AWS while continuing to use Transparent Endpoint Injection. -Refer to the [DNS server configuration](/aws/tooling/dns-server#configuration) for skipping selected domain name patterns. +Refer to the [DNS server configuration](/aws/tooling/dns-server#system-dns-configuration) for skipping selected domain name patterns. :::danger Use this configuration with caution because we generally do not recommend connecting to real AWS from within LocalStack. diff --git a/src/content/docs/aws/capabilities/security-testing/custom-tls-certificates.mdx b/src/content/docs/aws/capabilities/security-testing/custom-tls-certificates.mdx index 4115f032..f05da937 100644 --- a/src/content/docs/aws/capabilities/security-testing/custom-tls-certificates.mdx +++ b/src/content/docs/aws/capabilities/security-testing/custom-tls-certificates.mdx @@ -18,8 +18,8 @@ You may see errors in the logs relating to TLS such as "unable to get local issu There are three options when running LocalStack: 1. [creating a custom Docker image](#creating-a-custom-docker-image), -2. [using init hooks](#custom-ssl-certificates-with-init-hooks) or -3. [when running in host mode](#custom-ssl-certificates-with-host-mode). +2. [using init hooks](#custom-tls-certificates-with-init-hooks) or +3. [when running in host mode](#custom-tls-certificates-with-host-mode). They all can be summarised as: diff --git a/src/content/docs/aws/capabilities/security-testing/iam-policy-enforcement.md b/src/content/docs/aws/capabilities/security-testing/iam-policy-enforcement.md index a65f11ec..0086629c 100644 --- a/src/content/docs/aws/capabilities/security-testing/iam-policy-enforcement.md +++ b/src/content/docs/aws/capabilities/security-testing/iam-policy-enforcement.md @@ -123,4 +123,4 @@ If the IAM policies are not correctly enforced, you will get an unsuccessful res ## Feature coverage -The feature coverage is documented in the [IAM coverage documentation](/aws/services/iam#aws-api-coverage). \ No newline at end of file +The feature coverage is documented in the [IAM coverage documentation](). diff --git a/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx b/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx index 60a8da19..ff928163 100644 --- a/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx +++ b/src/content/docs/aws/capabilities/state-management/cloud-pods.mdx @@ -519,7 +519,7 @@ services: :::note The Auto Load from remote feature does not automatically configure the remote. This needs to be done with the `localstack pod remote add ...` command. -This commands creates a configuration file for the remote in the [LocalStack volume directory](/aws/capabilities/config/filesystem-layout/#localstack-volume-directory). +This commands creates a configuration file for the remote in the [LocalStack volume directory](/aws/capabilities/config/filesystem/#localstack-volume-directory). ::: ## End-to-End Encryption (Enterprise) @@ -572,7 +572,7 @@ The process is the following: Unless explicitly specified, all Cloud Pods commands default to targeting the LocalStack Platform as the storage remote. It's important to note that the CLI must be authenticated correctly with our Platform. -Custom remote configurations are stored within the [LocalStack volume directory](/aws/capabilities/config/filesystem-layout/#localstack-volume-directory) and are managed by the LocalStack container. +Custom remote configurations are stored within the [LocalStack volume directory](/aws/capabilities/config/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/src/content/docs/aws/capabilities/state-management/launchpad.md b/src/content/docs/aws/capabilities/state-management/launchpad.md index a9dd882f..8ed09ae3 100644 --- a/src/content/docs/aws/capabilities/state-management/launchpad.md +++ b/src/content/docs/aws/capabilities/state-management/launchpad.md @@ -38,7 +38,7 @@ To add a badge to your README that links to the Cloud Pod Launchpad, you can inc You need to include the `url_of_your_pod` as the `url` query parameter in the URL. For instance, if your Cloud Pod is hosted within the same repository, simply use the URL that directs to the raw Cloud Pod file. -Additionally, you can utilize the [Link Generator](#creating-your-sharable-link) to generate a shareable link for your pod and copy the corresponding markdown snippet for your repository. +Additionally, you can utilize the [Link Generator](#creating-your-shareable-link) to generate a shareable link for your pod and copy the corresponding markdown snippet for your repository. Check out a proper example on th Cloud Pod badge GitHub repository. ## Troubleshooting common problems diff --git a/src/content/docs/aws/getting-started/faq.mdx b/src/content/docs/aws/getting-started/faq.mdx index b462a750..b08ab24a 100644 --- a/src/content/docs/aws/getting-started/faq.mdx +++ b/src/content/docs/aws/getting-started/faq.mdx @@ -17,7 +17,7 @@ To resolve the issue follow the steps: This can be done by deleting the cached certificate file. For example, on Linux systems, you can locate and remove the file at `~/.cache/localstack/volume/cache/server.test.pem`. The exact path may differ depending on your operating system and how you’ve started LocalStack. - Please refer to our [documentation](/aws/capabilities/config/filesystem-layout/#localstack-volume-directory) for specific instructions. + Please refer to our [documentation](/aws/capabilities/config/filesystem/#localstack-volume-directory) for specific instructions. **Workarounds for older (<v3.7.0) LocalStack versions:** @@ -278,7 +278,7 @@ The easiest way to check if LocalStack Pro or Enterprise is activated is to chec $ curl localhost:4566/_localstack/health | jq ``` -If a Pro-only service -- like [XRay](/aws/services/x-ray) -- is running, LocalStack Pro or Enterprise has started successfully. +If a Pro-only service -- like [XRay](/aws/services/xray) -- is running, LocalStack Pro or Enterprise has started successfully. If your Auth Token is invalid, you will see an error message like this in the logs of LocalStack: ```bash diff --git a/src/content/docs/aws/getting-started/help-support.md b/src/content/docs/aws/getting-started/help-support.md index 6ec985d4..d4888c79 100644 --- a/src/content/docs/aws/getting-started/help-support.md +++ b/src/content/docs/aws/getting-started/help-support.md @@ -43,7 +43,7 @@ At the moment, we only provide support in `English`, as we are an international | ---------- | ------------------------------------------------------------------------------- | | Hobby | [**Basic Support**](/aws/getting-started/help-support/#basic-support) | | Starter | [**Standard Support**](/aws/getting-started/help-support/#standard-support) | -| Teams | [**Priority Support**](/aws/getting-started/help-support//#priority-support) | +| Teams | [**Priority Support**](/aws/getting-started/help-support/#priority-support) | | Enterprise | [**Enterprise Support**](/aws/getting-started/help-support/#enterprise-support) | ## Support features diff --git a/src/content/docs/aws/getting-started/index.md b/src/content/docs/aws/getting-started/index.md index 6c1859b9..d01692d9 100644 --- a/src/content/docs/aws/getting-started/index.md +++ b/src/content/docs/aws/getting-started/index.md @@ -12,7 +12,7 @@ With LocalStack, you can run your AWS applications or Lambdas entirely on your l Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow. LocalStack supports a growing number of [AWS services](/aws/) -, like AWS [Lambda](/aws/lambda), [S3](/aws/s3), [DynamoDB](/aws/dynamodb), [Kinesis](/aws/kinesis), [SQS](/aws/sqs), [SNS](/aws/sns), and more! +, like [Lambda](/aws/services/lambda), [S3](/aws/services/s3), [DynamoDB](/aws/services/dynamodb), [Kinesis](/aws/services/kinesis), [SQS](/aws/services/sqs), [SNS](/aws/services/sns), and more! [LocalStack Pro](https://localstack.cloud/pricing) supports additional APIs and advanced features to make your cloud development experience a breeze! You can find a comprehensive list of supported APIs on each AWS service page. diff --git a/src/content/docs/aws/getting-started/installation.mdx b/src/content/docs/aws/getting-started/installation.mdx index 5e51191a..3e69f7b9 100644 --- a/src/content/docs/aws/getting-started/installation.mdx +++ b/src/content/docs/aws/getting-started/installation.mdx @@ -207,7 +207,7 @@ Besides using the CLI, there are other ways of starting and managing your LocalS - [Docker-Compose](#docker-compose)\ Use Docker Compose to configure and start your LocalStack Docker container. -- [Docker](#docker")\ +- [Docker](#docker)\ Use the Docker CLI to manually start the LocalStack Docker container. - [Helm](#helm)\ @@ -226,7 +226,7 @@ Learn more about our desktop client at [LocalStack Desktop](/aws/capabilities/we ### LocalStack Docker Extension Install our [official Docker Desktop extension](https://hub.docker.com/extensions/localstack/localstack-docker-desktop) to manage LocalStack. -See [LocalStack Docker Extension](/aws/tooling/extentions/localstack-docker-extension) for more information. +See [LocalStack Docker Extension](/aws/tooling/extensions/localstack-docker-extension) for more information. ### Docker-Compose diff --git a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md index 4323d0d9..f53921aa 100644 --- a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md +++ b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md @@ -124,7 +124,7 @@ else: ... ``` -In LocalStack Pro, no code changes are required using our [Transparent Endpoint Injection](/aws/tooling/transparent-endpoint-injection). +In LocalStack Pro, no code changes are required using our [Transparent Endpoint Injection](/aws/capabilities/networking/transparent-endpoint-injection). ## Deploying to LocalStack diff --git a/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx b/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx index 7f22525c..1d26c7a3 100644 --- a/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx +++ b/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx @@ -859,7 +859,7 @@ resource "aws_lambda_function" "exampleFunctionTwo" { ## Testing, Debugging and Hot Reloading -Please read our [Lambda Tools](/content/en/tools/lambda-tools/_index.md) +Please read our [Lambda Tools](/aws/tooling/lambda-tools) documentation to learn more about testing, debugging, and hot reloading for JVM Lambda functions. diff --git a/src/content/docs/aws/integrations/aws-native-tools/aws-cdk.md b/src/content/docs/aws/integrations/aws-native-tools/aws-cdk.md index 9c0a052f..b82d02b0 100644 --- a/src/content/docs/aws/integrations/aws-native-tools/aws-cdk.md +++ b/src/content/docs/aws/integrations/aws-native-tools/aws-cdk.md @@ -98,18 +98,3 @@ Our focus for this year will be on resolving issues related to the `UPDATE` supp By default, stacks with validated certificates may not be deployed using the `local` lambda executor. This originates from the way how CDK ensures the certificate is ready - it creates a single-file lambda function with a single dependency on `aws-sdk` which is usually preinstalled and available globally in lambda runtime. When this lambda is executed locally from the `/tmp` folder, the package can not be discovered by Node due to the way how Node package resolution works. - -## Other resources - -[Hot-reloading Lambda functions with CDK](/aws/tooling/lambda-tools/hot-reloading#aws-cloud-development-kit-cdk-configuration) {/*TODO: #aws-cloud-development-kit-cdk-configuration does not exist in the current docs either */} - -## External resources - -* [aws-cdk-local](https://github.com/localstack/aws-cdk-local) -* [AWS CDK API reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html) -* [AWS CDK Developer Guide](https://docs.aws.amazon.com/cdk/latest/guide/home.html) - -## Community resources - -* https://blog.dennisokeeffe.com/blog/2021-08-07-using-the-aws-cdk-with-localstack-and-aws-cdk-local -* https://www.youtube.com/watch?v=3_sqr0G9zb0 \ No newline at end of file diff --git a/src/content/docs/aws/integrations/containers/rancher-desktop.mdx b/src/content/docs/aws/integrations/containers/rancher-desktop.mdx index f32baf17..0e74e0f6 100644 --- a/src/content/docs/aws/integrations/containers/rancher-desktop.mdx +++ b/src/content/docs/aws/integrations/containers/rancher-desktop.mdx @@ -25,10 +25,10 @@ To run LocalStack using Rancher Desktop, simply aliasing Docker commands to Ranc Depending on your operating system, you may need to make additional configurations to ensure LocalStack runs smoothly with Rancher Desktop. -- [1. Make sure there is no existing socket at /var/run/docker.sock](#1-make-sure-there-is-no-existing-socket-at-varrundockersock) -- [2. Adjust the path if your Rancher Desktop socket is in a different location](#2-adjust-the-path-if-your-rancher-desktop-socket-is-in-a-different-location) - - [Rancher Desktop with containerd](#rancher-desktop-with-containerd) - - [Windows](#windows) +- 1. Make sure there is no existing socket at /var/run/docker.sock +- 2. Adjust the path if your Rancher Desktop socket is in a different location + - [Rancher Desktop with containerd](#rancher-desktop-with-containerd) + - [Windows](#windows) These setups enable LocalStack to run smoothly with Rancher Desktop across various operating systems, ensuring compatibility with Docker-based workflows. diff --git a/src/content/docs/aws/integrations/continuous-integration/circleci.md b/src/content/docs/aws/integrations/continuous-integration/circleci.md index 0c7182ca..f1e1359e 100644 --- a/src/content/docs/aws/integrations/continuous-integration/circleci.md +++ b/src/content/docs/aws/integrations/continuous-integration/circleci.md @@ -57,7 +57,7 @@ workflows: To configure LocalStack use the `environment` key on the job level or a shell command, where the latter takes higher precedence. -Read more about the [configuration options](/references/configuration/) of LocalStack. +Read more about the [configuration options](/aws/capabilities/config/configuration) of LocalStack. #### Job level @@ -132,7 +132,7 @@ _Note: For best result we recommend to use a combination of the below techniques Cloud Pods providing an easy solution to persist LocalStack's state, even between workflows or projects. -Find more information about [Cloud Pods](/user-guide/state-management/cloud-pods/). +Find more information about [Cloud Pods](/aws/capabilities/state-management/cloud-pods). ##### Multiple projects @@ -271,7 +271,7 @@ workflows: #### Ephemeral Instance (Preview) -Find out more about [Ephemeral Instances](/user-guide/cloud-sandbox/). +Find out more about [Ephemeral Instances](/aws/capabilities/cloud-sandbox/ephemeral-instances). ##### Same job @@ -388,7 +388,7 @@ jobs: - localstack-load-state ``` -More information about Localstack's [state import/export](/user-guide/state-management/export-import-state). +More information about Localstack's [state import/export](/aws/capabilities/state-management/export-import-state). #### Cache @@ -442,4 +442,4 @@ workflows: ... ``` -More information about [state management](/user-guide/state-management/export-import-state). \ No newline at end of file +More information about [state management](/aws/capabilities/state-management/export-import-state). \ No newline at end of file diff --git a/src/content/docs/aws/integrations/continuous-integration/codebuild.md b/src/content/docs/aws/integrations/continuous-integration/codebuild.md index 50237c2d..8d82676d 100644 --- a/src/content/docs/aws/integrations/continuous-integration/codebuild.md +++ b/src/content/docs/aws/integrations/continuous-integration/codebuild.md @@ -170,7 +170,7 @@ artifact: #### Cloud Pods -Find more information about cloud pods [here](/user-guide/state-management/cloud-pods/). +Find more information about cloud pods [here](/aws/capabilities/state-management/cloud-pods). ##### Native Runner @@ -237,11 +237,11 @@ phases: ... ``` -Find out more about [ephemeral instances](/user-guide/cloud-sandbox/). +Find out more about [ephemeral instances](/aws/capabilities/cloud-sandbox/ephemeral-instances). #### Artifact -Find out more about [state management](/user-guide/state-management/export-import-state/). +Find out more about [state management](/aws/capabilities/state-management/export-import-state/). ```yml ... @@ -274,7 +274,7 @@ To use previously stored artifacts as inputs, set them as a source in the projec #### Cache -Additional information about [state export and import](/user-guide/state-management/export-import-state/). +Additional information about [state export and import](/aws/capabilities/state-management/export-import-state/). ##### Native Runner diff --git a/src/content/docs/aws/integrations/continuous-integration/github-actions.md b/src/content/docs/aws/integrations/continuous-integration/github-actions.md index a987ee22..e31687ad 100644 --- a/src/content/docs/aws/integrations/continuous-integration/github-actions.md +++ b/src/content/docs/aws/integrations/continuous-integration/github-actions.md @@ -98,7 +98,7 @@ You can preserve your AWS infrastructure with Localstack in various ways. ... ``` -Find more information about cloud pods [here](/user-guide/state-management/cloud-pods/). +Find more information about cloud pods [here](/aws/capabilities/state-management/cloud-pods). #### Ephemeral Instance (Preview) @@ -137,7 +137,7 @@ jobs: preview-cmd: bin/deploy.sh ``` -Find out more about ephemeral instances [here](/user-guide/cloud-sandbox/). +Find out more about ephemeral instances [here](/aws/capabilities/cloud-sandbox/ephemeral-instances). #### Artifact @@ -168,7 +168,7 @@ Find out more about ephemeral instances [here](/user-guide/cloud-sandbox/). ... ``` -More information about state import and export [here](/user-guide/state-management/export-import-state). +More information about state import and export [here](/aws/capabilities/state-management/export-import-state). ## Current Limitations diff --git a/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md b/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md index 84baa078..957db4da 100644 --- a/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md +++ b/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md @@ -136,7 +136,7 @@ job: ... ``` -More info about Localstack's state export and import [here](/user-guide/state-management/export-import-state/). +More info about Localstack's state export and import [here](/aws/capabilities/state-management/export-import-state/). #### Cache @@ -159,7 +159,7 @@ job: ... ``` -Additional information about state export and import [here](/user-guide/state-management/export-import-state/). +Additional information about state export and import [here](/aws/capabilities/state-management/export-import-state/). #### Cloud Pod @@ -174,7 +174,7 @@ job: ... ``` -Find more information about cloud pods [here](/user-guide/state-management/cloud-pods/). +Find more information about cloud pods [here](/aws/capabilities/state-management/cloud-pods). #### Ephemeral Instance (Preview) @@ -213,7 +213,7 @@ test-job: ... ``` -Find out more about ephemeral instances [here](/user-guide/cloud-sandbox/). +Find out more about ephemeral instances [here](/aws/capabilities/cloud-sandbox/ephemeral-instances). ## Current Limitations diff --git a/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md b/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md index 7c810255..fb5f94a7 100644 --- a/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md +++ b/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md @@ -6,7 +6,7 @@ sidebar: order: 1 --- -LocalStack Pro supports [AWS Managed Streaming for Kafka (MSK)](/aws/aws-services/msk) {/*TODO: target doesn't exist yet */}and you can create Kafka clusters directly through the MSK API that will run in LocalStack. +LocalStack Pro supports [AWS Managed Streaming for Kafka (MSK)](/aws/services/msk) {/*TODO: target doesn't exist yet */}and you can create Kafka clusters directly through the MSK API that will run in LocalStack. In some cases, you may want to run your own self-managed Kafka cluster and integrate it with your applications, like triggering Lambdas from a Kafka stream running in your own cluster. The Lambda integration with self-managed Kafka clusters is also a LocalStack Pro feature. diff --git a/src/content/docs/aws/services/batch.mdx b/src/content/docs/aws/services/batch.mdx index da3e6e1b..cd5c7c0c 100644 --- a/src/content/docs/aws/services/batch.mdx +++ b/src/content/docs/aws/services/batch.mdx @@ -31,7 +31,7 @@ We will demonstrate how you create and run a Batch job by following these steps: You can create a role using the [`CreateRole`](https://docs.aws.amazon.com/cli/latest/reference/iam/create-role.html) API. For LocalStack, the service role simply needs to exist. -However, when [enforcing IAM policies](/aws/services/iam/#enforcing-iam-policies), it is necessary that the policy is valid. +However, when [enforcing IAM policies](/aws/capabilities/security-testing/iam-policy-enforcement), it is necessary that the policy is valid. Run the following command to create a role with an empty policy document: diff --git a/src/content/docs/aws/services/ecs.mdx b/src/content/docs/aws/services/ecs.mdx index 3d317a03..5871f7fd 100644 --- a/src/content/docs/aws/services/ecs.mdx +++ b/src/content/docs/aws/services/ecs.mdx @@ -274,7 +274,7 @@ Or if you are working with a single container, you can set `ECS_DOCKER_FLAGS="-p ## Mounting local directories for ECS tasks In some cases, it can be useful to mount code from the host filesystem into the ECS container. -For example, to enable a quick debugging loop where you can test changes without having to build and redeploy the task's Docker image each time - similar to the [Lambda Hot Reloading](/aws/services/lambda#hot-reloading) feature in LocalStack. +For example, to enable a quick debugging loop where you can test changes without having to build and redeploy the task's Docker image each time - similar to the [Lambda Hot Reloading](/aws/tooling/lambda-tools/hot-reloading) feature in LocalStack. In order to leverage code mounting, we can use the ECS bind mounts feature, which is covered in the [AWS Bind mounts documentation](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bind-mounts.html). @@ -349,7 +349,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](/aws/capabilities/config/initalization-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](/aws/capabilities/config/initialization-hooks) to install the Docker client and use these credentials to download the image. ## Firelens for ECS Tasks diff --git a/src/content/docs/aws/services/lambda.mdx b/src/content/docs/aws/services/lambda.mdx index 5dd725ee..f63d37bc 100644 --- a/src/content/docs/aws/services/lambda.mdx +++ b/src/content/docs/aws/services/lambda.mdx @@ -533,9 +533,9 @@ The full list of configurations is defined in the Golang function LocalStack provides various tools to help you develop, debug, and test your AWS Lambda functions more efficiently. - **Hot reloading**: With Lambda hot reloading, you can continuously apply code changes to your Lambda functions without needing to redeploy them manually. - To learn more about how to use hot reloading with LocalStack, check out our [hot reloading documentation](/aws/capabilities/lambda-tools/hot-reloading). + To learn more about how to use hot reloading with LocalStack, check out our [hot reloading documentation](/aws/tooling/lambda-tools/hot-reloading). - **Remote debugging**: LocalStack's remote debugging functionality allows you to attach a debugger to your Lambda function using your preferred IDE. - To get started with remote debugging in LocalStack, see our [debugging documentation](/aws/capabilities/lambda-tools/remote-debugging). + To get started with remote debugging in LocalStack, see our [debugging documentation](/aws/tooling/lambda-tools/remote-debugging). - **Lambda VS Code Extension**: LocalStack's Lambda VS Code Extension supports deploying and invoking Python Lambda functions through AWS SAM or AWS CloudFormation. To get started with the Lambda VS Code Extension, see our [Lambda VS Code Extension documentation](/aws/tooling/lambda-tools/vscode-extension). - **API for querying Lambda runtimes**: LocalStack offers a metadata API to query the list of Lambda runtimes via `GET http://localhost.localstack.cloud:4566/_aws/lambda/runtimes`. diff --git a/src/content/docs/aws/services/s3.mdx b/src/content/docs/aws/services/s3.mdx index 03614acd..0ae665f5 100644 --- a/src/content/docs/aws/services/s3.mdx +++ b/src/content/docs/aws/services/s3.mdx @@ -147,12 +147,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](/aws/integrations/aws-sdks) to learn how you can configure AWS SDKs to access LocalStack and S3. +Check out our [SDK documentation]() to learn how you can configure AWS SDKs to access LocalStack and S3. :::note 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](/aws/integrations/aws-sdks) +The `ForcePathStyle` parameter name can vary between SDK and languages, please check our [SDK documentation]() ::: If your endpoint is not prefixed with `s3.`, all requests are treated as **Path style** requests. diff --git a/src/content/docs/aws/tooling/aws-replicator.mdx b/src/content/docs/aws/tooling/aws-replicator.mdx index 73b9da31..c8aa59ff 100644 --- a/src/content/docs/aws/tooling/aws-replicator.mdx +++ b/src/content/docs/aws/tooling/aws-replicator.mdx @@ -210,7 +210,7 @@ AWS_PROFILE=ls-sandbox aws ssm put-parameter\ AWS_PROFILE=ls-sandbox aws ssm get-parameters --names myparam ``` -```jason +```json { "Parameters": [ { diff --git a/src/content/docs/aws/tooling/dns-server.md b/src/content/docs/aws/tooling/dns-server.md index 7561dd4b..07a7ccce 100644 --- a/src/content/docs/aws/tooling/dns-server.md +++ b/src/content/docs/aws/tooling/dns-server.md @@ -240,7 +240,7 @@ When correctly configured, either using the LocalStack CLI command or manually, #### Other resolution settings Depending on your Linux distribution, the settings to set a DNS server can be quite different. -In some systems, directly editing `/etc/resolv.conf` is possible, like described in [macOS](#mac-os). +In some systems, directly editing `/etc/resolv.conf` is possible, like described in [macOS](#macos). If your `/etc/resolv.conf` is overwritten by some service, it might be possible to install and enable/start `resolvconf` and specify the nameserver in `/etc/resolvconf/resolv.conf.d/head` with `nameserver 127.0.0.1`. This will prepend this line in the resolv.conf file even after changes. diff --git a/src/content/docs/aws/tooling/event-studio.md b/src/content/docs/aws/tooling/event-studio.md index 534fff36..eb2d3cac 100644 --- a/src/content/docs/aws/tooling/event-studio.md +++ b/src/content/docs/aws/tooling/event-studio.md @@ -93,4 +93,4 @@ The following services are supported on Event Studio: - [SNS](/aws/services/sns/) - [DynamoDB](/aws/services/dynamodb/) - [Lambda](/aws/services/lambda/) -- [EventBridge](/aws/services//events/) +- [EventBridge](/aws/services/events/) diff --git a/src/content/docs/aws/tooling/extensions/managing-extensions.mdx b/src/content/docs/aws/tooling/extensions/managing-extensions.mdx index 3d1f9ec0..e0315765 100644 --- a/src/content/docs/aws/tooling/extensions/managing-extensions.mdx +++ b/src/content/docs/aws/tooling/extensions/managing-extensions.mdx @@ -10,7 +10,7 @@ import { FileTree } from '@astrojs/starlight/components'; You have different options to install and manage your LocalStack extensions depending on your environment and work style. -Extensions are managed through the LocalStack container, but stored in the [LocalStack volume](/aws/capabilities/config/filesystem-layout) on your host. +Extensions are managed through the LocalStack container, but stored in the [LocalStack volume](/aws/capabilities/config/filesystem) on your host. The next time you start up LocalStack, your extensions will still be there! ## Using the extensions manager in our App @@ -167,7 +167,7 @@ When LocalStack starts up, you should see it tries to install the extensions and ## Extension Management within LocalStack -Extensions in LocalStack are Python distributions that operate within their dedicated virtual environment, residing in the [LocalStack Volume](/aws/capabilities/config/filesystem-layout). +Extensions in LocalStack are Python distributions that operate within their dedicated virtual environment, residing in the [LocalStack Volume](/aws/capabilities/config/filesystem). This involves the creation of a"variable packages folder `/var/lib/localstack/lib`," where the volume management system establishes both an `extensions` folder and a virtual environment named `python_venv`. Within this environment, all extensions and their dependencies are managed. LocalStack integrates its virtual environment, ensuring the resolution of all transitive dependencies associated with extensions. diff --git a/src/content/docs/snowflake/getting-started/quickstart.md b/src/content/docs/snowflake/getting-started/quickstart.md index 98d1012d..3688c1c7 100644 --- a/src/content/docs/snowflake/getting-started/quickstart.md +++ b/src/content/docs/snowflake/getting-started/quickstart.md @@ -129,7 +129,7 @@ To stop LocalStack and remove locally created resources, use: localstack stop ``` -LocalStack is ephemeral and doesn't persist data across restarts. It runs inside a Docker container, and once it’s stopped, all locally created resources are automatically removed. In a future release of the Snowflake emulator, we will provide proper persistence and integration with our [Cloud Pods](https://docs.localstack.cloud/user-guide/state-management/cloud-pods/) feature as well. +LocalStack is ephemeral and doesn't persist data across restarts. It runs inside a Docker container, and once it’s stopped, all locally created resources are automatically removed. In a future release of the Snowflake emulator, we will provide proper persistence and integration with our [Cloud Pods](https://docs.localstack.cloud/aws/capabilities/state-management/cloud-pods) feature as well. ## Next steps diff --git a/src/content/docs/snowflake/index.md b/src/content/docs/snowflake/index.md index d1104b29..e72c7259 100644 --- a/src/content/docs/snowflake/index.md +++ b/src/content/docs/snowflake/index.md @@ -35,4 +35,4 @@ The Snowflake emulator supports the following features: Integrating the Snowflake emulator into your existing CI/CD pipeline allows you to run integration tests and identify issues early, reducing surprises during production deployment. -Check our [SQL Functions Coverage](/snowflake/sql-functions) and [Feature Coverage](/snowflake/coverage-features) pages for a comprehensive list of supported features. +Check our [SQL Functions Coverage](/snowflake/sql-functions) and [Feature Coverage](/snowflake/features) pages for a comprehensive list of supported features. From b95b468ed130912319ce65eb1bde04abba914a5b Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Fri, 20 Jun 2025 10:39:33 +0530 Subject: [PATCH 3/3] fix all links --- src/content/docs/aws/getting-started/installation.mdx | 2 +- src/content/docs/aws/getting-started/quickstart.mdx | 6 +++--- src/content/docs/aws/integrations/aws-sdks/python-boto3.md | 2 +- .../aws/integrations/continuous-integration/codebuild.md | 2 +- .../aws/integrations/continuous-integration/gitlab-ci.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/content/docs/aws/getting-started/installation.mdx b/src/content/docs/aws/getting-started/installation.mdx index 3e69f7b9..cd05ca4f 100644 --- a/src/content/docs/aws/getting-started/installation.mdx +++ b/src/content/docs/aws/getting-started/installation.mdx @@ -226,7 +226,7 @@ Learn more about our desktop client at [LocalStack Desktop](/aws/capabilities/we ### LocalStack Docker Extension Install our [official Docker Desktop extension](https://hub.docker.com/extensions/localstack/localstack-docker-desktop) to manage LocalStack. -See [LocalStack Docker Extension](/aws/tooling/extensions/localstack-docker-extension) for more information. +See [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension) for more information. ### Docker-Compose diff --git a/src/content/docs/aws/getting-started/quickstart.mdx b/src/content/docs/aws/getting-started/quickstart.mdx index d88e6e42..eb27a1db 100644 --- a/src/content/docs/aws/getting-started/quickstart.mdx +++ b/src/content/docs/aws/getting-started/quickstart.mdx @@ -356,6 +356,6 @@ To expand your LocalStack capabilities, explore the following based on your expe - [Tutorials](/aws/tutorials): Check out our tutorials to learn how to use LocalStack across various AWS services and application stacks. - [Supported Services](/aws/services): Explore LocalStack's emulated AWS services. -- [Capabilities](/capabilities): Learn about LocalStack's capabilities including features like IAM policy stream, state management, and more. -- [Tooling](/tooling): Get details on LocalStack's tooling and integrations. -- [Blog](https://blog.localstack.cloud): Read our blog posts about LocalStack and the latest enhancements for a better local development and testing experience. \ No newline at end of file +- [Capabilities](): Learn about LocalStack's capabilities including features like IAM policy stream, state management, and more. +- [Tooling](): Get details on LocalStack's tooling and integrations. +- [Blog](https://blog.localstack.cloud): Read our blog posts about LocalStack and the latest enhancements for a better local development and testing experience. diff --git a/src/content/docs/aws/integrations/aws-sdks/python-boto3.md b/src/content/docs/aws/integrations/aws-sdks/python-boto3.md index 0bdcb563..ce9a3136 100644 --- a/src/content/docs/aws/integrations/aws-sdks/python-boto3.md +++ b/src/content/docs/aws/integrations/aws-sdks/python-boto3.md @@ -29,7 +29,7 @@ if __name__ == "__main__": :::note -If you're connecting from within a Python **Lambda function** handler in LocalStack, you can create a default client without configuring the `endpoint_url` - LocalStack will automatically forward the invocations to the local API endpoints (available in Pro, see [here](/aws/tooling/transparent-endpoint-injection) for more details). +If you're connecting from within a Python **Lambda function** handler in LocalStack, you can create a default client without configuring the `endpoint_url` - LocalStack will automatically forward the invocations to the local API endpoints (available in Pro, see [here](/aws/capabilities/networking/transparent-endpoint-injection) for more details). ::: ```python diff --git a/src/content/docs/aws/integrations/continuous-integration/codebuild.md b/src/content/docs/aws/integrations/continuous-integration/codebuild.md index 8d82676d..20ee5a44 100644 --- a/src/content/docs/aws/integrations/continuous-integration/codebuild.md +++ b/src/content/docs/aws/integrations/continuous-integration/codebuild.md @@ -56,7 +56,7 @@ phases: ### Configuration -Get know more about the LocalStack [config options](/references/configuration/). +Get know more about the LocalStack [config options](/aws/capabilities/config/configuration). #### Native Runner diff --git a/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md b/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md index 957db4da..81572dc1 100644 --- a/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md +++ b/src/content/docs/aws/integrations/continuous-integration/gitlab-ci.md @@ -225,4 +225,4 @@ Find out more about ephemeral instances [here](/aws/capabilities/cloud-sandbox/e ## Examples -[End-to-End Testing in Gitlab CI with Testcontainers and LocalStack: Understanding Runners and Docker in Docker](/aws/tutorials/gitlab_ci_testcontainers) {/*TODO: link target doesn't exist yet*/} - A readily configured demo project, that will walk you through the process of setting up end-to-end testing for a backend application using Testcontainers and LocalStack within GitLab CI. \ No newline at end of file +[End-to-End Testing in Gitlab CI with Testcontainers and LocalStack: Understanding Runners and Docker in Docker]() {/*TODO: link target doesn't exist yet*/} - A readily configured demo project, that will walk you through the process of setting up end-to-end testing for a backend application using Testcontainers and LocalStack within GitLab CI.