openstack/rally-openstack
Code Issues Proposed changes

[docs] reduce sphinx warnings

Browse Source 
Change-Id: I94701b83af06269d0264c723945372aeb0697faa
This commit is contained in:
Andrey Kurilin 2017-02-01 17:24:45 +02:00
parent 82152f0a01
commit 647263030f
20 changed files with 110 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/feature_request/check_queue_perfdata.rst
View File

@ -4,6 +4,7 @@ Check queue perfdata
Use case
--------
Sometimes OpenStack services use common messaging system very prodigally. For
example Neutron metering agent sending all database table data on new object
creation i.e https://review.openstack.org/#/c/143672/. It cause to Neutron
@ -19,4 +20,4 @@ Possible solution
-----------------
* Before running tests/benchmarks start process which will connect to queue
topics and measure messages count, size and other data which we need.
topics and measure messages count, size and other data which we need.

4
doc/feature_request/installing_isolated.rst
View File

@ -1,6 +1,6 @@
=================================================================================
==================================================================================
Installation script: ``--pypi-mirror``, ``--package-mirror`` and ``--venv-mirror``
=================================================================================
==================================================================================
Use case

2
doc/feature_request/launch_specific_benchmark.rst
View File

@ -24,4 +24,4 @@ Possible solution
-----------------
* Add optional flag to rally task start command to specify one or more
benchmarks to execute as part of that test run.
benchmarks to execute as part of that test run.

6
doc/release_notes/archive/v0.1.0.rst
View File

@ -134,6 +134,7 @@ New Features & API changes
* Samples of NEW vs OLD context, sla, scenario and runner plugins:
* Context
.. code-block:: python
# Old
@ -167,6 +168,7 @@ New Features & API changes
* Scenario
.. code-block:: python
# Old Scenario
@ -205,6 +207,7 @@ New Features & API changes
..
* Runner
.. code-block:: python
## Old
@ -237,6 +240,7 @@ New Features & API changes
..
* SLA
.. code-block:: python
# Old
@ -495,7 +499,7 @@ Documentation
* **Add plugin reference page**
:ref:`Rally Plugins Reference page <plugin_reference>` page contains a
:ref:`Rally Plugins Reference page <plugin-reference>` page contains a
full list with
* **Add maintainers section on project info page**

2
doc/release_notes/archive/v0.1.2.rst
View File

@ -67,7 +67,7 @@ Rally Task
* Rally supports different API versions now via api_versions context:
.. code:: none
.. code-block:: none
CinderVolumes.create_and_delete_volume:
-

3
doc/release_notes/archive/v0.2.0.rst
View File

@ -120,7 +120,8 @@ Plugins
* [improved] CinderVolumes.create_and_attach_volume
.. warning:: Use "create_vm_params" dict argument instead of **kwargs for instance parameters.
.. warning:: Use "create_vm_params" dict argument instead of ``**kwargs``
for instance parameters.
* **Context**:

2
doc/release_notes/archive/v0.3.0.rst
View File

@ -31,7 +31,7 @@ CLI changes
~~~~~~~~~~~
* .. warning:: [Removed] ``rally info`` in favor of ``rally plugin *``.
It was deprecated for a long time.
It was deprecated for a long time.
* [Modified] ``rally deployment check`` now prints services, which don't have
names, since such services can be used via api_versions context.

24
doc/release_notes/archive/v0.4.0.rst
View File

