diff --git a/ic-os/dev-tools/bare_metal_deployment/README.md b/ic-os/dev-tools/bare_metal_deployment/README.md index e525b1ce01a..1b1e67b227b 100644 --- a/ic-os/dev-tools/bare_metal_deployment/README.md +++ b/ic-os/dev-tools/bare_metal_deployment/README.md @@ -31,10 +31,18 @@ bazel run //ic-os/setupos/envs/dev:launch_bare_metal --config=local -- \ --file_share_username \ # --file_share_ssh_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? ``` diff --git a/ic-os/guestos/README.adoc b/ic-os/guestos/README.adoc index 320e6fed478..e88f46e13fa 100644 --- a/ic-os/guestos/README.adoc +++ b/ic-os/guestos/README.adoc @@ -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.