Skip to content

Commit 5e328eb

Browse files
remotesynthremotesynth
committed
Containers folder done
1 parent 737de80 commit 5e328eb

File tree

6 files changed

+144
-81
lines changed

6 files changed

+144
-81
lines changed

‎src/content/docs/aws/integrations/containers/devcontainers.mdx‎

Lines changed: 48 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,12 @@ You can use the following two approaches to set up LocalStack with DevContainers
2020
## LocalStack Templates
2121

2222
LocalStack provides two different approaches for [Templates](https://github.com/localstack/devcontainer-template) which can be used via [supporting tools](https://containers.dev/supporting).
23-
{/* TODO: transform this into a proper table, deal with the breaks */}
24-
{/*
23+
2524
| **Type** | **Advantages** | **Disadvantages** |
2625
|------------------------------|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
27-
| **Docker-in-Docker** | • Strict separation from host Docker service<br>• Control LocalStack with LocalStack CLI<br>• All-in-one container | • Resources are limited as all resources spawned by LocalStack are encapsulated within the container<br>• LocalStack volume directory must exist beforehand<br>• Larger container size<br>• Cannot use existing images on host system |
28-
| **Docker-outside-of-Docker** | • Easy addition of external services managed by Docker Compose<br>• DNS service for custom domains | • Host's Docker socket mounted into containers, raising security concerns<br>• Limited LocalStack CLI usage<br>• LocalStack volume directory must exist beforehand |
29-
*/}
26+
| **Docker-in-Docker** | • Strict separation from host Docker service<br />• Control LocalStack with LocalStack CLI<br />• All-in-one container | • Resources are limited as all resources spawned by LocalStack are encapsulated within the container<br />• LocalStack volume directory must exist beforehand<br />• Larger container size<br />• Cannot use existing images on host system |
27+
| **Docker-outside-of-Docker** | • Easy addition of external services managed by Docker Compose<br />• DNS service for custom domains | • Host's Docker socket mounted into containers, raising security concerns<br />• Limited LocalStack CLI usage<br />• LocalStack volume directory must exist beforehand |
28+
3029
### Docker-in-Docker
3130

3231
* [Dev Container CLI](#dev-container-cli)
@@ -92,7 +91,6 @@ done
9291
#### VSCode
9392

9493
:::note
95-
9694
The DevContainer extension is currently reporting issues & bugs.
9795
Follow the [issue](https://github.com/microsoft/vscode-remote-release/issues/10180) for details.
9896
:::
@@ -101,64 +99,57 @@ To get started with LocalStack and DevContainers in VS Code, follow these steps:
10199

102100
* Open VS Code with the DevContainers extension installed.
103101
* From the Command Palette, select **Dev Containers: Add Dev Container configuration file**.
104-
<br></br>
102+
105103
![Add Dev Container configuration file](public/images/aws/01_add_devcontainer_conf.png)
106-
<br></br>
107104

108105
* Choose **Add configuration to workspace**; alternatively, select **Add configuration to user data folder** for general usage.
109-
<br></br>
106+
110107
![Add configuration to workspace](public/images/aws/02_add_conf_workspace.png)
111-
<br></br>
112108

113109
* Select **Show All Definitions...** to view community templates.
114-
<br></br>
110+
115111
![Show all Template definitions](public/images/aws/03_show_all_definitions.png)
116-
<br></br>
117112

118113
* Filter by typing "localstack" in the search bar and select the **LocalStack Docker-in-Docker** template.
119-
<br></br>
114+
120115
[Select official LocalStack Template (DinD)](public/images/aws/04a_select_template_dind.png)
121-
<br></br>
122116

123117
* Proceed through the configuration by selecting or entering values.
124118
Pressing **Enter** through the options will apply default settings, which include:
125-
<br></br>
119+
126120
* Select the image variant (only Debian-based images are supported).
127121
![Image variant option](public/images/aws/05_option_1.png)
128122
* Select the log level.
129-
<br></br>
130-
![Log level option] (public/images/aws/06_option_2.png)
131-
<br></br>
123+
124+
![Log level option](public/images/aws/06_option_2.png)
125+
132126
* Select the LocalStack version.
133-
<br></br>
134127
![LocalStack version option](public/images/aws/07_option_3.png)
135-
<br></br>
136128

137129
* Relative paths are acceptable for the volume path, but the specified mount folder must be created prior to building the container.
138-
<br></br>
139-
![Volume path option](public/images/aws/08_volume_option.png)
140-
<br></br>
141-
![Volume folder exists](public/images/aws/09_volume_folder.png)
130+
131+
![Volume path option](public/images/aws/08_volume_option.png)
132+
133+
![Volume folder exists](public/images/aws/09_volume_folder.png)
142134

143135
* Select various tools and configuration options from the checklist.
144136
For local tools, either select the appropriate SDK or tool feature, or install it manually.
145137
The template and LocalStack CLI feature do not manage these installations.
146-
<br></br>
147-
![List of options (DinD)](public/images/aws/10a_options_list_dind.png)
148138

149-
* You can also add additional features.
150-
<br></br>
151-
![Additional Features](public/images/aws/11_additional_features.png)
139+
![List of options (DinD)](public/images/aws/10a_options_list_dind.png)
140+
141+
* You can also add additional features.
142+
143+
![Additional Features](public/images/aws/11_additional_features.png)
152144

153145
* This results in the following folder structure in your workspace.
154-
<br></br>
155-
![Generated folder structure (DinD)](public/images/aws/12a_folder_structure_dind.png)
146+
![Generated folder structure (DinD)](public/images/aws/12a_folder_structure_dind.png)
156147

157148
#### Reference file
158149

159150
The `devcontainer.json` will look similar to the following:
160151

161-
```json
152+
```json showLineNumbers
162153
{
163154
"name": "LocalStack DinD setup",
164155
"image": "mcr.microsoft.com/devcontainers/base:bullseye",
@@ -281,7 +272,6 @@ docker compose \
281272
#### VSCode
282273

283274
:::note
284-
285275
The DevContainer extension is currently reporting issues & bugs.
286276
Follow the [issue](https://github.com/microsoft/vscode-remote-release/issues/10180) for details.
287277
:::
@@ -290,70 +280,58 @@ To get started with LocalStack and DevContainers in VS Code, follow these steps:
290280

291281
* Open VSCode with the DevContainers extension installed.
292282
* From the Command Palette, choose **Dev Containers: Add Dev Container configuration file**.
293-
<br></br>
294-
![Add Dev Container configuration file](public/images/aws/01_add_devcontainer_conf.png)
295-
<br></br>
283+
284+
![Add Dev Container configuration file](public/images/aws/01_add_devcontainer_conf.png)
296285

297286
* Choose the **Add configuration to workspace** option; alternatively, select **Add configuration to user data folder** for general usage.
298-
<br></br>
299-
![Add configuration to workspace](public/images/aws/02_add_conf_workspace.png)
300-
<br></br>
287+
288+
![Add configuration to workspace](public/images/aws/02_add_conf_workspace.png)
301289

302290
* Select **Show All Definitions...** to view community templates.
303-
<br></br>
304-
![Show all Template definitions](public/images/aws/03_show_all_definitions.png)
305-
<br></br>
291+
292+
![Show all Template definitions](public/images/aws/03_show_all_definitions.png)
306293

307294
* Start typing "localstack" in the search bar to filter the official LocalStack templates and choose **LocalStack Docker-outside-of-Docker**.
308-
<br></br>
309-
![Select official LocalStack Template (DooD)](public/images/aws/04b_select_template_dood.png)
310-
<br></br>
295+
![Select official LocalStack Template (DooD)](public/images/aws/04b_select_template_dood.png)
311296

312297
* Navigate through the configuration inputs by either selecting or typing in values.
313298
The defaults provided in the template are sufficient; navigating through the options by hitting Enter will result in a valid configuration.
314299
These options include:
315-
<br></br>
300+
316301
* The image variant (currently only Debian-based images are supported).
317-
<br></br>
318-
![Image variant option](public/images/aws/05_option_1.png)
319-
<br></br>
302+
303+
![Image variant option](public/images/aws/05_option_1.png)
304+
320305
* The log level.
321-
<br></br>
322-
![Log level option](public/images/aws/06_option_2.png)
323-
<br></br>
306+
307+
![Log level option](public/images/aws/06_option_2.png)
308+
324309
* The LocalStack version.
325-
<br></br>
326-
![LocalStack version option](public/images/aws/07_option_3.png)
327-
<br></br>
310+
311+
![LocalStack version option](public/images/aws/07_option_3.png)
328312

329313
* Note that LocalStack's IP address must be within the defined CIDR range.
330314
The network CIDR defaults to `10.0.2.0/24`, with the container IP set to `10.0.2.20`.
331-
<br></br>
332315

333316
* For the volume path, relative paths are accepted, but you must create the specified mount's folder before successfully building the container.
334317
The default is `./.volume`.
335-
<br></br>
336-
![Volume path option](public/images/aws/08_volume_option.png)
337-
<br></br>
338-
![Volume folder exists](public/images/aws/09_volume_folder.png)
339-
<br></br>
318+
319+
![Volume path option](public/images/aws/08_volume_option.png)
320+
321+
![Volume folder exists](public/images/aws/09_volume_folder.png)
340322

341323
* Select multiple tools and configuration options from the checklist.
342324
For local tools, you must select the appropriate SDK or tool feature, or install it manually.
343325
The template and the underlying LocalStack CLI Feature do not manage these installations.
344-
<br></br>
345-
![List of options (DooD)](public/images/aws/10b_options_list_dood.png)
346-
<br></br>
326+
327+
![List of options (DooD)](public/images/aws/10b_options_list_dood.png)
347328

348329
* You can also add additional features.
349-
<br></br>
350-
![Additional Features](public/images/aws/11_additional_features.png)
351-
<br></br>
330+
331+
![Additional Features](public/images/aws/11_additional_features.png)
352332

353333
* As a result, you will end up with the folder structure shown below.
354-
<br></br>
355-
![Folder structure (DooD)](public/images/aws/12b_folder_structure_dood.png)
356-
<br></br>
334+
![Folder structure (DooD)](public/images/aws/12b_folder_structure_dood.png)
357335

358336
###### Reference files
359337

@@ -471,7 +449,6 @@ That's it.
471449
By building your container the LocalStack CLI and any of the enabled local-tools (currently these are `awslocal`, `cdklocal`, `pulumilocal`, `samlocal` and `tflocal`) will be installed.
472450

473451
:::note
474-
475452
The LocalStack Feature does not manage the installation of underlying tools (e.g., for awslocal, aws-cli is not installed).
476453
For more information on dependencies, please refer to the [Feature documentation](https://github.com/localstack/devcontainer-feature).
477454
:::

‎src/content/docs/aws/integrations/containers/eksctl.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ Run the following command to create a cluster:
4141

4242
{/* TODO: change labels so they are formatted like **<text>** in markdown */}
4343
<Tabs>
44-
<TabItem label="**Older Versions (<= eksctl v0.180.0)**">
44+
<TabItem label="Older Versions (<= eksctl v0.180.0)">
4545
```bash
4646
eksctl create cluster --nodes 1 --profile localstack
4747
```
4848
</TabItem>
49-
<TabItem label="**Newer Versions (>= eksctl v0.181.0)**">
49+
<TabItem label="Newer Versions (>= eksctl v0.181.0)">
5050
```bash
5151
export AWS_CLOUDFORMATION_ENDPOINT=http://localhost.localstack.cloud:4566
5252
export AWS_EC2_ENDPOINT=http://localhost.localstack.cloud:4566

src/content/docs/aws/integrations/containers/gitpod.mdx renamed to src/content/docs/aws/integrations/containers/gitpod.md

File renamed without changes.

0 commit comments

Comments
 (0)