Merge pull request #501 from fomars/develop

Develop
yandex · Jan 29, 2018 · f133ae0 · f133ae0
2 parents 74efefa + c440bd8
commit f133ae0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 9 deletions.
diff --git a/docs/config_reference.rst b/docs/config_reference.rst
@@ -653,15 +653,15 @@ Phantom
 
 ``load_profile`` (dict)
 -----------------------
-*\- (no description).* **Required.**
+*\- Configure your load setting the number of RPS or instances (clients) as a function of time,or using a prearranged schedule.* **Required.**
 
 :``load_type`` (string):
- *\- (no description).*
+ *\- Choose control parameter.* **Required.**
 
  :one of:
-  :``instances``: fix number of instances
-  :``rps``: fix rps rate
-  :``stpd_file``: use ready schedule file
+  :``instances``: control the number of instances
+  :``rps``: control the rps rate
+  :``stpd_file``: use prearranged schedule file
 :``schedule`` (string):
  *\- load schedule or path to stpd file.* **Required.**
 
@@ -672,6 +672,8 @@ Phantom
    linear growth from 100 to 200 instances/rps during 10 minutes
   ``test_dir/test_backend.stpd``
    path to ready schedule file
+ :tutorial_link:
+  http://yandextank.readthedocs.io/en/latest/tutorial.html#tutorials
 
 ``loop`` (integer)
 ------------------

diff --git a/yandextank/plugins/Phantom/config/schema.py b/yandextank/plugins/Phantom/config/schema.py
@@ -207,15 +207,19 @@
         'regex': '\d{0,5}'
     },
     "load_profile": {
+        'description': 'Configure your load setting the number of RPS or instances (clients) as a function of time,'
+                       'or using a prearranged schedule',
         "type": "dict",
         'schema': {
             'load_type': {
+                'required': True,
+                'description': 'Choose control parameter',
                 'type': 'string',
                 'allowed': ['rps', 'instances', 'stpd_file'],
                 'values_description': {
-                    'rps': 'fix rps rate',
-                    'instances': 'fix number of instances',
-                    'stpd_file': 'use ready schedule file'}
+                    'rps': 'control the rps rate',
+                    'instances': 'control the number of instances',
+                    'stpd_file': 'use prearranged schedule file'}
             },
             'schedule': {
                 'type': 'string',
@@ -224,7 +228,8 @@
                 'examples': {
                     'line(100,200,10m)': 'linear growth from 100 to 200 instances/rps during 10 minutes',
                     'const(200,90s)': 'constant load of 200 instances/rps during 90s',
-                    'test_dir/test_backend.stpd': 'path to ready schedule file'}
+                    'test_dir/test_backend.stpd': 'path to ready schedule file'},
+                'tutorial_link': 'http://yandextank.readthedocs.io/en/latest/tutorial.html#tutorials'
             }
         },
         'required': True