Skip to content

Commit 87262fd

Browse files
Move aws/capabilities docs to aws/configuration (#735)
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent a4b3311 commit 87262fd

89 files changed

Lines changed: 358 additions & 275 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

astro.config.mjs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -556,15 +556,15 @@ export default defineConfig({
556556
items: [
557557
{
558558
label: 'Overview',
559-
slug: 'aws/capabilities',
559+
slug: 'aws/configuration',
560560
},
561561
{
562562
label: 'LocalStack Web App',
563563
collapsed: true,
564564
items: [
565565
{
566566
autogenerate: {
567-
directory: '/aws/capabilities/web-app',
567+
directory: '/aws/configuration/web-app',
568568
},
569569
},
570570
],
@@ -575,7 +575,7 @@ export default defineConfig({
575575
items: [
576576
{
577577
autogenerate: {
578-
directory: '/aws/capabilities/config',
578+
directory: '/aws/configuration/config',
579579
},
580580
},
581581
],
@@ -586,7 +586,7 @@ export default defineConfig({
586586
items: [
587587
{
588588
autogenerate: {
589-
directory: '/aws/capabilities/networking',
589+
directory: '/aws/configuration/networking',
590590
},
591591
},
592592
],
@@ -597,7 +597,7 @@ export default defineConfig({
597597
items: [
598598
{
599599
autogenerate: {
600-
directory: '/aws/capabilities/localstack-sdks',
600+
directory: '/aws/configuration/localstack-sdks',
601601
},
602602
},
603603
],
@@ -607,7 +607,7 @@ export default defineConfig({
607607
items: [
608608
{
609609
autogenerate: {
610-
directory: '/aws/capabilities/extensions',
610+
directory: '/aws/configuration/extensions',
611611
},
612612
},
613613
{
@@ -619,19 +619,19 @@ export default defineConfig({
619619
},
620620
{
621621
label: 'DNS Server',
622-
slug: 'aws/capabilities/dns-server',
622+
slug: 'aws/configuration/dns-server',
623623
},
624624
{
625625
label: 'Testing Utils',
626-
slug: 'aws/capabilities/testing-utils',
626+
slug: 'aws/configuration/testing-utils',
627627
},
628628
{
629629
label: 'LocalStack Docker Extension',
630-
slug: 'aws/capabilities/localstack-docker-extension',
630+
slug: 'aws/configuration/localstack-docker-extension',
631631
},
632632
{
633633
label: 'LocalSurf',
634-
slug: 'aws/capabilities/localsurf',
634+
slug: 'aws/configuration/localsurf',
635635
},
636636
],
637637
},

public/_redirects

Lines changed: 187 additions & 104 deletions
Large diffs are not rendered by default.

src/components/PageTitleWithCopyButton.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const hiddenPaths = [
1212
'aws',
1313
'aws/services',
1414
'aws/sample-apps',
15-
'aws/capabilities',
15+
'aws/configuration',
1616
'aws/tooling',
1717
'aws/integrations',
1818
'aws/enterprise',

src/content/docs/aws/capabilities/config/arm64-support.md renamed to src/content/docs/aws/configuration/config/arm64-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Since LocalStack&nbsp;2.0, Lambda functions execute in Docker containers with th
3232
depending on the [instruction set architecture](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) configured for the function (`x86_64` by default or `arm64`).
3333
This behavior can lead to errors if the host system, the Docker image, or the code/layer of the function do not support the target architecture.
3434

35-
If you prefer to execute Lambda functions on your native platform architecture, you can set the [Lambda configuration](https://docs.localstack.cloud/aws/capabilities/config/configuration/#lambda) variable to `LAMBDA_IGNORE_ARCHITECTURE=1`.
35+
If you prefer to execute Lambda functions on your native platform architecture, you can set the [Lambda configuration](https://docs.localstack.cloud/aws/configuration/config/configuration/#lambda) variable to `LAMBDA_IGNORE_ARCHITECTURE=1`.
3636
Example scenario: I have an amd64 machine and want to run a an arm64 Lambda function. I know that the Lambda function runs on both architectures (i.e., no architecture specific code or dependencies).
3737

3838
Host systems with [multi-architecture support](https://docs.docker.com/build/building/multi-platform/) can run containers for different Linux architectures using emulation.

src/content/docs/aws/capabilities/config/configuration.md renamed to src/content/docs/aws/configuration/config/configuration.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,24 @@ Options that affect the core LocalStack system.
3131
| `LOCALSTACK_HOST`| `localhost.localstack.cloud:4566` (default) | This is interpolated into URLs and addresses that are returned by LocalStack. It has the form `<hostname>:<port>`. |
3232
| `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 `<ip address>:<port>(,<ip address>:<port>)*`. LocalStack for AWS adds port `443`. |
3333
| `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. |
34-
| `PERSISTENCE` | `0` (default) | Enable persistence. See [Persistence Mechanism](/aws/developer-tools/snapshots/persistence) and [Filesystem Layout](/aws/capabilities/config/filesystem). |
34+
| `PERSISTENCE` | `0` (default) | Enable persistence. See [Persistence Mechanism](/aws/developer-tools/snapshots/persistence) and [Filesystem Layout](/aws/configuration/config/filesystem). |
3535
| `MAIN_CONTAINER_NAME` | `localstack-main` (default) | Specify the main docker container name |
3636
| `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. |
37-
| `EXTERNAL_SERVICE_PORTS_START` | `4510` (default) | Start of the [External Service Port Range](/aws/capabilities/networking/external-port-range) (inclusive). |
38-
| `EXTERNAL_SERVICE_PORTS_END` | `4560` (default) | End of the [External Service Port Range](/aws/capabilities/networking/external-port-range) (exclusive). |
37+
| `EXTERNAL_SERVICE_PORTS_START` | `4510` (default) | Start of the [External Service Port Range](/aws/configuration/networking/external-port-range) (inclusive). |
38+
| `EXTERNAL_SERVICE_PORTS_END` | `4560` (default) | End of the [External Service Port Range](/aws/configuration/networking/external-port-range) (exclusive). |
3939
| `EAGER_SERVICE_LOADING` | `0` (default) \|`1` | Boolean that toggles lazy loading of services. If eager loading is enabled, services are started at LocalStack startup rather than their first use. Be aware that eager loading increases the LocalStack startup time. |
40-
| `SERVICES`| `s3,sqs` | A comma-delimited string of services. Check the [internal health endpoint](/aws/capabilities/networking/internal-endpoints#localstack-endpoints) `/_localstack/health` for valid service names. If `SERVICES` is set LocalStack will only load the listed services. All other services will be disabled and cannot be used. |
40+
| `SERVICES`| `s3,sqs` | A comma-delimited string of services. Check the [internal health endpoint](/aws/configuration/networking/internal-endpoints#localstack-endpoints) `/_localstack/health` for valid service names. If `SERVICES` is set LocalStack will only load the listed services. All other services will be disabled and cannot be used. |
4141
| `ALLOW_NONSTANDARD_REGIONS` | `0` (default) | Allows the use of non-standard AWS regions. By default, LocalStack only accepts [standard AWS regions](https://docs.aws.amazon.com/general/latest/gr/rande.html). |
4242
| `PARITY_AWS_ACCESS_KEY_ID` | `0` (default) | Enables the use production-like access key IDs. By default, LocalStack issues keys with `LSIA...` and `LKIA...` prefix, and will reject keys that start with `ASIA...` or `AKIA...`. |
43-
| `LOCALSTACK_RESPONSE_HEADER_ENABLED` | `1` (default) \| `0` | Whether LocalStack adds the [`x-localstack` response header](/aws/capabilities/networking/internal-endpoints#x-localstack-response-header) to every AWS API response. The header value is the LocalStack version and lets client tools detect LocalStack and its version. |
43+
| `LOCALSTACK_RESPONSE_HEADER_ENABLED` | `1` (default) \| `0` | Whether LocalStack adds the [`x-localstack` response header](/aws/configuration/networking/internal-endpoints#x-localstack-response-header) to every AWS API response. The header value is the LocalStack version and lets client tools detect LocalStack and its version. |
4444

4545
## CLI
4646

4747
These options are applicable when using the CLI to start LocalStack.
4848

4949
| Variable | Example Values | Description |
5050
| - | - | - |
51-
| `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) |
51+
| `LOCALSTACK_VOLUME_DIR` | `~/.cache/localstack/volume` (on Linux) | The location on the host of the LocalStack volume directory mount. See [Filesystem Layout](/aws/configuration/config/filesystem#using-the-cli) |
5252
| `CONFIG_PROFILE` | | The configuration profile to load. See [Profiles](#profiles) |
5353
| `CONFIG_DIR` | `~/.localstack` | The path where LocalStack can find configuration profiles and other CLI-specific configuration |
5454

@@ -262,8 +262,8 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2
262262
| `BUCKET_MARKER_LOCAL` | `hot-reload` (default) | Magic S3 bucket name for [Hot Reloading](/aws/developer-tools/lambda-tools/hot-reloading). The S3Key points to the source code on the local file system. |
263263
| `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`.|
264264
| `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). |
265-
| `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).|
266-
| `LAMBDA_DOCKER_DNS` | `""` (default) | Optional custom DNS server for the container running your Lambda function. Overwrites the default LocalStack [DNS Server](/aws/capabilities/dns-server). Hence, resolving `localhost.localstack.cloud` requires additional configuration. |
265+
| `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/configuration/networking/transparent-endpoint-injection).|
266+
| `LAMBDA_DOCKER_DNS` | `""` (default) | Optional custom DNS server for the container running your Lambda function. Overwrites the default LocalStack [DNS Server](/aws/configuration/dns-server). Hence, resolving `localhost.localstack.cloud` requires additional configuration. |
267267
| `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. |
268268
| `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. |
269269
| `LAMBDA_DOWNLOAD_AWS_LAYERS` | `1` (default, pro) | Whether to download public Lambda layers from AWS through a LocalStack proxy when creating or updating functions. |
@@ -415,8 +415,8 @@ To learn more about these configuration options, see [Cloud Pods](/aws/developer
415415

416416
| Variable | Example Values | Description |
417417
| - | - | - |
418-
| `EXTENSION_AUTO_INSTALL` | | Install a list of extensions automatically at startup. Comma-separated list of extensions directives which will be installed automatically at startup (see [managing extensions](/aws/capabilities/extensions/managing-extensions#automating-extensions-installation))|
419-
| `EXTENSION_DEV_MODE` | `0` (default) \| `1` | Enables development mode for extensions. Refer to the [Extensions Development Guide](/aws/capabilities/extensions/developing-extensions) for more information. |
418+
| `EXTENSION_AUTO_INSTALL` | | Install a list of extensions automatically at startup. Comma-separated list of extensions directives which will be installed automatically at startup (see [managing extensions](/aws/configuration/extensions/managing-extensions#automating-extensions-installation))|
419+
| `EXTENSION_DEV_MODE` | `0` (default) \| `1` | Enables development mode for extensions. Refer to the [Extensions Development Guide](/aws/configuration/extensions/developing-extensions) for more information. |
420420

421421
## Miscellaneous
422422

@@ -442,21 +442,21 @@ To learn more about these configuration options, see [Cloud Pods](/aws/developer
442442

443443
## DNS
444444

445-
To learn more about these configuration options, see [DNS Server](/aws/capabilities/dns-server).
445+
To learn more about these configuration options, see [DNS Server](/aws/configuration/dns-server).
446446

447447
| Variable | Example Values | Description |
448448
| - | - | - |
449449
| `DNS_ADDRESS` | `0.0.0.0` (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value `0` to disable.
450450
| `DNS_SERVER` | Default upstream DNS or `8.8.8.8` (default) | Fallback DNS server for queries not handled by LocalStack.
451451
| `DNS_RESOLVE_IP` | `127.0.0.1` (default) | IP address the DNS server should return as A record for queries handled by LocalStack. If customized, this value will be returned in preference to the DNS server response.
452-
| `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | `([^.]+\.)*(ecr\|lambda)\.[^.]+\.amazonaws\.com` (example) | List of domain names that should *NOT* be redirected by the LocalStack DNS to the LocalStack container, but instead always forwarded to the upstream resolver. This will *NOT* redirect requests made to LocalStack due to manual endpoint configuration. Comma-separated list of Python-flavored regex patterns. See [the DNS server documentation](/aws/capabilities/dns-server#skip-localstack-dns-resolution) for more details.
452+
| `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | `([^.]+\.)*(ecr\|lambda)\.[^.]+\.amazonaws\.com` (example) | List of domain names that should *NOT* be redirected by the LocalStack DNS to the LocalStack container, but instead always forwarded to the upstream resolver. This will *NOT* redirect requests made to LocalStack due to manual endpoint configuration. Comma-separated list of Python-flavored regex patterns. See [the DNS server documentation](/aws/configuration/dns-server#skip-localstack-dns-resolution) for more details.
453453
| `DNS_LOCAL_NAME_PATTERNS` | `([^.]+\.)*(ecr\|lambda)\.[^.]+\.amazonaws\.com` (example) | **Deprecated since 3.0.2** List of domain names that should *NOT* be redirected by the LocalStack DNS to the LocalStack container, but instead always forwarded to the upstream resolver. This will *NOT* redirect requests made to LocalStack due to manual endpoint configuration. Comma-separated list of Python-flavored regex patterns. **Renamed to `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM`**
454454

455455
## Transparent Endpoint Injection
456456

457457
| Variable | Example Values | Description |
458458
| - | - | - |
459-
| `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))
459+
| `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/configuration/networking/transparent-endpoint-injection))
460460

461461
## LocalStack for AWS
462462

@@ -522,9 +522,9 @@ These configurations have already been removed and **won't have any effect** on
522522
| `DATA_DIR`| 2.0.0 | blank (disabled/default), `/tmp/localstack/data` | Local directory for saving persistent data. Use `PERSISTENCE` instead. |
523523
| `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.
524524
| `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.` |
525-
| `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/). |
526-
| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem). |
527-
| `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). |
525+
| `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/configuration/config/initialization-hooks/). |
526+
| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/configuration/config/filesystem). |
527+
| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](/aws/configuration/config/initialization-hooks). |
528528
| `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) |
529529
| `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | |
530530
| `SYNCHRONOUS_API_GATEWAY_EVENTS` | 2.0.0 | `1` (default) \| `0` | Whether or not to handle API Gateway Lambda event sources as synchronous invocations. |

src/content/docs/aws/capabilities/config/credentials.md renamed to src/content/docs/aws/configuration/config/credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Like AWS, LocalStack requires AWS credentials to be supplied in all API operatio
88

99
## Access Key ID
1010

11-
For root accounts, the choice of access key ID affects [multi-account namespacing](/aws/capabilities/config/multi-account-setups).
11+
For root accounts, the choice of access key ID affects [multi-account namespacing](/aws/configuration/config/multi-account-setups).
1212

1313
Access key IDs can be one of following patterns:
1414

src/content/docs/aws/capabilities/config/cross-account-access.md renamed to src/content/docs/aws/configuration/config/cross-account-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The full list of resources and operations that allow cross-account access are li
5959

6060
:::tip
6161
LocalStack does not enforce IAM for cross-account access by default.
62-
Use the `ENFORCE_IAM` [configuration](/aws/capabilities/config/configuration#iam) option to enable it.
62+
Use the `ENFORCE_IAM` [configuration](/aws/configuration/config/configuration#iam) option to enable it.
6363
:::
6464

6565
### EC2 Peering

src/content/docs/aws/capabilities/config/docker-images.md renamed to src/content/docs/aws/configuration/config/docker-images.md

File renamed without changes.

0 commit comments

Comments
 (0)