Skip to content

Commit

Permalink
Merge pull request #827 from Dasharo/dasharo-lab-user-guide
Browse files Browse the repository at this point in the history
docs/newcomers.md: Added Dasharo lab user guide and troubleshooting
  • Loading branch information
wiktormowinski authored Aug 6, 2024
2 parents 8d8557a + a7e51f7 commit 291bc3a
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions docs/newcomers.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,82 @@ quick answers it's best to join our matrix space and talk to us there.

If you've never used Matrix before, you will first need to get a client.
Available clients are listed [here](https://matrix.org/clients/).

## Dasharo lab user guide

[**Test environment overview**](https://github.com/Dasharo/open-source-firmware-validation?tab=readme-ov-file#test-environment-overview)

To get information about available platforms it's or it's RTE's IP address, use
the platform reservation tool: [SnipeIT](https://192.168.4.202/)

[OSFV_CLI](https://github.com/Dasharo/osfv-scripts/tree/main/osfv_cli) is a script,
which allows to interact with devices setup in Dasharo OSFV lab.

If the DUT has connected RTE you can refer to: [RTE
commands](https://github.com/Dasharo/osfv-scripts/blob/main/osfv_cli/README.md#rte-command),
also you may connect to the RTE by using web browser by typing:
`http://<rte_ip_address>:8000`. For more please refer to: [RTE Quick Start
Guide](https://docs.dasharo.com/transparent-validation/rte/v1.1.0/quick-start-guide/).

Default RTE login: `root`, password: `meta-rte`

If the DUT uses PiKVM you may use: `https://<PiKVM_ip_address>`, for more info
refer to:
[PiKVM](https://docs.dasharo.com/transparent-validation/pikvm/assembly-and-validation/).

Default PiKVM login: `admin`, password: `admin`

Firmware source: [Dasharo
Universe](https://docs.dasharo.com/variants/protectli_vp2410/releases/) or
[Cloud](https://cloud.3mdeb.com/index.php/apps/files/?dir=/projects/dasharo/releases&fileid=297139)
(only for logged in users), alternatively newest builds can be found at [Github](https://github.com/Dasharo/coreboot/).

Running tests: [Open Source Firmware Remote Test Environment](https://github.com/Dasharo/open-source-firmware-validation?tab=readme-ov-file#getting-started)
It is strongly suggested to run your first test on [QEMU](https://github.com/Dasharo/open-source-firmware-validation?tab=readme-ov-file#qemu-workflow).
To prepare Ubuntu OS image for QEMU refer to: [Ubuntu OS](https://github.com/Dasharo/preseeds?tab=readme-ov-file#ubuntu),
after downloading and creating image copy ```ubuntu.iso```
to ```.../open-source-firmware-validation/qemu-data/```
also create a drive onto which the os is going to be installed by running

```qemu-img create -f qcow2 qemu-data/hdd.qcow2 20G```

run QEMU with:

```./scripts/ci/qemu-run.sh graphic os_install```

To start QEMU so that it boots to os run:

```./scripts/ci/qemu-run.sh graphic os```

## Troubleshooting

**Connecting to RTE serial output: `Connection refused`**

Most probably a telnet connection hasn't been closed correctly. To terminate
this connection restart RTE by logging to it by ssh and reboot it:

`ssh root@rte_ip_address`

password: meta-rte

`systemctl restart ser2net` and then `logout`

**DUT won't power on**

1. Use the [OSFV CLI](https://github.com/Dasharo/osfv-scripts/tree/main/osfv_cli).
Check if Sonoff state is set to ON `osfv_cli sonoff --sonoff_ip
<sonoff_ip_address> on` and power on the DUT `osfv_cli rte --rte_ip
<rte_ip_address> pwr on`

2. Check if a proper BIOS/firmware is flashed. If not a proper firmware can be
flashed with use of [OSFV
CLI](https://github.com/Dasharo/osfv-scripts/tree/main/osfv_cli) by running
`osfv_cli rte --rte_ip <rte_ip_address> flash write --rom <path_to_fw_file>`
command.

**Ubuntu won't download and create image**

1. Download image from: [Ubuntu](https://ubuntu.task.gda.pl/ubuntu-releases/22.04.4/ubuntu-22.04.4-desktop-amd64.iso),
and use the script:

```./ubuntu/create_image.sh -i ~/Downloads/ubuntu-22.04.4-desktop-amd64.iso```

0 comments on commit 291bc3a

Please sign in to comment.