Skip to content

Commit efd7212

Browse files
DavidBuzatu-Marianustiugov
authored andcommitted
Moved important steps description and added titles to subpoints
Signed-off-by: davidbuzatu-marian <[email protected]>
1 parent 47ec30f commit efd7212

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

docs/quickstart_guide.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,7 @@ SSD-equipped nodes are highly recommended. Full list of CloudLab nodes can be fo
8383
mkdir -p /tmp/vhive-logs
8484
```
8585
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:**
9487
>
9588
> [eStargz](https://github.com/containerd/stargz-snapshotter/tree/cmd/v0.12.1) is a
9689
> 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
10598
> **IMPORTANT**
10699
> Currently `stargz` is only supported in native kubelet contexts without firecracker.
107100
> 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.
111112

112113

113114
### 2. Setup Worker Nodes
114115
**On each worker node**, execute the following instructions below **as a non-root user with sudo rights** using **bash**:
115116
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-
```
119117
> **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:
121119
> ```bash
122120
> ./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)
124126
2. Start `containerd` in a background terminal named `containerd`:
125127
```bash
126128
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
252254
> **IMPORTANT**
253255
> Currently `stargz` is only supported in native kubelet contexts without firecracker.
254256
> 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`.
258260
2. Start `containerd` in a background terminal named `containerd`:
259261
```bash
260262
sudo screen -dmS containerd containerd; sleep 5;

0 commit comments

Comments
 (0)