Skip to content

Commit

Permalink
chore: Add docs on nightly benchmarking (#2755)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bownairo authored Nov 21, 2024
1 parent 76b7dfd commit 27e7499
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
8 changes: 8 additions & 0 deletions ic-os/dev-tools/bare_metal_deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,18 @@ bazel run //ic-os/setupos/envs/dev:launch_bare_metal --config=local -- \
--file_share_username <your username per infrasec> \
# --file_share_ssh_key <custom ssh private key> # Specify if a special ssh key is needed \
--config_path $(realpath ./ic-os/dev-tools/bare_metal_deployment/zh2-dll01.yaml) \
--inject_image_pub_key "XXX" # Optional SSH key for access to the node after deploying, required for benchmarking \
--csv_filename $(realpath ./zh2-dll01.csv)
```


### Performance Benchmarking

Once the desired image has been deployed to the node following the instructions above, benchmarking
can be started by passing the `--benchmark` flag to the original deployment command. Be sure to add
an SSH key when deploying for access to the node.


#### What's in the yaml configuration file?

```
Expand Down
16 changes: 16 additions & 0 deletions ic-os/guestos/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,19 @@ See instructions link:components/README.adoc#[here] on how to make changes to th

For further reading, see the docs in the
link:docs/README.adoc#[docs/ subdirectory]

== Performance Benchmarking

Performance benchmarks are run in GuestOS, on hardware, every day during the nightly
link:../../.github/workflows-source/schedule-daily.yml[`Bazel Test Bare Metal`] job.

This job runs commands from link:../dev-tools/bare_metal_deployment/benchmark_runner.sh[`benchmark_runner.sh`],
and expects that results are placed into the `results` folder on the node. All results are then
dumped into the logs of the CI job.

Currently, node metrics are not collected, but we hope to point the monitoring infrastructure at
this node to track performance changes over time.

These benchmarks can be run manually, following the benchmarking instructions
link:../dev-tools/bare_metal_deployment/README.md[here], but it is easiest to trigger the nightly
job via https://github.com/dfinity/ic/actions.

0 comments on commit 27e7499

Please sign in to comment.