Skip to content

Commit 914f296

Browse files
authored
Merge pull request openshift#7310 from ahardin-rh/enterprise-3.9-stage
[enterprise-3.9] Documenting Cluster Loader's additional functionality.
2 parents 7db072b + 83d0456 commit 914f296

File tree

1 file changed

+40
-4
lines changed

1 file changed

+40
-4
lines changed

scaling_performance/using_cluster_loader.adoc

+40-4
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,21 @@ end of the test.
8585
|A sub-object with one or many definition(s). Under `projects`, each
8686
namespace to create is defined and `projects` has several mandatory subheadings.
8787

88-
|`tuningSet`
88+
|`tuningset`
8989
|A sub-object with one definition per configuration. `TuningSet` allows the user
9090
to define a tuning set to add configurable timing to project or object creation
9191
(pods, templates, etc).
92+
93+
|`sync`
94+
|An optional sub-object with one definition per configuration. Adds synchronization
95+
possibilies during object creation.
9296
|===
9397

9498
.Fields under `projects`
9599
|===
96100
|Field |Description
97101

98-
|`number`
102+
|`num`
99103
|An integer. One definition of the count of how many projects to create.
100104

101105
|`basename`
@@ -106,6 +110,14 @@ identical namespaces will be appended to `Basename` to prevent collisions.
106110
|A string. One definition of what tuning set you want to apply to the objects,
107111
which you deploy inside this namespace.
108112

113+
|`configmaps`
114+
|A list of key-value pairs. Key is ConfigMap name, value is a path to a file to create
115+
the ConfigMap from.
116+
117+
|`secrets`
118+
|A list of key-value pairs. Key is Secret name, value is a path to a file to create
119+
the Secret from.
120+
109121
|`pods`
110122
|A sub-object with one or many definition(s) of pods to deploy.
111123

@@ -120,7 +132,7 @@ which you deploy inside this namespace.
120132
|`total`
121133
|This field is not used.
122134

123-
|`number`
135+
|`num`
124136
|An integer. The number of pods or templates to deploy.
125137

126138
|`image`
@@ -181,9 +193,33 @@ defined in `stepsize`.
181193
not successful.
182194

183195
|`delay`
184-
|An integer. How many milliseconds (ms) to wait between creation requests
196+
|An integer. How many milliseconds (ms) to wait between creation requests.
197+
|===
198+
199+
.Fields under `sync`
200+
|===
201+
|Field |Description
202+
203+
|`server`
204+
|A sub-object with `enabled` and `port` fields. Boolean `enabled` defines
205+
whether to start a HTTP server for pod synchronization. Integer `port`
206+
defines HTTP server port to listen on (9090 by default).
207+
208+
|`running`
209+
|A boolean. Wait for pods with labels matching `selectors` to go into Running state?
210+
211+
|`succeeded`
212+
|A boolean. Wait for pods with labels matching `selectors` to go into Completed state?
213+
214+
|`selectors`
215+
|A list of selectors to match pods in Running/Completed states.
216+
217+
|`timeout`
218+
|A string. Synchronization timeout to wait for pods in Running/Completed states. For non 0 values use
219+
units: [ns\|us\|ms\|s\|m\|h].
185220
|===
186221

222+
187223
[[configuring-cluster-loader-configuration-file-example]]
188224
=== Example Cluster Loader Configuration File
189225

0 commit comments

Comments
 (0)