From a042da193676747320ca7cac75d1c70ade9a3c04 Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Fri, 11 Sep 2015 15:59:04 -0400 Subject: Move documentation to new sphinx build TODO: Reorganize documentation into properly named subfolders TODO: Add logos to documentation (see index.rst for example) Note you can see the results of this change via a link in the gerrit comments below NOTE: The merge job for your project has not been enabled, this code will not go to the artifacts page upon a merge. you can merge it and work on it in your own time, please contact me to enable the merge (the merge job will make this documentation avaliable to the public on artifacts.opnfv.org) JIRA:RELENG-15 Change-Id: I8fd519393416e2ac2b3ada6fe0670aa4d038fc87 Signed-off-by: Aric Gardner --- docs/Yardstick_task_templates.rst | 141 --------------------- docs/etc/conf.py | 34 +++++ docs/etc/opnfv-logo.png | Bin 0 -> 2829 bytes docs/templates/testcase_description_template.rst | 88 ------------- .../to-be-reorganized/Yardstick_task_templates.rst | 141 +++++++++++++++++++++ docs/to-be-reorganized/index.rst | 31 +++++ .../testcase_description_template.rst | 88 +++++++++++++ 7 files changed, 294 insertions(+), 229 deletions(-) delete mode 100755 docs/Yardstick_task_templates.rst create mode 100644 docs/etc/conf.py create mode 100644 docs/etc/opnfv-logo.png delete mode 100644 docs/templates/testcase_description_template.rst create mode 100755 docs/to-be-reorganized/Yardstick_task_templates.rst create mode 100644 docs/to-be-reorganized/index.rst create mode 100644 docs/to-be-reorganized/testcase_description_template.rst (limited to 'docs') diff --git a/docs/Yardstick_task_templates.rst b/docs/Yardstick_task_templates.rst deleted file mode 100755 index 538937fd7..000000000 --- a/docs/Yardstick_task_templates.rst +++ /dev/null @@ -1,141 +0,0 @@ -Task Template Syntax -==================== - -Basic template syntax ---------------------- -A nice feature of the input task format used in Yardstick is that it supports the template syntax based on Jinja2. -This turns out to be extremely useful when, say, you have a fixed structure of your task but you want to -parameterize this task in some way. -For example, imagine your input task file (task.yaml) runs a set of Ping scenarios: - -:: - - # Sample benchmark task config file - # measure network latency using ping - schema: "yardstick:task:0.1" - - scenarios: - - - type: Ping - options: - packetsize: 200 - host: athena.demo - target: ares.demo - - runner: - type: Duration - duration: 60 - interval: 1 - - sla: - max_rtt: 10 - action: monitor - - context: - ... - -Let's say you want to run the same set of scenarios with the same runner/context/sla, -but you want to try another packetsize to compare the performance. -The most elegant solution is then to turn the packetsize name into a template variable: - -:: - - # Sample benchmark task config file - # measure network latency using ping - - schema: "yardstick:task:0.1" - scenarios: - - - type: Ping - options: - packetsize: {{packetsize}} - host: athena.demo - target: ares.demo - - runner: - type: Duration - duration: 60 - interval: 1 - - sla: - max_rtt: 10 - action: monitor - - context: - ... - -and then pass the argument value for {{packetsize}} when starting a task with this configuration file. -Yardstick provides you with different ways to do that: - -1.Pass the argument values directly in the command-line interface (with either a JSON or YAML dictionary): - -:: - - yardstick task start samples/ping-template.yaml --task-args '{"packetsize": "200"}' - -2.Refer to a file that specifies the argument values (JSON/YAML): - -:: - - yardstick task start samples/ping-template.yaml --task-args-file args.yaml - -Using the default values ------------------------- -Note that the Jinja2 template syntax allows you to set the default values for your parameters. -With default values set, your task file will work even if you don't parameterize it explicitly while starting a task. -The default values should be set using the {% set ... %} clause (task.yaml).For example: - -:: - - # Sample benchmark task config file - # measure network latency using ping - schema: "yardstick:task:0.1" - {% set packetsize = packetsize or "100" %} - scenarios: - - - type: Ping - options: - packetsize: {{packetsize}} - host: athena.demo - target: ares.demo - - runner: - type: Duration - duration: 60 - interval: 1 - ... - -If you don't pass the value for {{packetsize}} while starting a task, the default one will be used. - -Advanced templates ------------------- -Yardstick makes it possible to use all the power of Jinja2 template syntax, including the mechanism of built-in functions. -As an example, let us make up a task file that will do a block storage performance test. -The input task file (fio-template.yaml) below uses the Jinja2 for-endfor construct to accomplish that: - -:: - - #Test block sizes of 4KB, 8KB, 64KB, 1MB - #Test 5 workloads: read, write, randwrite, randread, rw - schema: "yardstick:task:0.1" - - scenarios: - {% for bs in ['4k', '8k', '64k', '1024k' ] %} - {% for rw in ['read', 'write', 'randwrite', 'randread', 'rw' ] %} - - - type: Fio - options: - filename: /home/ec2-user/data.raw - bs: {{bs}} - rw: {{rw}} - ramp_time: 10 - host: fio.demo - runner: - type: Duration - duration: 60 - interval: 60 - - {% endfor %} - {% endfor %} - context - ... diff --git a/docs/etc/conf.py b/docs/etc/conf.py new file mode 100644 index 000000000..006603516 --- /dev/null +++ b/docs/etc/conf.py @@ -0,0 +1,34 @@ +import datetime +import sys +import os + +try: + __import__('imp').find_module('sphinx.ext.numfig') + extensions = ['sphinx.ext.numfig'] +except ImportError: + # 'pip install sphinx_numfig' + extensions = ['sphinx_numfig'] + +# numfig: +number_figures = True +figure_caption_prefix = "Fig." + +source_suffix = '.rst' +master_doc = 'index' +pygments_style = 'sphinx' +html_use_index = False + +pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] +pdf_fit_mode = "shrink" +pdf_stylesheets = ['sphinx','kerning','a4'] +#latex_domain_indices = False +#latex_use_modindex = False + +latex_elements = { + 'printindex': '', +} + +project = u'OPNFV: Template documentation config' +copyright = u'%s, OPNFV' % datetime.date.today().year +version = u'1.0.0' +release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png new file mode 100644 index 000000000..1519503eb Binary files /dev/null and b/docs/etc/opnfv-logo.png differ diff --git a/docs/templates/testcase_description_template.rst b/docs/templates/testcase_description_template.rst deleted file mode 100644 index 899554dec..000000000 --- a/docs/templates/testcase_description_template.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. NOTE:: - Template to be used for test case descriptions in Yardstick Project. - Write one .rst per test case. - Upload the .rst for the test case in /docs directory. Review in Gerrit. - -****************** -Test Case -****************** - -.. contents:: Table of Contents - :depth: 3 - ---------------------- -Test Case Description ---------------------- - -Yardstick Test Case ID ----------------------- - -OPNFV_YARDSTICK_TC_ - -where: - - : check Jira issue for the test case - - : check Jira issue for the test case - - -Purpose -------- - -Describe what is the purpose of the test case - -Area ----- - -State the area and sub-area covered by the test case. - -Areas: Compute, Networking, Storage - -Sub-areas: Performance, System limit, QoS - -Metrics -------- - -What will be measured, attribute name or collection of attributes, behavior - -References ----------- - -Reference documentation - --------------- -Pre-requisites --------------- - -Tools ------ - -What tools are used to perform the measurements (e.g. fio, pktgen) - - -Configuration -------------- - -State the .yaml file to use. - -State default configuration in the tool(s) used to perform the measurements (e.g. fio, pktgen). - -State what POD-specific configuration is required to enable running the test case in different PODs. - -State SLA, if applicable. - -State test duration. - -------- -Results -------- - -Expected outcome ----------------- - -State applicable graphical presentation - -State applicable output details - -State expected Value, behavior, pass/fail criteria - - - diff --git a/docs/to-be-reorganized/Yardstick_task_templates.rst b/docs/to-be-reorganized/Yardstick_task_templates.rst new file mode 100755 index 000000000..538937fd7 --- /dev/null +++ b/docs/to-be-reorganized/Yardstick_task_templates.rst @@ -0,0 +1,141 @@ +Task Template Syntax +==================== + +Basic template syntax +--------------------- +A nice feature of the input task format used in Yardstick is that it supports the template syntax based on Jinja2. +This turns out to be extremely useful when, say, you have a fixed structure of your task but you want to +parameterize this task in some way. +For example, imagine your input task file (task.yaml) runs a set of Ping scenarios: + +:: + + # Sample benchmark task config file + # measure network latency using ping + schema: "yardstick:task:0.1" + + scenarios: + - + type: Ping + options: + packetsize: 200 + host: athena.demo + target: ares.demo + + runner: + type: Duration + duration: 60 + interval: 1 + + sla: + max_rtt: 10 + action: monitor + + context: + ... + +Let's say you want to run the same set of scenarios with the same runner/context/sla, +but you want to try another packetsize to compare the performance. +The most elegant solution is then to turn the packetsize name into a template variable: + +:: + + # Sample benchmark task config file + # measure network latency using ping + + schema: "yardstick:task:0.1" + scenarios: + - + type: Ping + options: + packetsize: {{packetsize}} + host: athena.demo + target: ares.demo + + runner: + type: Duration + duration: 60 + interval: 1 + + sla: + max_rtt: 10 + action: monitor + + context: + ... + +and then pass the argument value for {{packetsize}} when starting a task with this configuration file. +Yardstick provides you with different ways to do that: + +1.Pass the argument values directly in the command-line interface (with either a JSON or YAML dictionary): + +:: + + yardstick task start samples/ping-template.yaml --task-args '{"packetsize": "200"}' + +2.Refer to a file that specifies the argument values (JSON/YAML): + +:: + + yardstick task start samples/ping-template.yaml --task-args-file args.yaml + +Using the default values +------------------------ +Note that the Jinja2 template syntax allows you to set the default values for your parameters. +With default values set, your task file will work even if you don't parameterize it explicitly while starting a task. +The default values should be set using the {% set ... %} clause (task.yaml).For example: + +:: + + # Sample benchmark task config file + # measure network latency using ping + schema: "yardstick:task:0.1" + {% set packetsize = packetsize or "100" %} + scenarios: + - + type: Ping + options: + packetsize: {{packetsize}} + host: athena.demo + target: ares.demo + + runner: + type: Duration + duration: 60 + interval: 1 + ... + +If you don't pass the value for {{packetsize}} while starting a task, the default one will be used. + +Advanced templates +------------------ +Yardstick makes it possible to use all the power of Jinja2 template syntax, including the mechanism of built-in functions. +As an example, let us make up a task file that will do a block storage performance test. +The input task file (fio-template.yaml) below uses the Jinja2 for-endfor construct to accomplish that: + +:: + + #Test block sizes of 4KB, 8KB, 64KB, 1MB + #Test 5 workloads: read, write, randwrite, randread, rw + schema: "yardstick:task:0.1" + + scenarios: + {% for bs in ['4k', '8k', '64k', '1024k' ] %} + {% for rw in ['read', 'write', 'randwrite', 'randread', 'rw' ] %} + - + type: Fio + options: + filename: /home/ec2-user/data.raw + bs: {{bs}} + rw: {{rw}} + ramp_time: 10 + host: fio.demo + runner: + type: Duration + duration: 60 + interval: 60 + + {% endfor %} + {% endfor %} + context + ... diff --git a/docs/to-be-reorganized/index.rst b/docs/to-be-reorganized/index.rst new file mode 100644 index 000000000..5e078d2c7 --- /dev/null +++ b/docs/to-be-reorganized/index.rst @@ -0,0 +1,31 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + Yardstick_task_templates.rst + testcase_description_template.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/to-be-reorganized/testcase_description_template.rst b/docs/to-be-reorganized/testcase_description_template.rst new file mode 100644 index 000000000..899554dec --- /dev/null +++ b/docs/to-be-reorganized/testcase_description_template.rst @@ -0,0 +1,88 @@ +.. NOTE:: + Template to be used for test case descriptions in Yardstick Project. + Write one .rst per test case. + Upload the .rst for the test case in /docs directory. Review in Gerrit. + +****************** +Test Case +****************** + +.. contents:: Table of Contents + :depth: 3 + +--------------------- +Test Case Description +--------------------- + +Yardstick Test Case ID +---------------------- + +OPNFV_YARDSTICK_TC_ + +where: + - : check Jira issue for the test case + - : check Jira issue for the test case + + +Purpose +------- + +Describe what is the purpose of the test case + +Area +---- + +State the area and sub-area covered by the test case. + +Areas: Compute, Networking, Storage + +Sub-areas: Performance, System limit, QoS + +Metrics +------- + +What will be measured, attribute name or collection of attributes, behavior + +References +---------- + +Reference documentation + +-------------- +Pre-requisites +-------------- + +Tools +----- + +What tools are used to perform the measurements (e.g. fio, pktgen) + + +Configuration +------------- + +State the .yaml file to use. + +State default configuration in the tool(s) used to perform the measurements (e.g. fio, pktgen). + +State what POD-specific configuration is required to enable running the test case in different PODs. + +State SLA, if applicable. + +State test duration. + +------- +Results +------- + +Expected outcome +---------------- + +State applicable graphical presentation + +State applicable output details + +State expected Value, behavior, pass/fail criteria + + + -- cgit 1.2.3-korg