diff --git a/README.md b/README.md index 78939aa..0669895 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This repository contains the tools we use to test and measure the performance of different cloud systems. +For detailed information how to run and write new tests, please read [the cdperf documentation](https://owncloud.dev/cdperf/). + ## Supported clouds * [ownCloud Core](https://github.com/owncloud/core) * [Infinite Scale](https://github.com/owncloud/ocis) diff --git a/packages/k6-tests/docs/run.md b/packages/k6-tests/docs/run.md index 3027ba3..c88f8c7 100644 --- a/packages/k6-tests/docs/run.md +++ b/packages/k6-tests/docs/run.md @@ -1,8 +1,10 @@ # Run the tests -all tests are executed in the same way, only the (options)[/k6-tests/src/values/env] and the way of execution differ. below you can see how this works +All tests are executed in the same way, only the [options](/k6-tests/src/values/env) and the way of execution differ. Below you can see how this works. -you can find more information on how use or install K6 [here](https://k6.io/docs/get-started/running-k6/). +You can find more information on how use or install K6 [here](https://k6.io/docs/get-started/running-k6/). + +All tests need to run with the admin user who is capable of provisioning users. If you have a non standard password for admin, set the environment variables `ADMIN_USER` and `ADMIN_PASSWORD` to match that. ## The following platforms are supported * [ownCloud Infinite Scale](https://github.com/owncloud/ocis) @@ -14,14 +16,14 @@ you can find more information on how use or install K6 [here](https://k6.io/docs ## For ownCloud Infinite Scale -### local K6 +### Local K6 ```shell PLATFORM_BASE_URL=https://cloud-domain.org:80 \ k6 run TEST_FILE.js --vus 2 --iterations 5 ``` -### in docker +### In docker ```shell docker run \ @@ -31,7 +33,7 @@ docker run \ ## For ownCloud Server -### local K6 +### Local K6 ```shell PLATFORM_TYPE=ownCloudServer \ @@ -40,7 +42,7 @@ AUTH_N_PROVIDER_TYPE=basicAuth \ k6 run TEST_FILE.js --vus 2 --iterations 5 ``` -### in docker +### In docker ```shell docker run \ @@ -50,9 +52,9 @@ docker run \ --rm -i grafana/k6 run --vus 2 - < TEST_FILE.js ``` -## For nextcloud +## For Nextcloud -### local K6 +### Local K6 ```shell PLATFORM_TYPE=nextcloud \ @@ -61,7 +63,7 @@ AUTH_N_PROVIDER_TYPE=basicAuth \ k6 run TEST_FILE.js --vus 2 --iterations 5 ``` -### in docker +### In docker ```shell docker run \