pivotal-jbarrett commented on a change in pull request #50: GEODE-6340: add optional metadata to benchmark run URL: https://github.com/apache/geode-benchmarks/pull/50#discussion_r253589420
########## File path: infrastructure/scripts/aws/README.md ########## @@ -18,27 +18,58 @@ It takes two arguments. First, a tag to identify the cluster for use with other second argument is the number of instances to create. # run_tests.sh -Runs benchmark tests against a single branch of `geode`. Arguments are (in order) +Runs benchmark tests against a single branch of `geode` on the AWS instances with the specified tag. -* tag (the same as the cluster launched via `launch_cluster.sh`) -* branch of geode (must exist in the apache geode repository) -* branch of benchmark code to use (must exist in the apache geode-benchmarks repository) -* (Optional) output directory for results +Usage: + + run_test.sh -t [tag] [-v [version] | -b [branch]] <options...> + +Options: + + -e : Benchmark branch (optional - defaults to develop) + -o : Output directory (optional - defaults to ./output-<date>-<tag>) + -v : Geode Version + -b : Geode Branch + -t : Cluster tag + -m : Test metadata to output to file, comma-delimited (optional) + -h : Help message # run_against_baseline.sh -Runs benchmark tests against two branches of geode for comparison purposes. Arguments are (in order) +Runs benchmark tests against two branches of geode for comparison purposes on the AWS instances with +the specified tag. -* tag (the same as the cluster launched via `launch_cluster.sh`) -* branch of geode (must exist in the apache geode repository) -* branch of benchmark code to use (must exist in the apache geode-benchmarks repository) +Usage: + + run_test.sh -t [tag] [-v [version] | -b [branch]] [-V [baseline version] | -B [baseline branch]] <options...>" + +Options: + + -e : Benchmark branch (optional - defaults to develop) + -o : Output directory (optional - defaults to ./output-<date>-<tag>) + -v : Geode Version + -b : Geode Branch + -V : Geode Baseline Version + -B : Geode Baseline Branch + -t : Cluster tag + -m : Test metadata to output to file, comma-delimited (optional) + -h : Help message # destroy_cluster.sh Destroys a cluster that you created. Arguments are the tag that you passed to launch_cluster.sh #Example + +Example 1 - run_test.sh: ```bash ./launch_cluster.sh mycluster 4 -./run-tests mycluster -./destroy_cluster.sh +./run_tests.sh -t mycluster -b develop -e benchmarkBranch -m "'name':'HelenaTestingCPUs','CPU':'256','geodeBranch':'CPUTest'" Review comment: While I would prefer a format like: ``` -m key=value -m key=value ``` or ``` -m key=value,key2=value2 ``` I think this is fine too. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
