Skip to content

Commit

Permalink
Document challenge's user-info property (#1358)
Browse files Browse the repository at this point in the history
With this commit we document the existing property `user-info` on the
challenge object.

Relates elastic/rally-tracks#200
  • Loading branch information
danielmitterdorfer authored Oct 12, 2021
1 parent 70d955e commit e678ce5
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/track.rst
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ Each challenge consists of the following properties:

* ``name`` (mandatory): A descriptive name of the challenge. Should not contain spaces in order to simplify handling on the command line for users.
* ``description`` (optional): A human readable description of the challenge.
* ``user-info`` (optional): A message that is printed at the beginning of a race. It is intended to be used to notify e.g. about deprecations.
* ``default`` (optional): If true, Rally selects this challenge by default if the user did not specify a challenge on the command line. If your track only defines one challenge, it is implicitly selected as default, otherwise you need to define ``"default": true`` on exactly one challenge.
* ``schedule`` (mandatory): Defines the workload. It is described in more detail below.

Expand Down

0 comments on commit e678ce5

Please sign in to comment.