[incubator-openwhisk-performance] 15/22: Add documentation

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

markusthoemmes pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-performance.git

commit d1162b702673f3794de41a4a37726b052290676c
Author: Markus Thoemmes <ma...@de.ibm.com>
AuthorDate: Mon Apr 24 14:29:25 2017 +0200

    Add documentation
---
 README.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 305ddbb..8ced6d6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
-# openwhisk-performance
-Performance harness for Apache OpenWhisk
+# Performance tests for Apache OpenWhisk
+A few simple but efficient performance test suites for Apache OpenWhisk. Determines the maximum throughput and end-user latency of the system.
+
+## Test setup
+- A standard OpenWhisk system is deployed. Note that the edge nginx router and API Gateway are left out currently.
+- Limits are set to 999999 each, for the test's load that means: No throttling at all.
+- The deployment uses a docker setup as proposed by the OpenWhisk development team: `overlay` driver and HTTP API enabled via a UNIX port.
+
+### Travis' machine setup
+The [machine provided by Travis](https://docs.travis-ci.com/user/ci-environment/#Virtualization-environments) has ~2 CPU cores (likely shared through virtualization) and 7.5GB memory.
+
+## Latency test
+The latency test determines the end-to-end latency a user experiences when doing a blocking invocation. The action used is a noop so the numbers returned are plain overhead of the OpenWhisk system.
+
+- 1 HTTP request at a time (concurrency: 1)
+- 10.000 samples with a single user
+- noop action

-- 
To stop receiving notification emails like this one, please contact
"commits@openwhisk.apache.org" <co...@openwhisk.apache.org>.