Skip to content

Commit

Permalink
Documentation tweaks (#60)
Browse files Browse the repository at this point in the history
* Add a useful link to the docs in README

* Minor tweaks in the run documentation
  • Loading branch information
dragotin authored Jan 24, 2024
1 parent 940f08b commit 3372877
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
20 changes: 11 additions & 9 deletions packages/k6-tests/docs/run.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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 \
Expand All @@ -31,7 +33,7 @@ docker run \

## For ownCloud Server

### local K6
### Local K6

```shell
PLATFORM_TYPE=ownCloudServer \
Expand All @@ -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 \
Expand All @@ -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 \
Expand All @@ -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 \
Expand Down

0 comments on commit 3372877

Please sign in to comment.