doc: add benchmarking section in contribution page (#3709)

* add benchmark report to doc site Signed-off-by: shawnh2 <[email protected]> * update benchmark run in contribution page Signed-off-by: shawnh2 <[email protected]> * rename benchmark report Signed-off-by: shawnh2 <[email protected]> --------- Signed-off-by: shawnh2 <[email protected]>
envoyproxy · Jul 3, 2024 · 979f949 · 979f949
1 parent 612808c
commit 979f949
Show file tree

Hide file tree

Showing 2 changed files with 704 additions and 608 deletions.
diff --git a/site/content/en/contributions/DEVELOP.md b/site/content/en/contributions/DEVELOP.md
@@ -145,6 +145,34 @@ verify signature was copied to [JWK Creator][] for generating the JWK. The JWK C
 settings, i.e. `Signing` public key use and the `RS256` algorithm. The generated JWK was wrapped in a JWKS structure
 and is hosted in the repo.
 
+### Benchmarking
+
+Envoy Gateway uses [nighthawk][nighthawk] for benchmarking, and mainly concerned with
+its performance and scalability as a control-plane.
+
+The performance and scalability concerns come from several aspects for control-plane:
+
+- The consumption of memory and CPU.
+- The rate of configuration changes.
+
+The benchmark test is running on [Kind][Kind] cluster, you can run the following command
+to start a Kind cluster and run benchmark test on it.
+
+```shell
+make benchmark-test
+```
+
+By default, a benchmark report will be generated under `test/benchmark` after test finished.
+
+#### Brief benchmark report
+
+You can browse the detailed benchmark report in `test/benchmark/benchmark-report.md`.
+
+Here are some brief benchmark reports about Envoy Gateway: 
+
+- It will take up nearly 1.3GiB memory and 11s total CPU time for (1 GatewayClass + 1 Gateway + 500 HTTRoutes) settings
+
+
 [Quickstart]: https://github.com/envoyproxy/gateway/blob/main/docs/latest/user/quickstart.md
 [make]: https://www.gnu.org/software/make/
 [Github Actions]: https://docs.github.com/en/actions
@@ -161,3 +189,4 @@ and is hosted in the repo.
 [request authentication]: ../latest/tasks/security/jwt-authentication
 [JWT Debugger]: https://jwt.io/
 [JWK Creator]: https://russelldavies.github.io/jwk-creator/
+[nighthawk]: https://github.com/envoyproxy/nighthawk