docs contain incorrect command for `rally info BenchmarkScenarios`
Bug #1433985 reported by
Yair Fried
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Rally |
Fix Released
|
Medium
|
Hugh Ma |
Bug Description
https:/
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 |
Changed in rally: | |
assignee: | nobody → Hugh Ma (hughkma) |
Changed in rally: | |
status: | Fix Committed → Fix Released |
To post a comment you must log in.
Ok, so after a little more digging, seems like the doc is wrong:
$ rally info -h
usage: rally info [-h]
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: narios Get information about benchmark scenarios available in Rally. gines Get information about deploy engines available in Rally.
BenchmarkSce
DeployEngines Get information about deploy engines available in Rally.
DeploymentEn
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. client activity in some typical use case, usually that of a specific OpenStack
Each Benchmark scenario implements a sequence of atomic operations (server calls) to simulate
interesing user/operator/
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...