Merge branch 'ime-support' of https://github.com/DDNStorage/fio-public into ddn-ime

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index c77dad17922dd3081f808946178f8a3d8459f227..ff7aa096495a969aea9eddb0c8159f8054b6b0d1 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -1901,6 +1901,22 @@ I/O engine
                        mounted with DAX on a persistent memory device through the PMDK
                        libpmem library.
 
+               **ime_psync**
+                       Synchronous read and write using DDN's Infinite Memory Engine (IME).
+                       This engine is very basic and issues calls to IME whenever an IO is
+                       queued.
+
+               **ime_psyncv**
+                       Synchronous read and write using DDN's Infinite Memory Engine (IME).
+                       This engine uses iovecs and will try to stack as much IOs as possible
+                       (if the IOs are "contiguous" and the IO depth is not exceeded)
+                       before issuing a call to IME.
+
+               **ime_aio**
+                       Asynchronous read and write using DDN's Infinite Memory Engine (IME).
+                       This engine will try to stack as much IOs as possible by creating
+                       requests for IME. FIO will then decide when to commit these requests.
+
 I/O engine specific parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -2137,14 +2153,16 @@ with the caveat that when used on the command line, they must come after the
 
        Password for HTTP authentication.
 
-.. option:: https=bool : [http]
+.. option:: https=str : [http]
 
-       Enable HTTPS instead of http. Default is **0**
+       Enable HTTPS instead of http. *on* enables HTTPS; *insecure*
+       will enable HTTPS, but disable SSL peer verification (use with
+       caution!). Default is **off**
 
-.. option:: http_s3=bool : [http]
+.. option:: http_mode=str : [http]
 
-       Enable S3 specific HTTP headers such as authenticating requests
-       with AWS Signature Version 4. Default is **0**
+       Which HTTP access mode to use: *webdav*, *swift*, or *s3*.
+       Default is **webdav**
 
 .. option:: http_s3_region=str : [http]
 
@@ -2159,6 +2177,11 @@ with the caveat that when used on the command line, they must come after the
 
        The S3 key/access id.
 
+.. option:: http_swift_auth_token=str : [http]
+
+       The Swift auth token. See the example configuration file on how
+       to retrieve this.
+
 .. option:: http_verbose=int : [http]
 
        Enable verbose requests from libcurl. Useful for debugging. 1