Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update quickstart docs #12

Merged
merged 10 commits into from
Oct 31, 2024
23 changes: 17 additions & 6 deletions docs/development/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,33 @@

## Starting a local zos node

* Make sure `qemu` and `dnsmasq` are installed
* [Create a farm](https://manual.grid.tf/farmers/3node_building/1_create_farm.html)
* [Download a zos image](https://bootstrap.grid.tf/kernel/zero-os-development-zos-v3-generic-7e587e499a.efi)
* Make sure `qemu` is installed
* [Create a farm](https://manual.grid.tf/documentation/farmers/3node_building/1_create_farm.html#create-a-farm)
* [Download a zos image](https://bootstrap.grid.tf/kernel/zero-os-development-zos-v3-generic-7e587e499a.efi) (Optional)
* Make sure `zos0` bridge is allowed by qemu, you can add `allow zos0` in `/etc/qemu/bridge.conf` (create the file if it's not there)
* Setup the network using this script [this script](../../qemu/net.sh)
* Setup the network using this script [this script](../../qemu/net.sh) Or you can `cd qemu` then run `make net`

Then, inside zos repository

```
make -C cmds
cd qemu
```
If you downloaded your zos image move it here
```
mv <downloaded image path> ./zos.efi
sudo ./vm.sh -n node-01 -c "farmer_id=<your farm id here> printk.devmsg=on runmode=dev"
```
Or you can run this commands
```
make prepare
mv dev.efi zos.efi
```

```
make run id=<your_farm_id> user=<your_github_username>
```

You should see the qemu console and boot logs, wait for awhile and you can [browse farms](https://dashboard.dev.grid.tf/explorer/farms) to see your node is added/detected automatically.
You should see the qemu console and boot logs, wait for awhile and you can [browse your farms](https://dashboard.dev.grid.tf/#/farms/your-farms/) to see your node is added/detected automatically.

To stop the machine you can do `Control + a` then `x`.

Expand Down
Loading