Config schema fields introduced for parameters' descriptions

All of the following fields are optional.

description

string, a (not necessary) short description of what this parameter is dedicated for.

values_description

dict, used in the following cases:

• when the amount of values the parameter can take is finite, to describe each value:

values_description:
  rps: fix rps rate,
  instances: fix number of instances,
  stpd_file: use ready schedule file

• when values can be classified into finite amount of sets, to describe each set:

values_description:
  line(start_rps,end_rps,t): linear growth from start_rps to end_rps during time t,
  const(C,t): constant C rps during time t}

examples

dict, {example: annotation}

examples:
  http(4xx,50%,5): stop when rate of 4xx http codes is 50% or more during 5 seconds

tutorial_link

string, link to detailed article

tutorial_link: http://yandextank.readthedocs.io