Skip to content

README: add a short description of the architecture #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marten-seemann wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: add a short description of the architecture #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# quic-go Performance Dashboard

Infrastructure for running and publishing quic-go performance benchmarks. Builds runner images for AWS, GCP, and Azure that come preloaded with the quic-go and MsQuic perf binaries.
Infrastructure for running and publishing quic-go performance benchmarks.

The setup keeps runs repeatable by building AWS, GCP, and Azure runner images up front with [quic-go/perf](https://github.com/quic-go/perf) and [MsQuic](https://github.com/microsoft/msquic) installed. Each benchmark then creates short-lived server and client nodes from those images, runs the selected implementations, and destroys the nodes afterward.

## Workflows

- [`.github/workflows/packer.yml`](.github/workflows/packer.yml) builds new runner images on AWS, GCP and Azure.
- [`.github/workflows/benchmark.yml`](.github/workflows/benchmark.yml) creates temporary server and client nodes, runs the selected benchmark.
- [`.github/workflows/cleanup.yml`](.github/workflows/cleanup.yml) deletes old runner images and abandoned benchmark resources.

## Testing image builds from a Pull Request

Expand Down