From d8e79cecad16049192a97403d0036046e137de08 Mon Sep 17 00:00:00 2001 From: filipe oliveira Date: Mon, 7 Feb 2022 13:06:44 +0000 Subject: [PATCH] Added doc reference to cli benchmark runner (#76) --- .github/release-drafter-config.yml | 6 ++++++ Readme.md | 2 ++ 2 files changed, 8 insertions(+) diff --git a/.github/release-drafter-config.yml b/.github/release-drafter-config.yml index 51e7f0c..3f94e72 100644 --- a/.github/release-drafter-config.yml +++ b/.github/release-drafter-config.yml @@ -29,6 +29,11 @@ categories: - title: 'Tooling changes: Large scale coordinator' labels: - 'tool-large-coordinator' + + - title: 'Tooling changes: Setup agnostic cli benchmark runner (solely client)' + labels: + - 'tool-client-runner' + - title: 'Maintenance' label: 'chore' change-template: '- $TITLE @$AUTHOR (#$NUMBER)' @@ -49,6 +54,7 @@ template: | - [*Spec tool implementation: Benchmark artifacts builder*](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__builder__/): **Experimental** components are released and available for beta testing. - [*Spec tool implementation: Self-contained coordinator*](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__self_contained_coordinator__/): **Experimental** components are released and available for beta testing. - [*Spec tool implementation: Large scale coordinator*](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/): **Draft** components are under design, and have not been added to the specification. + - [*Spec tool implementation: Setup agnostic cli benchmark runner (solely client)](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__runner__/): contains the client utility that triggers the actual benchmarks against an endpoint provided. This tool is setup agnostic and expects the DB to be properly spinned beforehand. ### Release changes: diff --git a/Readme.md b/Readme.md index 6742bc5..4102fad 100644 --- a/Readme.md +++ b/Readme.md @@ -144,8 +144,10 @@ prepares the artifact(s) and proceeds into adding an artifact benchmark event so * **STATUS: Experimental** [`redis-benchmarks-spec-api`](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__api__/) : contains the API that translates the POST HTTP request that was triggered by github.com/redis/redis upstream changes, and fetches the relevant git/source info and coverts it into an event ( tracked within redis ). * **STATUS: Experimental** [`redis-benchmarks-spec-builder`](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__builder__/): contains the benchmark build agent utility that receives an event indicating a new build variant, generates the required redis binaries to test, and triggers the benchmark run on the listening agents. + * **STATUS: Experimental** [`redis-benchmarks-spec-sc-coordinator`](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__self_contained_coordinator__/): contains the coordinator utility that listens for benchmark suite run requests and setups the required steps to spin the actual benchmark topologies and to trigger the actual benchmarks. +* **STATUS: Experimental** [`redis-benchmarks-spec-client-runner`](https://github.com/filipecosta90/redis-benchmarks-specification/tree/main/redis_benchmarks_specification/__runner__/): contains the client utility that triggers the actual benchmarks against an endpoint provided. This tool is setup agnostic and expects the DB to be properly spinned beforehand. ## Contributing guidelines