Bare Metal Images with bencher run
Bare Metal Runners execute benchmarks packaged in OCI Image Format.
When using the bencher run CLI subcommand,
specify an Image with the --image option to enable remote, bare metal execution.
When Continuous Benchmarking, that is benchmarking in CI, using bare metal runners can drastically reduce the amount of noise in your benchmark results. Further, Bencher Bare Metal can be run outside of CI using the exact same bare metal runners. This allows both developers and agents to check the performance of their code changes without having to go through an entire CI workflow. See the Bare Metal Workflow for a full overview.
--image <IMAGE>
Set the OCI image reference for remote Bare Metal Runner execution
(e.g. my-image:tag, registry.bencher.dev/my-image:tag,
or for Bencher Self-Hosted instances localhost:61016/my-image:tag).
Only the OCI registry for the Bencher API server is supported.
When --image is set, the benchmark command runs on a remote Bare Metal Runner
instead of locally.
🐰 Shared Bare Metal Runners do not have network access. That is, you cannot pull down any dependencies while executing your benchmarks. Your Image must be entirely self-contained.
--entrypoint <ENTRYPOINT>
Override the container entrypoint for executing the benchmark command.
This option requires the --image option to be set.
--env <KEY=VALUE>
Set environment variables in KEY=VALUE format.
May be specified multiple times.
This option requires the --image option to be set.
--job-timeout <SECONDS>
Request a maximum Job execution time in seconds. However, the following Job timeouts are always enforced with the provided concurrency limits:
| Tier | Job Timeout | Job Concurrency |
|---|---|---|
| Unclaimed | 1 minute | 1 per source IP |
| Free | 5 minutes | 1 per Organization |
| Team | Unlimited (default: 60 minutes) | Unlimited |
| Enterprise | Unlimited (default: 60 minutes) | Unlimited |
This option requires the --image option to be set.
--job-poll-interval <SECONDS>
Set the poll interval in seconds when waiting for Bare Metal Job completion.
This option requires the --image option to be set.
This option conflicts with the --detach option.
--detach
Detach after submitting the Bare Metal Job, without waiting for completion.
This option requires the --image option to be set.
This option conflicts with the --job-poll-interval option.
🐰 Congrats! You have learned all about Bare Metal Images! 🎉