add FAQ section [skip ci] (#27)

* add FAQ section [skip ci] * faq update [skip ci] * Add files via upload * update [skip ci] * doc [skip ci] * doc [skip ci] * add concurrency [skip ci] * update [skip ci] * add docker vs jar charts [skip ci] * [skip ci] * add docker vs jar charts [skip ci] * add docker vs jar charts [skip ci]
emc-mongoose · Feb 20, 2020 · 6b4a05c · 6b4a05c
1 parent 9f1b147
commit 6b4a05c
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@
 6. [Documentation](doc) 📄 <br/>
 7. [Contributing](doc/contributing)<br/>
 8. [Changelog](doc/changelog)<br/>
+9. [FAQ](doc/faq) ❓ <br/>
 
 # 1. Overview
 

diff --git a/doc/faq/README.md b/doc/faq/README.md
@@ -0,0 +1,47 @@
+# FAQ
+
+## What is *latency* and *duration*?
+
+![](mongoose-lat-dur.png)
+
+A = mongoose start formulate a request
+
+B = mongoose sent the first byte to storage
+
+C = mongoose get the first byte of response from storage
+
+D = mongoose get the last byte of response from storage; operation finish
+
+**Latency = C-B** : this value is measured in nanoseconds and shows how much time passed since mongoose sent first byte to storage till first byte  from storage was returned. This value depends on object size in case of Create or Update, and doesn't in case of Read and Delete.
+
+**Duration = D-A** : total operation time (this value is measured in nanoseconds).
+
+## What is *concurrency*?
+
+**Concurrency level** = count of concurrently executed load operations/ the number of open connections at any moment of time ( in terms of the [netty driver](https://github.com/emc-mongoose/mongoose-storage-driver-netty) and its ["child" drivers](https://github.com/emc-mongoose/mongoose#dependency)).
+
+## How to deploy with docker or jar?
+
+We recommend deploying the mongoose with **docker**, because:
+
+* no need to have specific version of java on your machine;
+* no need to search for the latest jar file and download it from maven;
+* no need to search and download jar with extensions for each storage driver;
+* and all the other [advantages of docker](https://dzone.com/articles/top-10-benefits-of-using-docker)
+
+## Does docker affect tool performance?
+
+3 tests were performed for each item-size (10B-100MB):
+  * mongoose-storage-driver-s3 + minio server
+  * standalone mode
+  * CREATE operations
+
+AVG Bandwith:
+
+![](../images/docker_vs_jar_bw.png)
+
+AVG Latency:
+
+![](../images/docker_vs_jar_lat.png)
+
+
diff --git a/doc/faq/mongoose-lat-dur.png b/doc/faq/mongoose-lat-dur.png
diff --git a/doc/images/docker_vs_jar_bw.png b/doc/images/docker_vs_jar_bw.png
diff --git a/doc/images/docker_vs_jar_lat.png b/doc/images/docker_vs_jar_lat.png