Update cocos documentation (#89)

* Update cocos documentation

Signed-off-by: fbugarski <filipbugarski@gmail.com>

* inserted go run commands into separate lines

* updated syntax higlighting to bash

---------

Signed-off-by: fbugarski <filipbugarski@gmail.com>
Co-authored-by: Danko Miladinovic <danko@etf.rs>
This commit is contained in:
Filip Bugarski
2024-04-13 18:33:10 +02:00
committed by GitHub
parent 5c406743e0
commit 35c2a9e92a
2 changed files with 20 additions and 2 deletions
+1
View File
@@ -9,6 +9,7 @@ git clone git@github.com:ultravioletrs/cocos.git
git clone git@github.com:buildroot/buildroot.git
cd buildroot
make BR2_EXTERNAL=../cocos/hal/linux cocos_defconfig
# Execute 'make menuconfig' only if you want to make additional configuration changes to Buildroot.
make menuconfig
make
```
+19 -2
View File
@@ -44,8 +44,13 @@ sudo apt install qemu-kvm
Create `img` directory in `cmd/manager`. Create `tmp` directory in `cmd/manager`.
#### Add Vsock
The necessary kernel modules must be loaded on the hypervisor. To check if `vhost_vsock` is loaded run:
```shell
lsmod | grep vhost_vsock
```
If `vhost_vsock` is not loaded run the following commands:
The necessary kernel modules must be loaded on the hypervisor.
```shell
sudo modprobe vhost_vsock
ls -l /dev/vhost-vsock
@@ -198,7 +203,19 @@ MANAGER_QEMU_KERNEL_HASH=true \
### Verifying VM launch
NB: To verify that the manager successfully launched the VM, you need to open two terminals on the same machine. In one terminal, you need to launch `go run main.go` (with the environment variables of choice) and in the other, you can run the verification commands.
NB: To verify that the manager successfully launched the VM, you need to open three terminals on the same machine. In one terminal, you need to launch the Manager test server by executing (with the environment variables of choice):
```bash
go run ./test/manager-server/main.go
```
and in the second the manager by executing (with the environment variables of choice):
```bash
go run ./cmd/manager/main.go
```
Ensure that the Manager can connect to the Manager test server by setting the MANAGER_GRPC_PORT with the port value of the Manager test server. The Manager test server is listening on the default value of the MANAGER_GRPC_PORT. In the last one, you can run the verification commands.
To verify that the manager launched the VM successfully, run the following command: