Skip to content

Documenting Cluster Loader's additional functionality. #7297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2018
Merged

Documenting Cluster Loader's additional functionality. #7297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 40 additions & 4 deletions scaling_performance/using_cluster_loader.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,21 @@ end of the test.
|A sub-object with one or many definition(s). Under `projects`, each
namespace to create is defined and `projects` has several mandatory subheadings.

|`tuningSet`
|`tuningset`
|A sub-object with one definition per configuration. `TuningSet` allows the user
to define a tuning set to add configurable timing to project or object creation
(pods, templates, etc).

|`sync`
|An optional sub-object with one definition per configuration. Adds synchronization
possibilies during object creation.
|===

.Fields under `projects`
|===
|Field |Description

|`number`
|`num`
|An integer. One definition of the count of how many projects to create.

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

|`configmaps`
|A list of key-value pairs. Key is ConfigMap name, value is a path to a file to create
the ConfigMap from.

|`secrets`
|A list of key-value pairs. Key is Secret name, value is a path to a file to create
the Secret from.

|`pods`
|A sub-object with one or many definition(s) of pods to deploy.

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

|`number`
|`num`
|An integer. The number of pods or templates to deploy.

|`image`
Expand Down Expand Up @@ -181,9 +193,33 @@ defined in `stepsize`.
not successful.

|`delay`
|An integer. How many milliseconds (ms) to wait between creation requests
|An integer. How many milliseconds (ms) to wait between creation requests.
|===

.Fields under `sync`
|===
|Field |Description

|`server`
|A sub-object with `enabled` and `port` fields. Boolean `enabled` defines
whether to start a HTTP server for pod synchronization. Integer `port`
defines HTTP server port to listen on (9090 by default).

|`running`
|A boolean. Wait for pods with labels matching `selectors` to go into Running state?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why these are punctuated by ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like selectors? Yes, because I'm trying to refer to the selectors below. Could be phrased better I guess.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmencak Okay, thanks. I'm going to make some minor proposed edits in a follow-up PR and tag you in that for review.


|`succeeded`
|A boolean. Wait for pods with labels matching `selectors` to go into Completed state?

|`selectors`
|A list of selectors to match pods in Running/Completed states.

|`timeout`
|A string. Synchronization timeout to wait for pods in Running/Completed states. For non 0 values use
units: [ns\|us\|ms\|s\|m\|h].
|===


[[configuring-cluster-loader-configuration-file-example]]
=== Example Cluster Loader Configuration File

Expand Down