You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart_guide.md
+21-19Lines changed: 21 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,14 +83,7 @@ SSD-equipped nodes are highly recommended. Full list of CloudLab nodes can be fo
83
83
mkdir -p /tmp/vhive-logs
84
84
```
85
85
3. Run the node setup script:
86
-
```bash
87
-
./scripts/cloudlab/setup_node.sh >>(tee -a /tmp/vhive-logs/setup_node.stdout)2>>(tee -a /tmp/vhive-logs/setup_node.stderr >&2)
88
-
```
89
-
>**BEWARE:**
90
-
>
91
-
> This script can print `Command failed` when creating the devmapper at the end. This can be safely ignored.
92
-
93
-
>**Note:**
86
+
>**Note - stargz deployments:**
94
87
>
95
88
> [eStargz](https://github.com/containerd/stargz-snapshotter/tree/cmd/v0.12.1) is a
96
89
> lazily-pullable image format developed to improve the performance of container boot-ups by
@@ -105,22 +98,31 @@ SSD-equipped nodes are highly recommended. Full list of CloudLab nodes can be fo
105
98
>**IMPORTANT**
106
99
> Currently `stargz` is only supported in native kubelet contexts without firecracker.
107
100
> Therefore, the following steps from this guide must **not** be executed:
108
-
>*`2.3`,
109
-
>*`2.4`,
110
-
>*`2.5`.
101
+
>*`2.3 - Start firecracker-containerd in a background terminal named firecracker`,
102
+
>*`2.4 - Build vHive host orchestrator`,
103
+
>*`2.5 - Start vHive in a background terminal named vhive`.
104
+
105
+
For the standard setup, run the following script:
106
+
```bash
107
+
./scripts/cloudlab/setup_node.sh >>(tee -a /tmp/vhive-logs/setup_node.stdout)2>>(tee -a /tmp/vhive-logs/setup_node.stderr >&2)
108
+
```
109
+
>**BEWARE:**
110
+
>
111
+
> This script can print `Command failed` when creating the devmapper at the end. This can be safely ignored.
111
112
112
113
113
114
### 2. Setup Worker Nodes
114
115
**On each worker node**, execute the following instructions below **as a non-root user with sudo rights** using **bash**:
115
116
1. Run the script that setups kubelet:
116
-
```bash
117
-
./scripts/cluster/setup_worker_kubelet.sh >>(tee -a /tmp/vhive-logs/setup_worker_kubelet.stdout)2>>(tee -a /tmp/vhive-logs/setup_worker_kubelet.stderr >&2)
118
-
```
119
117
>**IMPORTANT:**
120
-
> If step `1.3` was executed with the `stock-only` flag, execute the following instead:
118
+
> If step `1.4 - Run the node setup script` was executed with the `stock-only` flag, execute the following instead:
121
119
>```bash
122
120
> ./scripts/cluster/setup_worker_kubelet.sh stock-only >>(tee -a /tmp/vhive-logs/setup_worker_kubelet.stdout)2>>(tee -a /tmp/vhive-logs/setup_worker_kubelet.stderr >&2)
123
-
>```
121
+
>
122
+
123
+
For the standard kubelet setup, run the following script:
124
+
```bash
125
+
./scripts/cluster/setup_worker_kubelet.sh >>(tee -a /tmp/vhive-logs/setup_worker_kubelet.stdout)2>>(tee -a /tmp/vhive-logs/setup_worker_kubelet.stderr >&2)
124
126
2. Start `containerd`in a background terminal named `containerd`:
125
127
```bash
126
128
sudo screen -dmS containerd bash -c "containerd > >(tee -a /tmp/vhive-logs/containerd.stdout) 2> >(tee -a /tmp/vhive-logs/containerd.stderr >&2)"
@@ -252,9 +254,9 @@ Execute the following below **as a non-root user with sudo rights** using **bash
252
254
> **IMPORTANT**
253
255
> Currently `stargz` is only supported in native kubelet contexts without firecracker.
254
256
> Therefore, the following steps from this guide must **not** be executed:
255
-
> * `2.3`,
256
-
> * `2.4`,
257
-
> * `2.5`.
257
+
> * `2.3 - Start firecracker-containerd in a background terminal named firecracker`,
258
+
> * `2.4 - Build vHive host orchestrator`,
259
+
> * `2.5 - Start vHive in a background terminal named vhive`.
258
260
2. Start `containerd` in a background terminal named `containerd`:
0 commit comments