Skip to content

Commit 318dc59

Browse files
docs: cherrypick aws docs + commit progress for team visibility (localstack#5)
* adding Getting Started progress for team visibility * started adding capabilities/web app + finished Getting Started * finished capabilities/web app + config * finished capabilities/cloud-sandbox section * finished Capabilities/Networking * finished Capabilities/State Management, Chaos Engineering, Security Testing * finished /Tooling
1 parent 232de20 commit 318dc59

24 files changed

+141
-87
lines changed

package-lock.json

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/content/docs/aws/capabilities/chaos-engineering/chaos-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If you'd like to try it out, please [contact us](https://www.localstack.cloud/de
3232

3333
The prerequisites for this guide are:
3434

35-
- 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/)
35+
- LocalStack Pro with [LocalStack CLI](/aws/getting-started/installation/) & [LocalStack Auth Token](/aws/getting-started/auth-token/)
3636
- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
3737
- [Python](https://www.python.org/downloads/)
3838

src/content/docs/aws/capabilities/cloud-sandbox/app-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ preview-cmd: |
110110

111111
## Examples
112112

113-
- [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)
113+
- [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)

src/content/docs/aws/capabilities/cloud-sandbox/ephemeral-instances.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ To query the list of S3 buckets in the Ephemeral Instance, run the following com
6464
aws --endpoint-url=<EPHEMERAL_INSTANCE_ENDPOINT_URL> s3 ls
6565
```
6666

67-
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.
67+
You can also use integrations, such as [CDK](/aws/integrations/aws-native-tools/aws-cdk/), [SAM CLI](/aws/integrations/aws-native-tools/aws-sam/), and [Terraform](/aws/integrations/infrastructure-as-code/terraform/), to interact with the Ephemeral Instance.
6868
In these integrations, you can change the `AWS_ENDPOINT_URL` environment variable to the endpoint URL of the Ephemeral Instance.
6969

7070
### 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
8686

8787
## Ephemeral Instances CLI
8888

89-
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.
89+
The Ephemeral Instances CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#installing-localstack-cli), so no additional installations are needed to start using it.
9090
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.
9191

9292
Access the Ephemeral Instances CLI by running the `localstack ephemeral` command from your terminal.

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

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ This section covers configuration options that are specific to certain AWS servi
122122
| - | - | - |
123123
| `PROVIDER_OVERRIDE_CLOUDWATCH` | `v1` | Use the old CloudWatch provider. |
124124

125+
### CodeBuild
126+
127+
| Variable | Example Values | Description |
128+
| - | - | - |
129+
| `CODEBUILD_REMOVE_CONTAINERS` | `0`\|`1` (default) | Remove Docker containers associated with a CodeBuild build tasks after execution. Disabling this and dumping container logs might help with troubleshooting failing builds. |
130+
131+
### CodePipeline
132+
133+
| Variable | Example Values | Description |
134+
| - | - | - |
135+
| `CODEPIPELINE_GH_TOKEN` | | GitHub Personal Access Token to used by CodeConnections Source action to access private repositories on GitHub. |
136+
125137
### DMS
126138

127139
| Variable | Example Values | Description |
@@ -224,6 +236,9 @@ Also see [OpenSearch configuration variables](#opensearch) which are used to man
224236
| `KINESIS_SHARD_LIMIT` | `100` (default), `Infinity` (to disable) | Integer value , causing the Kinesis API to start throwing exceptions to mimic the default shard limit. |
225237
| `KINESIS_ON_DEMAND_STREAM_COUNT_LIMIT` | `10` (default), `Infinity` (to disable) | Integer value , causing the Kinesis API to start throwing exceptions to mimic the default on demand stream count limit. |
226238
| `KINESIS_LATENCY` | `500` (default), `0` (to disable)| Integer value of milliseconds, causing the Kinesis API to delay returning a response in order to mimic latency from a live AWS call. |
239+
| `KINESIS_MOCK_PROVIDER_ENGINE` | `node` (default) \| `scala` | String value of `node` (default) or `scala` that determines the underlying build of Kinesis Mock. |
240+
| `KINESIS_MOCK_MAXIMUM_HEAP_SIZE` | `512m` (default) | JVM memory format string that sets the maximum memory size for the Kinesis Mock Scala server, corresponds to the JVM `-Xmx` flag. |
241+
| `KINESIS_MOCK_INITIAL_HEAP_SIZE` | `256m` (default) | JVM memory format string that sets the initial memory size for the Kinesis Mock Scala server, corresponds to the JVM `-Xms` flag. |
227242

228243
### Lambda
229244

@@ -304,11 +319,12 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2
304319
| Variable | Example Values | Description |
305320
| - | - | - |
306321
| `RDS_CLUSTER_ENDPOINT_HOST_ONLY` | `1` (default) \| `0` | Whether the cluster endpoint returns the host only (which is AWS parity). If set to `0` it will return `<host>:<port>`. |
307-
| `RDS_PG_CUSTOM_VERSIONS` | `0` \| `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
322+
| `RDS_PG_CUSTOM_VERSIONS` | `0` \| `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 15). |
308323
| `RDS_MYSQL_DOCKER` | `1` (default) \| `0` | Whether to disable MySQL engines (and use MariaDB instead). MySQL engine for cluster/instances will start in a new docker container. If you have troubles running MySQL in docker, you can disable the feature. |
309324
| `MYSQL_IMAGE` | `mysql:8.0` | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if `RDS_MYSQL_DOCKER` is enabled. |
310325
| `MSSQL_IMAGE` | `mcr.microsoft.com/mssql/server:2022-latest` | Defines a specific image that should be used when spinning up a SQL server engine. |
311326
| `MSSQL_ACCEPT_EULA` | `Y` | Set to `Y` if you accept the [EULA from MSSQL](https://hub.docker.com/_/microsoft-mssql-server). |
327+
| `RDS_PG_MAX_CONNECTIONS` | `0` (default) | Sets the maximum number of connections for Postgres RDS instances. |
312328

313329
### S3
314330

@@ -329,11 +345,17 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2
329345
| - | - | - |
330346
| `SQS_DELAY_PURGE_RETRY` | `0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
331347
| `SQS_DELAY_RECENTLY_DELETED` | `0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
332-
| `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) |
333-
| `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) |
348+
| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](/aws/sqs/#enabling-messageretentionperiod) |
349+
| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](/aws/sqs/#queue-urls) |
334350
| `SQS_DISABLE_CLOUDWATCH_METRICS` | `0` (default) | Disables the CloudWatch Metrics for SQS when set to `1` |
335351
| `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` |
336352

353+
### Step Functions
354+
355+
| Variable | Example Values | Description |
356+
| - | - | - |
357+
| `SFN_MOCK_CONFIG` | `/tmp/MockConfigFile.json` | Specifies the file path to the mock configuration file that defines mock service integrations for Step Functions. |
358+
337359
## Security
338360

339361
:::danger
@@ -492,9 +514,9 @@ These configurations have already been removed and **won't have any effect** on
492514
| `DATA_DIR`| 2.0.0 | blank (disabled/default), `/tmp/localstack/data` | Local directory for saving persistent data. Use `PERSISTENCE` instead. |
493515
| `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.
494516
| `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.` |
495-
| `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/). |
517+
| `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/). |
496518
| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem-layout). |
497-
| `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/). |
519+
| `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). |
498520
| `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) |
499521
| `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | |
500522
| `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/docker-images.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ docker pull localstack/localstack:latest
2121

2222
To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud).
2323
The Community image is free to use and does not require a license to run.
24-
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/).
24+
The Community image can be used to run [local AWS services](/aws/) with [integrations](/aws/integrations/) on your local machine or in your [continuous integration pipelines](/aws/integrations/continuous-integration/).
2525

26-
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.
27-
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.
26+
The Community image also covers a limited set of [LocalStack Tools](/aws/tooling/) to make your life as a cloud developer easier.
27+
You can use [LocalStack Desktop](/aws/capabilities/web-app/localstack-desktop/) or [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension) to use LocalStack with a graphical user interface.
2828

29-
You can use the Community image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
29+
You can use the Community image to start your LocalStack container using various [installation methods](/aws/getting-started/installation/).
3030
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`).
3131

