docs contain incorrect command for `rally info BenchmarkScenarios`

Bug #1433985 reported by Yair Fried
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Rally
Fix Released
Medium
Hugh Ma

Bug Description

https://rally.readthedocs.org/en/latest/tutorial/step_6_discovering_more_benchmark_scenarios.html contains command `rally info find BenchmarkScenarios` which is wrong. `rally info BenchmarkScenarios` should be used instead.

summary: - rally info find BenchmarkScenarios Fails
+ docs contain incorrect command for `rally info BenchmarkScenarios`
description: updated
Changed in rally:
status: New → Triaged
importance: Undecided → Medium
milestone: none → 0.0.3
Revision history for this message
Yair Fried (yfried) wrote :
Download full text (4.1 KiB)

Ok, so after a little more digging, seems like the doc is wrong:

$ rally info -h
usage: rally info [-h]

                  {BenchmarkScenarios,DeployEngines,DeploymentEngines,SLA,ServerProviders,find,list}
                  ...

This command allows you to get quick doc of some rally entities.

    Available for scenario groups, scenarios, SLA, deploy engines and
    server providers.

    Usage:
        $ rally info find <query>

    To get information about main concepts of Rally as well as to list entities
    you can query docs for, type one of the following:
        $ rally info BenchmarkScenarios
        $ rally info SLA
        $ rally info DeploymentEngines
        $ rally info ServerProviders

Commands:
   BenchmarkScenarios Get information about benchmark scenarios available in Rally.
   DeployEngines Get information about deploy engines available in Rally.
   DeploymentEngines Get information about deploy engines available in Rally.
   SLA Get information about SLA available in Rally.
   ServerProviders Get information about server providers available in Rally.
   find Search for an entity that matches the query and print info about it.
   list List main entities in Rally for which rally info find works.

$ rally info BenchmarkScenarios
-----------------------------
 Rally - Benchmark scenarios
-----------------------------

Benchmark scenarios are what Rally actually uses to test the performance of an OpenStack deployment.
Each Benchmark scenario implements a sequence of atomic operations (server calls) to simulate
interesing user/operator/client activity in some typical use case, usually that of a specific OpenStack
project. Iterative execution of this sequence produces some kind of load on the target cloud.
Benchmark scenarios play the role of building blocks in benchmark task configuration files.

Scenarios in Rally are put together in groups. Each scenario group is concentrated on some specific
OpenStack functionality. For example, the "NovaServers" scenario group contains scenarios that employ
several basic operations available in Nova.

 List of Benchmark scenario groups:
--------------------------------------------------------------------------------------------
 Name Description
--------------------------------------------------------------------------------------------
 Authenticate Benchmark scenarios for the authentication mechanism.
 CeilometerAlarms Benchmark scenarios for Ceilometer Alarms API.
 CeilometerMeters Benchmark scenarios for Ceilometer Meters API.
 CeilometerQueries Benchmark scenarios for Ceilometer Queries API.
 CeilometerResource Benchmark scenarios for Ceilometer Resource API.
 CeilometerStats Benchmark scenarios for Ceilometer Stats API.
 CinderVolumes Benchmark scenarios for Cinder Volumes.
 DesignateBasic Basic benchmark scenarios for Designate.
 Dummy Dummy benchmarks for testing Rally benchmark engine at scale.
 GlanceImages Benchmark scenarios for Glance ima...

Read more...

Hugh Ma (hughkma)
Changed in rally:
assignee: nobody → Hugh Ma (hughkma)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to rally (master)

Fix proposed to branch: master
Review: https://review.openstack.org/172224

Changed in rally:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to rally (master)

Reviewed: https://review.openstack.org/172224
Committed: https://git.openstack.org/cgit/stackforge/rally/commit/?id=d64e5a4b73e459d334e7c7bd1321ac5bcc6edde5
Submitter: Jenkins
Branch: master

commit d64e5a4b73e459d334e7c7bd1321ac5bcc6edde5
Author: Hugh Ma <email address hidden>
Date: Thu Apr 9 14:51:53 2015 -0700

    Replaced incorrect BenchmarkScenarios list command in doc

    Changes:
      - 'rally info find BenchmarkScenarios" changed to
        'rally info BenchmarkScenarios'

    Change-Id: I520962f4989d5ec89d8edd285283675cff278bd9
    Closes-Bug: #1433985

Changed in rally:
status: In Progress → Fix Committed
Changed in rally:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.