Skip to content

Commit 1e3faef

Browse files
github-actions[bot]github-actions[bot]
authored
Automated documentation update [skip ci] (#3)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 5ec5cd2 commit 1e3faef

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed

‎src/localstack-dind/README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
# LocalStack Docker-in-Docker (localstack-dind)
3+
4+
A template to manage LocalStack in DinD via CLI
5+
6+
## Options
7+
8+
| Options Id | Description | Type | Default Value |
9+
|-----|-----|-----|-----|
10+
| imageVariant | Debian version (use bullseye or jammy on local arm64/Apple Silicon): | string | jammy |
11+
| awslocal | Install LocalStack wrapper for AWS CLI: | boolean | false |
12+
| cdklocal | Install LocalStack wrapper for CDK: | boolean | false |
13+
| pulumilocal | Install LocalStack wrapper for Pulumi: | boolean | false |
14+
| samlocal | Install LocalStack wrapper for AWS SAM CLI: | boolean | false |
15+
| tflocal | Install LocalStack wrapper for Terraform: | boolean | false |
16+
| logLevel | Set LocalStack log level: | string | info |
17+
| debug | - | boolean | false |
18+
| persistence | - | boolean | false |
19+
| usePro | - | boolean | false |
20+
| version | - | string | latest |
21+
| loadPods | - | string | |
22+
| volumePath | - | string | ./.volume |
23+
| enforceIam | - | boolean | false |
24+
| defaultRegion | - | string | us-east-1 |
25+
| startup | Start up LocalStack: | boolean | true |
26+
27+
This version of the Template starts up LocalStack in an internal Docker service in the DevContainer, hence we set a volume by default for data persistence.
28+
As a result the newly built DevContainers do not necessarily need to re-download images as long this volume exists on the system.
29+
Additionally the DevContainer bind mounts a folder from the host system as `/data`, which will be used to store LocalStack data (`LOCALSTACK_VOLUME_DIR`).
30+
31+
The Template adds automatically the [official LocalStack DevContainer Feature](https://github.com/localstack/devcontainer-feature), which installs the CLI and by demand the most popular *Local Tools™*.
32+
Currently this calls for a **Debian-based** DevContainer image.
33+
34+
LocalStack in this variation is controlled via the LocalStack CLI and some env variables that you can adjust or expand in the `devcontainer.json` file's `remoteEnv` block.
35+
For further LocalStack configuration options please consult our [official documentation](https://docs.localstack.cloud/references/configuration/).
36+
37+
## Use LocalStack Pro
38+
39+
Set `usePro: true` and set on your host system the `LOCALSTACK_AUTH_TOKEN` or the `LOCALSTACK_API_KEY` environment variable, this will be automatically picked up by the Template.
40+
41+
---
42+
43+
_Note: This file was auto-generated from the [devcontainer-template.json](https://github.com/localstack/devcontainer-template/blob/main/src/localstack-dind/devcontainer-template.json). Add additional notes to a `NOTES.md`._

‎src/localstack-dood/README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
2+
# LocalStack Docker-outside-of-Docker (localstack-dood)
3+
4+
A template to manage LocalStack in DooD
5+
6+
## Options
7+
8+
| Options Id | Description | Type | Default Value |
9+
|-----|-----|-----|-----|
10+
| imageVariant | Debian version (use bullseye or jammy on local arm64/Apple Silicon): | string | jammy |
11+
| awslocal | Install LocalStack wrapper for AWS CLI: | boolean | false |
12+
| cdklocal | Install LocalStack wrapper for CDK: | boolean | false |
13+
| pulumilocal | Install LocalStack wrapper for Pulumi: | boolean | false |
14+
| samlocal | Install LocalStack wrapper for AWS SAM CLI: | boolean | false |
15+
| tflocal | Install LocalStack wrapper for Terraform: | boolean | false |
16+
| logLevel | Set LocalStack log level: | string | info |
17+
| networkName | - | string | ls |
18+
| networkCidr | - | string | 10.0.2.0/24 |
19+
| ipAddress | - | string | 10.0.2.20 |
20+
| host | - | string | localhost.localstack.cloud:4566 |
21+
| debug | - | boolean | false |
22+
| persistence | - | boolean | false |
23+
| usePro | - | boolean | false |
24+
| version | - | string | latest |
25+
| loadPods | - | string | |
26+
| volumePath | - | string | ./.volume |
27+
| enforceIam | - | boolean | false |
28+
| defaultRegion | - | string | us-east-1 |
29+
30+
This version of the Template starts up LocalStack as a separate container in the same Docker network using the host system's Docker socket.
31+
32+
To control LocalStack's behaviour adjust the provided `.env` file which will be loaded both into LocalStack and the created DevContainer after rebuild.
33+
For further customisation you can edit the provided `Dockerfile` and/or the `devcontainer.json` file.
34+
Or add additional services by modifying the provided `docker-compose.yml` file.
35+
For further LocalStack configuration options please consult our [official documentation](https://docs.localstack.cloud/references/configuration/).
36+
37+
The Template adds automatically the [official LocalStack DevContainer Feature](https://github.com/localstack/devcontainer-feature), which installs the CLI and by demand the most popular *Local Tools™*.
38+
Currently this calls for a **Debian-based** DevContainer image.
39+
40+
>[!WARNING]
41+
> In this Template version however the LocalStack CLI provides the `start` and `stop` options do not control the LocalStack container with them as that would result in name resolution issues with the container.
42+
>
43+
> In case you've made this mistake by accident, try running `docker compose -f <DEV_CONTAINER_CONFIG_LOCATION>/docker-compose.yml up -d localstack` or rebuild the container.
44+
45+
#### Use LocalStack Pro
46+
47+
Set `usePro: true` and set on your host system the `LOCALSTACK_AUTH_TOKEN` or the `LOCALSTACK_API_KEY` environment variable, this will be automatically picked up by the `.env` file.
48+
49+
---
50+
51+
_Note: This file was auto-generated from the [devcontainer-template.json](https://github.com/localstack/devcontainer-template/blob/main/src/localstack-dood/devcontainer-template.json). Add additional notes to a `NOTES.md`._

0 commit comments

Comments
 (0)