kubernetes
/
minikube
mirror of https://github.com/kubernetes/minikube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add README for mkcmp

pull/10641/head
Priya Wadhwa 2021-02-26 13:00:19 -08:00
parent 91129332a3
commit fd506460b3
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
cmd/performance/mkcmp/cmd/README.md Normal file
View File

@ -0,0 +1,22 @@
# mkcmp
mkcmp (“minikube compare”) is a binary to compare the performance of two minikbue binaries.
It takes in two minikube binaries, runs `minikube start` 3 times with each, and then outputs a comparison table in Markdown.
mkcmp takes in references to minikube binaries in two ways:
1. Direct path to a minikube binary
1. Reference to a PR number via `pr://<PR number>`, which will use the binary built at that PR
Sample usage:
```shell
make out/mkcmp
# Compare local minikube binary with binary built at PR 400
./out/mkcmp ./out/minikube pr://400
```
mkcmp is primarily used for our prbot, which comments mkcmp output on valid PRs [example](https://github.com/kubernetes/minikube/pull/10430#issuecomment-776311409).
To make changes to the prbot output, submitting a PR to change mkcmp code should be sufficient.
Note: STDOUT from mkcmp is *exactly* what is commented on github, so we want it to be in Markdown.