Skip to content

Commit a7ad862

Browse files
keivenchangJason Zhou
authored andcommitted
docs: add mermaid graph to .devcontainer/README.md, remove mount (revert). (#2632)
Co-authored-by: Keiven Chang <keivenchang@users.noreply.github.com> Signed-off-by: Jason Zhou <jasonzho@jasonzho-mlt.client.nvidia.com>
1 parent fe7373c commit a7ad862

File tree

3 files changed

+54
-8
lines changed

3 files changed

+54
-8
lines changed

.devcontainer/README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,56 @@ limitations under the License.
1919

2020
> Warning: Dev Containers (aka `devcontainers`) is an evolving feature and we are not testing in CI. Please submit any problem/feedback using the issues on GitHub.
2121
22+
```mermaid
23+
graph TB
24+
subgraph "Developer Laptop"
25+
subgraph IDE["Cursor/VS Code"]
26+
EXT["Dev Container Extension"]
27+
SSHEXT["Remote-SSH Extension"]
28+
end
29+
TERM["iTerm/Terminal"]
30+
end
31+
32+
subgraph WS["Linux Workstation"]
33+
DIR["~/dynamo<br/>(host directory)"]
34+
HFCACHE["~/.cache/huggingface<br/>(host cache)"]
35+
GITCONFIG["~/.gitconfig<br/>(host git config)"]
36+
37+
subgraph CONTAINER["Docker Container<br/>vsc-dynamo-SHA-uid<br/>Running as: ubuntu user"]
38+
MOUNT["/home/ubuntu/dynamo<br/>(mounted directory)"]
39+
HFMOUNT["/home/ubuntu/.cache/huggingface<br/>(mounted cache)"]
40+
GITCONFIGCOPY["/home/ubuntu/.gitconfig<br/>(via Dev Container setting)"]
41+
TOOLS["rust-analyzer<br/>cargo<br/>etc."]
42+
end
43+
44+
IMAGE["Docker Image<br/>dynamo:latest-vllm-local-dev"]
45+
46+
IMAGE -->|"docker run<br/>as ubuntu user"| CONTAINER
47+
end
48+
49+
TERM -->|"SSH Connection"| DIR
50+
SSHEXT -->|"1. Remote-SSH"| DIR
51+
EXT -->|"2. Dev Container:<br/>Open Folder (via ssh)"| IMAGE
52+
EXT -->|"3. IDE/shell via<br/>ssh+docker exec"| CONTAINER
53+
DIR <-.->|"Volume Mount<br/>(bidirectional)"| MOUNT
54+
HFCACHE <-.->|"Volume Mount<br/>(HF cache)"| HFMOUNT
55+
GITCONFIG -->|"Copy"| GITCONFIGCOPY
56+
57+
style IDE fill:#e1f5fe
58+
style EXT fill:#cfe2ff
59+
style SSHEXT fill:#cfe2ff
60+
style TERM fill:#e1f5fe
61+
style DIR fill:#fff3e0
62+
style HFCACHE fill:#fff3e0
63+
style GITCONFIG fill:#fff3e0
64+
style IMAGE fill:#f3e5f5
65+
style CONTAINER fill:#d4edda
66+
style MOUNT fill:#fff9c4
67+
style HFMOUNT fill:#fff9c4
68+
style GITCONFIGCOPY fill:#fff9c4
69+
style TOOLS fill:#ffebee
70+
```
71+
2272
## Prerequisites
2373

2474
Before you begin, ensure you have the following installed:
@@ -42,7 +92,7 @@ Follow these steps to get your NVIDIA Dynamo development environment up and runn
4292
### Step 1: Build the Development Container Image
4393

4494
Build `dynamo:latest-vllm-local-dev` from scratch from the source:
45-
- Note that currently, `local-dev` are only implemented for `--framework VLLM` and `--framework SGLANG`, for now.
95+
- Note that currently, `local-dev` is only implemented.
4696

4797
```bash
4898
./container/build.sh --target local-dev

.devcontainer/devcontainer.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@
7777
"source=dynamo-bashhistory,target=/home/ubuntu/.commandhistory,type=volume",
7878
"source=dynamo-precommit-cache,target=/home/ubuntu/.cache/pre-commit,type=volume",
7979
// Default mounts
80-
"source=/tmp/,target=/tmp/,type=bind",
81-
"source=${localEnv:HOME}/.cache/huggingface,target=/home/ubuntu/.cache/huggingface,type=bind"
80+
"source=/tmp/,target=/tmp/,type=bind"
81+
// Uncomment this to reuse your Hugging Face cache
82+
//"source=${localEnv:HOME}/.cache/huggingface,target=/home/ubuntu/.cache/huggingface,type=bind"
8283
]
8384
}

.devcontainer/post-create.sh

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,6 @@ retry() {
4242

4343
set -x
4444

45-
# Changing permission to match local user since volume mounts default to root ownership
46-
# Note: sudo is used here because the volume mount may have root ownership
47-
mkdir -p $HOME/.cache
48-
sudo chown -R ubuntu:ubuntu $HOME/.cache $HOME/dynamo
49-
5045
# Pre-commit hooks
5146
cd $HOME/dynamo && pre-commit install && retry pre-commit install-hooks
5247
pre-commit run --all-files || true # don't fail the build if pre-commit hooks fail

0 commit comments

Comments
 (0)