@ -180,7 +180,8 @@ Bug fixes
for each TestCase. In this case, Rally did not check partial test with x-fail
list and marked test as "fail" insted of "x-fail".
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1568133>`_
`Launchpad bug-report #1568133
<https://bugs.launchpad.net/rally/+bug/1568133>`_
* Weak isolation of scenario arguments between iterations
@ -201,7 +202,8 @@ Bug fixes
Results of failed task validations saved in incorrect format. It broke and
made un-userfriendly `rally task detailed` command.
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1562713>`_
`Launchpad bug-report #1562713
<https://bugs.launchpad.net/rally/+bug/1562713>`_
* Hardcoded task's status in `rally task results`
@ -209,14 +211,16 @@ Bug fixes
task has failed status, but it can be not true(tasks in running state do not
have results).
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1539096>`_
`Launchpad bug-report #1539096
<https://bugs.launchpad.net/rally/+bug/1539096>`_
* Tempest context failed to create network resources
While we merged improvement for keystoneclient, we used wrong way to obtain
tenant id in TempestContext.
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1550848>`_
`Launchpad bug-report #1550848
<https://bugs.launchpad.net/rally/+bug/1550848>`_
* Tasks based on Tempest failed to parse execution time.
@ -226,7 +230,8 @@ Bug fixes
There was an issue while converting task execution time.
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1566712>`_
`Launchpad bug-report #1566712
<https://bugs.launchpad.net/rally/+bug/1566712>`_
* JSONSchema huge impact on task performance
@ -256,13 +261,15 @@ Bug fixes
* Rally did not show "missing argument" error raised by argparse while parsing
cli args
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1562916>`_
`Launchpad bug-report #1562916
<https://bugs.launchpad.net/rally/+bug/1562916>`_
* Issue while checking required arguments in CLI
There was a possible issue in case of several required arguments
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1555764>`_
`Launchpad bug-report #1555764
<https://bugs.launchpad.net/rally/+bug/1555764>`_
* Prepare step of verification did not check visibility of obtained image
@ -270,7 +277,8 @@ Bug fixes
make sure all images are active and they are PUBLIC. If images are not
public, we will have failures of Tempest tests as described in the bug.
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1564431>`_
`Launchpad bug-report #1564431
<https://bugs.launchpad.net/rally/+bug/1564431>`_
Thanks
~~~~~~

63
doc/release_notes/archive/v0.5.0.rst
View File

