Skip to content

Commit f2b78ae

Browse files
pRizznyannyacha
authored andcommitted
docs: recommend increasing Dev Container memory allocation (#495)
1 parent 252dc0a commit f2b78ae

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

DEVELOPERS.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,16 @@ This repository uses Dev Container for a unifying local development environment.
7272
- Dev Container requires [VS Code](https://code.visualstudio.com/download) and
7373
[Docker](https://www.docker.com/get-started/) to be pre-installed to use it.
7474

75-
- Install the
75+
- It is recommended to increase the maximum memory allocated to the Dev
76+
Container to at least 24GB, otherwise you may run into spurious errors while
77+
compiling. This can be configured via the Docker CLI or the Docker Desktop at
78+
`Settings -> Resources -> Advanced -> Memory`.
79+
80+
* Install the
7681
[Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
7782
to VS Code.
7883

79-
- Open the command palette, and select
84+
* Open the command palette, and select
8085
`Dev Containers: Open Folder in Container...`
8186

8287
![figure-vscode](assets/dev-container-vscode.gif)
@@ -113,10 +118,10 @@ After running the script, `k6` should run normally as shown below.
113118
```sh
114119
vscode ➜ /workspaces/edge-runtime/k6/scripts $ k6 --help
115120

116-
/\ |‾‾| /‾‾/ /‾‾/
117-
/\ / \ | |/ / / /
118-
/ \/ \ | ( / ‾‾\
119-
/ \ | |\ \ | (‾) |
121+
/\ |‾‾| /‾‾/ /‾‾/
122+
/\ / \ | |/ / / /
123+
/ \/ \ | ( / ‾‾\
124+
/ \ | |\ \ | (‾) |
120125
/ __________ \ |__| \__\ \_____/ .io
121126

122127
Usage:
@@ -138,7 +143,7 @@ Once you've confirmed that k6 is run properly, you can proceed to load testing.
138143
vscode ➜ /workspaces/edge-runtime $ pwd
139144
/workspaces/edge-runtime
140145
141-
vscode ➜ /workspaces/edge-runtime $ cat ./scripts/run.sh
146+
vscode ➜ /workspaces/edge-runtime $ cat ./scripts/run.sh
142147
#!/usr/bin/env bash
143148
144149
GIT_V_TAG=0.1.1 cargo build && EDGE_RUNTIME_PORT=9998 RUST_BACKTRACE=full ./target/debug/edge-runtime "$@" start --main-service ./examples/main --event-worker ./examples/event-manager
@@ -157,10 +162,10 @@ Once you've confirmed that k6 is run properly, you can proceed to load testing.
157162
```sh
158163
vscode ➜ /workspaces/edge-runtime $ k6 run ./k6/dist/specs/simple.js
159164
160-
/\ |‾‾| /‾‾/ /‾‾/
161-
/\ / \ | |/ / / /
162-
/ \/ \ | ( / ‾‾\
163-
/ \ | |\ \ | (‾) |
165+
/\ |‾‾| /‾‾/ /‾‾/
166+
/\ / \ | |/ / / /
167+
/ \/ \ | ( / ‾‾\
168+
/ \ | |\ \ | (‾) |
164169
/ __________ \ |__| \__\ \_____/ .io
165170
166171
execution: local

0 commit comments

Comments
 (0)