3232
## LocalStack Pro image
@@ -41,9 +41,9 @@ docker pull localstack/localstack-pro:latest
4141

4242
To use the LocalStack Pro image, you must configure an environment variable named `LOCALSTACK_AUTH_TOKEN` to contain your Auth Token.
4343
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.
44-
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).
44+
LocalStack Pro gives you access to the complete set of LocalStack features, including the [LocalStack Web Application](https://app.localstack.cloud) and [dedicated customer support](/aws/getting-started/help-support/#enterprise-support).
4545

46-
You can use the Pro image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
46+
You can use the Pro image to start your LocalStack container using various [installation methods](/aws/getting-started/installation/).
4747
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`).
4848

4949
:::note

src/content/docs/aws/capabilities/config/internal-endpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ curl -v --request POST --header "Content-Type: application/json" --data '{"acti
3333

3434
The API path for the AWS internal resources is `/_aws`.
3535
These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services.
36-
For instance, `/aws/sqs/messages` conveniently access all messages withing a SQS queue, without deleting them.
36+
For instance, `/aws/sqs/messages` conveniently access all messages within a SQS queue, without deleting them.

src/content/docs/aws/capabilities/config/logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,5 @@ With Docker/Docker-Compose, you can run `docker ps` to get the container ID of t
6363

6464
To view the logs via a user interface, you can use the following options:
6565

66-
- [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/)
67-
- [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/)
66+
- [LocalStack Desktop](/aws/capabilities/web-app/localstack-desktop/)
67+
- [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension/)

src/content/docs/aws/capabilities/networking/internal-endpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ $ curl -v --request POST --header "Content-Type: application/json" --data '{"ac
3535

3636
The API path for the AWS internal resources is `/_aws`.
3737
These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services.
38-
For instance, `/aws/sqs/messages` conveniently access all messages withing a SQS queue, without deleting them.
38+
For instance, `/aws/sqs/messages` conveniently access all messages within a SQS queue, without deleting them.

src/content/docs/aws/capabilities/networking/transparent-endpoint-injection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Make sure to use this only for local testing, and never in production.
108108
## Current Limitations
109109

110110
- The mechanism to disable certificate validation for these requests is not currently functional with Go Lambdas.
111-
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/).
111+
To work around this issue, you'll need to manually set your endpoint when creating your AWS SDK client, as detailed in our documentation on the [Go AWS SDK](/aws/integrations/aws-sdks/go).
112112

113113
## Troubleshooting
114114

0 commit comments

Comments
 (0)