@ -122,6 +122,7 @@ Sometimes plugins of different bases can have equal names(i.e ceilometer
OSClient and ceilometer Context). It is normal and we should allow such
conflicts. To support such cases we introduced new entity - plugin base.
Statements of plugin bases:
- Each plugin base is unique entity;
- Names of plugin bases can't conflict with each other;
- Names of two or more plugins in one plugin base can't conflict with each
@ -129,6 +130,7 @@ Statements of plugin bases:
- Names of two or more plugins in different plugin base can conflict
Current list of plugin bases:
- rally.task.context.Context
- rally.task.scenario.Scenario
- rally.task.types.ResourceType
@ -182,17 +184,14 @@ Current list of plugin bases:
Add nested_level argument for nested cloning volume to new volume
`Plugin Reference <http://rally.readthedocs.io/en/0.5.0/plugin/plugin_reference.html#cindervolumes-create-volume-and-clone>`_
* Extend CinderVolumes.create_nested_snapshots_and_attach_volume
* Extend `CinderVolumes.create_nested_snapshots_and_attach_volume
<http://rally.readthedocs.io/en/0.5.0/plugin/plugin_reference.html#cindervolumes-create-nested-snapshots-and-attach-volume-scenario>`_
Two new arguments were added: create_volume_kwargs and create_snapshot_kwargs
.. warning:: All arguments related to snapshot creation should be transmitted
only via create_snapshot_kwargs.
`Plugin Reference <http://rally.readthedocs.io/en/0.5.0/plugin/plugin_reference.html#cindervolumes-create-nested-snapshots-and-attach-volume>`_
* Introduce new style of scenarios - class based.
`Spec Reference <https://github.com/openstack/rally/blob/0.5.0/doc/specs/implemented/class-based-scenarios.rst>`_
@ -289,7 +288,8 @@ Bug fixes
* AttributeError while disabling urllib3 warnings on old installations
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1573650>`_
`Launchpad bug-report #1573650
<https://bugs.launchpad.net/rally/+bug/1573650>`_
* install_rally.sh script is failed while obtaining setuptools
@ -298,7 +298,8 @@ Bug fixes
* Strange input task in the report
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1570328>`_
`Launchpad bug-report #1570328
<https://bugs.launchpad.net/rally/+bug/1570328>`_
* Wrong behaviour of boot_server_from_volume scenarios in case of booting
server from image.
@ -312,7 +313,8 @@ Bug fixes
NovaServers.boot_server_from_volume_and_resize
NovaServers.boot_server_from_volume_and_live_migrate
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1578556>`_
`Launchpad bug-report #1578556
<https://bugs.launchpad.net/rally/+bug/1578556>`_
* Weak validation of json schema of RPS runner
@ -322,70 +324,85 @@ Bug fixes
* Rally doesn't take cacert setting while creating keystone session
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1577360>`_
`Launchpad bug-report #1577360
<https://bugs.launchpad.net/rally/+bug/1577360>`_
* Heat scenarios fail when API uses TLS
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1585456>`_
`Launchpad bug-report #1585456
<https://bugs.launchpad.net/rally/+bug/1585456>`_
* Example in comment of context manila_share_networks wrong
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1587164>`_
`Launchpad bug-report #1587164
<https://bugs.launchpad.net/rally/+bug/1587164>`_
* There is no way to get UUID of a verification after it is created by
"rally verify start" or "rally verify import_results" when --no-use is set
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1587034>`_
`Launchpad bug-report #1587034
<https://bugs.launchpad.net/rally/+bug/1587034>`_
* Exposed ssh timeout and interval in vm scenario
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1587728>`_
`Launchpad bug-report #1587728
<https://bugs.launchpad.net/rally/+bug/1587728>`_
* Ceilometer scenario doesn't require "ceilometer" ctx
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1557642>`_
`Launchpad bug-report #1557642
<https://bugs.launchpad.net/rally/+bug/1557642>`_
* "servers" context requires setting network id for multiple possible networks
found.
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1592292>`_
`Launchpad bug-report #1592292
<https://bugs.launchpad.net/rally/+bug/1592292>`_
* nested_level data type incorrect in create_nested_snapshots_and_attach_volume
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1594656>`_
`Launchpad bug-report #1594656
<https://bugs.launchpad.net/rally/+bug/1594656>`_
* Rally cleanup servers raises exception
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1584104>`_
`Launchpad bug-report #1584104
<https://bugs.launchpad.net/rally/+bug/1584104>`_
* Stopping server is redundant before cold-migrating server
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1594730>`_
`Launchpad bug-report #1594730
<https://bugs.launchpad.net/rally/+bug/1594730>`_
* existing_users context doesn't work in case of Keystone v3
* Whether validates flavor's disk or not depends on booting type of the instance
`Launchpad bug-report <https://bugs.launchpad.net/rally/+bug/1596756>`_
`Launchpad bug-report #1596756
<https://bugs.launchpad.net/rally/+bug/1596756>`_
Documentation
~~~~~~~~~~~~~
* Re-use openstack theme for building docs outside rtd.
`Rally Docs at docs.openstack.org <http://docs.openstack.org/developer/rally/>`_
`Rally Docs at docs.openstack.org
<http://docs.openstack.org/developer/rally/>`_
* Add page for Verification component
`RTD page <http://rally.readthedocs.io/en/0.5.0/tutorial/step_10_verifying_cloud_via_tempest.html>`_
`RTD page for Verification component
<http://rally.readthedocs.io/en/0.5.0/tutorial/step_10_verifying_cloud_via_tempest.html>`_
* Add glossary page
`RTD page <http://rally.readthedocs.io/en/0.5.0/tutorial/glossary.html>`_
`RTD page for Glossary
<http://rally.readthedocs.io/en/0.5.0/tutorial/glossary.html>`_
* Adjust docs reference to "KeystoneBasic.authenticate" scenario
`RTD page <http://rally.readthedocs.io/en/0.5.0/tutorial/step_6_aborting_load_generation_on_sla_failure.html>`_
`Step 6. Aborting load generation on success criteria failure
<http://rally.readthedocs.io/en/0.5.0/tutorial/step_6_aborting_load_generation_on_sla_failure.html>`_
Thanks
~~~~~~

3
doc/release_notes/archive/v0.6.0.rst
View File

@ -98,6 +98,7 @@ Rally Verify
~~~~~~~~~~~~
* Updating Tempest config file
- Some tests (for boto, horizon, etc.) were removed from Tempest and now there
is no need to keep the corresponding options in Tempest config file.
@ -134,6 +135,7 @@ Plugins
- `SaharaNodeGroupTemplates.create_delete_node_group_templates <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#saharanodegrouptemplates-create-delete-node-group-templates-scenario>`_
* *NEW!!*:
- `MonascaMetrics.list_metrics <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#monascametrics-list-metrics-scenario>`_
- `SenlinClusters.create_and_delete_cluster <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#senlinclusters-create-and-delete-cluster-scenario>`_
- `Watcher.create_audit_template_and_delete <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#watcher-create-audit-template-and-delete-scenario>`_
@ -149,6 +151,7 @@ Plugins
**Contexts**:
* *NEW!!*:
- `Monasca monasca_metrics <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#monasca-metrics-context>`_
- `Senlin profiles <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#profiles-context>`_
- `Watcher audit_templates <http://rally.readthedocs.io/en/0.6.0/plugin/plugin_reference.html#audit-templates-context>`_

