Ceph bench help messages update
Related-PROD: PROD-36669
Change-Id: If84111f0710453b6fbc387830ca40f2bbd3fbf6e
diff --git a/cfg_checker/modules/ceph/__init__.py b/cfg_checker/modules/ceph/__init__.py
index eee01ce..85d4273 100644
--- a/cfg_checker/modules/ceph/__init__.py
+++ b/cfg_checker/modules/ceph/__init__.py
@@ -48,18 +48,18 @@
ceph_info_parser.add_argument(
'--detailed',
action="store_true", default=False,
- help="Print additional details"
+ help="Print additional details. (Not implemented yet)"
)
ceph_info_parser.add_argument(
'--tgz',
metavar='ceph_tgz_filename',
- help="HTML filename to save report"
+ help="TGZ archive filename to save gathered data"
)
ceph_report_parser = ceph_subparsers.add_parser(
'report',
- help="Generate network check report"
+ help="Generate Ceph Info report"
)
ceph_report_parser.add_argument(
@@ -74,14 +74,9 @@
)
ceph_bench_parser.add_argument(
- '--task-list',
- metavar='ceph_tasks_filename',
- help="List file with data for Ceph bench testrun"
- )
- ceph_bench_parser.add_argument(
'--agents',
type=int, metavar='agent_count', default=5,
- help="List file with data for Ceph bench testrun"
+ help="Number of agents to use in all test runs. Default: 5"
)
ceph_bench_parser.add_argument(
'--html',
@@ -96,7 +91,7 @@
ceph_bench_parser.add_argument(
'--task-file',
metavar='task_file',
- help="Task file for benchmark"
+ help="Task file for benchmark with parameters to use"
)
ceph_bench_parser.add_argument(
'--no-cleanup',
@@ -111,62 +106,67 @@
ceph_bench_parser.add_argument(
'--report-only',
action="store_true", default=False,
- help="Just create report using files in folder"
+ help="Just create report using files in '--dump-path' folder"
)
ceph_bench_parser.add_argument(
'--dump-path',
metavar="dump_results",
- help="Dump result after each test run to use them later"
+ help="Dump result after each test run to use them later. "
+ "Default: '/tmp'"
)
ceph_bench_parser.add_argument(
'--name',
metavar="name", default="cephbench",
- help="Dump result after each test run to use them later"
+ help="Job name to use for running fio. "
+ "Can be used to grep results. Default: 'cephbench'"
)
ceph_bench_parser.add_argument(
'--bs',
metavar="blocksize", default="16k",
- help="Block size for single run"
+ help="Block size for single run. Default: '16k'"
)
ceph_bench_parser.add_argument(
'--iodepth',
metavar="iodepth", default="16",
- help="IO Depth for single run"
+ help="IO Depth for single run. Default: '16'"
)
ceph_bench_parser.add_argument(
'--size',
metavar="size", default="10G",
- help="Persistent volume size (M, G)"
+ help="Persistent volume size (M, G). Default: '10G'"
)
ceph_bench_parser.add_argument(
'--readwrite',
metavar="readwrite", default="randrw",
- help="Test mode for single run"
+ help="Test mode for single run (read, write, randrw, "
+ "randread, randwrite). Default: 'randrw'"
)
ceph_bench_parser.add_argument(
'--rwmixread',
metavar="rwmixread", default="50",
- help="Percent of read in randon mixed mode (randrw)"
+ help="Percent of read in random mixed mode (randrw). Default: '50'"
)
ceph_bench_parser.add_argument(
'--ramp-time',
metavar="ramp_time", default="5s",
- help="Warmup time before test"
+ help="Warmup time before test. Default: '5s'"
)
ceph_bench_parser.add_argument(
'--runtime',
metavar="runtime", default="60s",
- help="Time based test run longevity"
+ help="How long to run test. Default: '60s'"
)
ceph_bench_parser.add_argument(
'--ioengine',
metavar="ioengine", default="libaio",
- help="IO Engine used by fio. See eng-help output in fio for list"
+ help="IO Engine used by fio. See 'fio eng-help' output for list. "
+ "Default: 'libaio'"
)
ceph_bench_parser.add_argument(
'--offset-increment',
metavar="offset_increment", default="500M",
- help="IO Engine used by fio. See eng-help output in fio for list"
+ help="Offset to be used in 'read' and 'write' modes if multiple jobs used"
+ "Default: '500M'"
)
return _parser