Skip to content

Commit

Permalink
Clean up README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Sheng Yang <[email protected]>
  • Loading branch information
yasker committed Jul 23, 2021
1 parent 714eb1c commit ec02674
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Latency in ns (Read/Write)
CPU Idleness: 72%
```

### Example Result of Comparsion Benchmark
### Example Result of Comparison Benchmark
```
================================
FIO Benchmark Comparsion Summary
Expand Down Expand Up @@ -92,7 +92,7 @@ Something is *wrong* when:
* For **Latency**, the **CPU Idleness** should be at least 40% to guarantee the test won't be impacted by CPU starving.
* If this happens, adding more CPUs to the node, or move to a beefer machine.

### Deploy the benchmark
### Deploy the FIO benchmark

#### Deploy Single Volume Benchmark in Kubernetes cluster

Expand Down Expand Up @@ -130,13 +130,13 @@ See [./deploy/fio.yaml](https://github.com/yasker/benchmark/blob/main/deploy/fio
wget https://raw.githubusercontent.com/yasker/benchmark/main/deploy/fio-cmp.yaml
```
1. Set the storage class for each volume you want to compare.
* By default, it's `local-path` vs `yasker`.
* You can install a storage provider for local storage like [Local Path Provisioner](https://github.com/rancher/local-path-provisioner) for this test if you're testing with Kubernetes.
* By default, it's `local-path` vs `longhorn`.
* You can install a storage provider for local storage like [Local Path Provisioner](https://github.com/rancher/local-path-provisioner) for this test if you're testing with Kubernetes.
1. Update the `FIRST_VOL_NAME` and `SECOND_VOL_NAME` fields in the yaml to the name you want to call them
* By default, it's also `Local-Path` vs `Longhorn`.
* By default, it's also `Local-Path` vs `Longhorn`.
1. Update the `SIZE` of PVCs and the benchmark configuration.
* By default, the size for comparison benchmark is **`30G`**.
* As mentioned above, for formal benchmark, the size should be **at least 25 times the read/write bandwidth** to avoid the caching impacting the result.
* By default, the size for comparison benchmark is **`30G`**.
* As mentioned above, for formal benchmark, the size should be **at least 25 times the read/write bandwidth** to avoid the caching impacting the result.
1. Deploy using
```
kubectl apply -f fio-cmp.yaml
Expand Down

0 comments on commit ec02674

Please sign in to comment.