2
doc/release_notes/archive/v0.7.0.rst
View File

@ -95,6 +95,7 @@ Plugins
.. warning:: This plugin is not available anymore in 0.7.0
* *NEW!!*:
- `MagnumClusterTemplates.list_cluster_templates <http://rally.readthedocs.io/en/0.7.0/plugin/plugin_reference.html#magnumclustertemplates-list-cluster-templates-scenario>`_
- `MagnumClusters.list_clusters <http://rally.readthedocs.io/en/0.7.0/plugin/plugin_reference.html#magnumclusters-list-clusters-scenario>`_
- `MagnumClusters.create_and_list_clusters <http://rally.readthedocs.io/en/0.7.0/plugin/plugin_reference.html#magnumclusters-create-and-list-clusters-scenario>`_
@ -111,6 +112,7 @@ Plugins
**Contexts**:
* *NEW!!*:
- `Manila manila_security_services <http://rally.readthedocs.io/en/0.7.0/plugin/plugin_reference.html#manila-security-services-context>`_
- `Magnum cluster_templates <http://rally.readthedocs.io/en/0.7.0/plugin/plugin_reference.html#cluster-templates-context>`_
- `Magnum clusters <http://rally.readthedocs.io/en/0.7.0/plugin/plugin_reference.html#clusters-context>`_

7
doc/release_notes/archive/v0.8.0.rst
View File

@ -35,6 +35,7 @@ Database
.. warning:: Database schema is changed, you must run
`rally-manage db upgrade <http://rally.readthedocs.io/en/0.8.0/cli/cli_reference.html#rally-manage-db-upgrade>`_
to be able to use old Rally installation with latest release.
* change structure of database to be more flexible
* save raw task results in chunks (see raw_result_chunk_size option of
[DEFAULT] rally configuration section)
@ -102,9 +103,10 @@ Plugins
**Scenarios**:
* *Updated*:
- The meaning of the volume_type argument is changes in
`CinderVolumes.create_snapshot_and_attach_volume
<http://rally.readthedocs.io/en/0.8.0/plugins/plugin_reference.html#cindervolumes-create-snapshot-and-attach-volume-scenario>`_
<http://rally.readthedocs.io/en/0.8.0/plugins/plugin_reference.html#cindervolumes-create-snapshot-and-attach-volume-scenario>`_
scenario. It should contain actual volume type instead of boolean value to
choose random volume type.
- Extend `GlanceImages.create_image_and_boot_instances
@ -112,6 +114,7 @@ Plugins
with create_image_kwargs and boot_server_kwargs arguments.
* *NEW!!*:
- `CeilometerAlarms.create_and_get_alarm
<http://rally.readthedocs.io/en/0.8.0/plugins/plugin_reference.html#ceilometeralarms-create-and-get-alarm-scenario>`_
- `CinderVolumeBackups.create_incremental_volume_backup
@ -172,12 +175,14 @@ Plugins
**Hooks**:
* *NEW!!*:
- `fault_injection
<http://rally.readthedocs.io/en/0.8.0/plugins/plugin_reference.html#fault-injection-hook>`_
**Runners**
* *Updated*:
- `RPS runner
<http://rally.readthedocs.io/en/0.8.0/plugins/plugin_reference.html#rps-scenario-runner>`_
is extended with ability to increase 'rps' value by arithmetic progression

6
doc/release_notes/archive/v0.8.1.rst
View File

@ -20,16 +20,20 @@ Plugins
**Scenarios**:
* *Updated*:
- Use new network for each subnet at
`NeutronNetworks.create_and_list_subnets
<http://rally.readthedocs.io/en/0.8.1/plugins/plugin_reference.html#neutronnetworks-create-and-list-subnets-scenario>`_
<http://rally.readthedocs.io/en/0.8.1/plugins/plugin_reference.html#neutronnetworks-create-and-list-subnets-scenario>`_
scenario.
* *NEW!!*:
- `CinderVolumeTypes.create_and_list_encryption_type
<http://rally.readthedocs.io/en/0.8.1/plugins/plugin_reference.html#cindervolumetypes-create-and-list-encryption-type-scenario>`_
- `Quotas.cinder_get
<http://rally.readthedocs.io/en/0.8.1/plugins/plugin_reference.html#quotas-cinder-get-scenario>`_
Thanks
~~~~~~

