Skip to content

Commit b096769

Browse files
committed
[doc] scheduler_perf: describe suite configuration in more detail
The configuration file was design as a yaml file on purpose. To easily extend the test cases without a need to modify the testing binary. Also, it's possible to extend the configuration itself to enrich individual test cases.
1 parent e6c4ac3 commit b096769

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

test/integration/scheduler_perf/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,26 @@ To produce a cpu profile:
6868
make test-integration WHAT=./test/integration/scheduler_perf KUBE_TIMEOUT="-timeout=3600s" KUBE_TEST_VMODULE="''" KUBE_TEST_ARGS="-alsologtostderr=false -logtostderr=false -run=^$$ -benchtime=1ns -bench=BenchmarkPerfScheduling -cpuprofile ~/cpu-profile.out"
6969
```
7070

71+
### How to configure bechmark tests
72+
73+
Configuration file located under config/performance-config.yaml contains a list of templates.
74+
Each template allows to set:
75+
- node manifest
76+
- manifests for initial and testing pod
77+
- number of nodes, number of initial and testing pods
78+
- templates for PVs and PVCs
79+
- feature gates
80+
81+
See `simpleTestCases` data type implementation for available configuration for each template.
82+
83+
Initial pods create a state of a cluster before the scheduler performance measurement can begin.
84+
Testing pods are then subject to performance measurement.
85+
86+
The configuration file under config/performance-config.yaml contains a default list of templates to cover
87+
various scenarios. In case you want to add your own, you can extend the list with new templates.
88+
It's also possible to extend `simpleTestCases` data type, respectively its underlying data types
89+
to extend configuration of possible test cases.
90+
7191
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
7292
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/test/component/scheduler/perf/README.md?pixel)]()
7393
<!-- END MUNGE: GENERATED_ANALYTICS -->

0 commit comments

Comments
 (0)