diff --git a/e2e-test/qa/benchmark/Makefile b/e2e-test/qa/benchmark/Makefile index dc1963561..3d68478f4 100644 --- a/e2e-test/qa/benchmark/Makefile +++ b/e2e-test/qa/benchmark/Makefile @@ -20,7 +20,7 @@ start-drivers: ## 2 - start BM Drivers start-all: start-manager start-drivers ## 3 - start BM Manager and Driver -clean-up: ## clean BM Manager and Drivers +clean: ## clean BM Manager and Drivers $(dc) -f docker-compose-manager.yml down || true && $(dc) -f docker-compose-drivers.yml down || true benchmark-prepare: ## 1 - prepare data with users/sites for benchmark diff --git a/e2e-test/qa/benchmark/README.md b/e2e-test/qa/benchmark/README.md index 3d7e8345c..ba648468b 100644 --- a/e2e-test/qa/benchmark/README.md +++ b/e2e-test/qa/benchmark/README.md @@ -1,5 +1,41 @@ -# About -Starting BM Server and BM Drivers automatically on your machine +## About -# How to use it ? -TBD \ No newline at end of file +Starting automatically Benchmark infrastructure: +* [BM Manager](https://github.com/Alfresco/alfresco-bm-manager) +* [BM Drivers](https://github.com/Alfresco/alfresco-bm-manager/tree/master/docs/bm-driver) + * running create [users](https://github.com/Alfresco/alfresco-bm-load-users) + * running create [data](https://github.com/Alfresco/alfresco-bm-load-data) + * running [rest test](https://github.com/Alfresco/alfresco-bm-rest-api) + +## Prerequisites +* ACS deployed in AWS (EKS or Docker) +* Benchmark knowledge (check the official documentation above) + +## How to use it? +### a) start BM Manager and Drivers locally + +```shell +$ make start-all +``` +>check the official documentation how to use the benchmark + +### b) prepare data for benchmarking +> we need to create users/sites and load some content in order to tests the search performance + +```shell +$ make benchmark-prepare +``` +>this will call some shell scripts + +### c) run the actual benchmark tests +>you can tweak the benchmark tests as you want in the shell script executed by this task +```shell +$ make start-all +``` + +### `!` Bamboo Build +We defined a sad benchmark build: [SAD-BEN](https://bamboo.alfresco.com/bamboo/browse/SAD-BEN) that will execute the steps above automatically for you. + +If you run it customized, you can override the `ALFRESCO_URL` variable to point to a deployed ACS instance (default to: "http://ec2-34-245-148-19.eu-west-1.compute.amazonaws.com:8081") + +At the end of the tests you will have access to Excel reports (the actual benchmark results) \ No newline at end of file