BIN
doc/source/images/Report-Verify-xfail.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 131 KiB

2
doc/source/project_info/index.rst
View File

@ -144,6 +144,8 @@ Where can I discuss and propose changes?
`subscription and usage instructions`_);
- `Rally team on Launchpad`_: Answers/Bugs/Blueprints.
.. _release_notes:
.. include:: release_notes.rst
.. references:

2
doc/source/project_info/release_notes.rst
View File

@ -13,8 +13,6 @@
License for the specific language governing permissions and limitations
under the License.
.. _release_notes:
Release Notes
-------------

34
doc/source/task/index.rst
View File

@ -124,23 +124,23 @@ input file.
For example, having this in task input file:
.. code-block:: json
.. code-block:: json
"sla": {
"performance_degradation": {
"max_degradation": 50
},
"max_seconds_per_iteration": 1.0,
"failure_rate": {
"max": 0
},
"outliers": {
"max": 1,
"min_iterations": 10,
"sigmas": 10
},
"max_avg_duration": 0.5
}
"sla": {
"performance_degradation": {
"max_degradation": 50
},
"max_seconds_per_iteration": 1.0,
"failure_rate": {
"max": 0
},
"outliers": {
"max": 1,
"min_iterations": 10,
"sigmas": 10
},
"max_avg_duration": 0.5
}
will result SLA section similar to the following:
@ -168,7 +168,7 @@ Table with statistics data
**Action**
Name of the workload metric that has some duration saved.
This is either an atomic action name or *Total* which points to workload
`load duration <#load-duration>`_.
`load duration <#load-duration>`_.
**Min (sec)**
`Minimal`_ duration value

4
doc/source/verification/howto/add_new_reporter.rst
View File

@ -44,8 +44,8 @@ Basically, you need to implement only two methods "validate" and "generate".
Method "validate" should check that destination of the report is right.
Method "generate" should build a report or export results somewhere; actually,
it is up to you what it should do but return format is strict, see :ref:`spec`
section for what it can return.
it is up to you what it should do but return format is strict, see
`Spec <#spec>`_ section for what it can return.
.. code-block:: python

17
doc/source/verification/howto/migrate_from_old_design.rst
View File

@ -286,14 +286,6 @@ Commands for Rally 0.7.0:
$ rally verify genconfig --deployment <uuid> --tempest-config <path> \
--add-options <path> --override
* The command for showing configs `rally verify showconfig
<http://rally.readthedocs.io/en/0.7.0/cli/cli_reference.html#rally-verify-showconfig>`_
.. code-block:: console
$ rally verify showconfig --deployment <uuid>
Command since Rally 0.8.0:
.. code-block:: console
@ -315,13 +307,6 @@ Changes:
3) The argument ``--reconfigure`` replaces old ``--override``. It means that
existing file will be ignored and new one will be used/created.
4) If the argument ``--show`` is specified, a configuration of verifier will be
displayed at the end of command execution.
.. note:: We do not have a separate command for showing configurations
anymore. ``rally verify configure-verifier --show`` shows an existing
configuration if it exists and ``--reconfigure`` argument is not specified
Show config
"""""""""""
@ -399,7 +384,7 @@ Commands for Rally 0.7.0:
$ rally verify show --uuid <uuid> --sort-by <query> --detailed
* Separate command which calls ``rally verify show`` with hardcoded
``--detailed`` flag `rally verify showconfig
``--detailed`` flag `rally verify detailed
<http://rally.readthedocs.io/en/0.7.0/cli/cli_reference.html#rally-verify-detailed>`_
.. code-block:: console

4
doc/user_stories/keystone/authenticate.rst
View File

@ -1,6 +1,6 @@
===================================================================================
====================================================================================
4x performance increase in Keystone inside Apache using the token creation benchmark
===================================================================================
====================================================================================
*(Contributed by Neependra Khare, Red Hat)*