-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add utility to validate the run-file
And update doc
- Loading branch information
1 parent
75467b8
commit d82a89b
Showing
2 changed files
with
26 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,42 @@ | ||
|
||
### JSON Run File | ||
# Crucible run-file | ||
|
||
The "all-in-one" JSON run file enables test configuration by using a single | ||
JSON file. Users can specify multi-value parameters, tools, tags, endpoint, | ||
and passthru arguments in JSON format, everything in the same file. | ||
The Crucible run-file, a.k.a. "all-in-one" JSON, is the configuration file | ||
used for running benchmarks. It consolidates all kinds of the settings from | ||
the test run without the need of creating separated files for different | ||
aspects of the test. | ||
|
||
When a run-file JSON is used by Crucible command line, it enables test | ||
configuration by using a single JSON file. Users can specify multi-value | ||
parameters, tools, tags, endpoints, and run parameters, all using an unified | ||
JSON format, in one single place. | ||
|
||
For more details on the supported format, refer to the JSON [schema](JSON/schema.json). | ||
|
||
To validate a run-file, run: | ||
``` | ||
python3 validate_run_file.py --json <run-file-json> | ||
``` | ||
|
||
To use a run-file JSON in Crucible, run: | ||
``` | ||
crucible run --from-file <run-file-json> | ||
``` | ||
|
||
## blockbreaker.py utility | ||
|
||
The "blockbreaker.py" utility extracts a configuration block from the | ||
"all-in-one" JSON run file and transforms into a single JSON block or stream. | ||
run-file JSON and transforms into a JSON block or stream output. | ||
|
||
## Usage | ||
Usage: | ||
``` | ||
# python3 blockbreaker.py --json <json-run-file> --config <config> | ||
python3 blockbreaker.py --json <run-file-json> --config <config> | ||
``` | ||
Example: | ||
``` | ||
# python3 blockbreaker.py --json run-file.json --config mv-params | ||
python3 blockbreaker.py --json run-file.json --config mv-params | ||
``` | ||
|
||
For more options and usage run: | ||
``` | ||
# python3 blockbreaker.py --help | ||
python3 blockbreaker.py --help | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters