Author: amitj
Date: Fri Aug 10 10:33:33 2018
New Revision: 1837789

OAK-5923: Document S3 datastore

Documented missing S3 specific properties


Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/ (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/ Fri Aug 10 
10:33:33 2018
@@ -335,6 +335,34 @@ cachePath
 _PID `org.apache.jackrabbit.oak.plugins.blob.datastore.S3DataStore`_
+: AWS access key to be used for accessing the S3 bucket. Not required if IAM 
roles configured.
+: AWS secret key to be used for accessing the S3 bucket. Not required if IAM 
roles configured.
+: Default - `us-standard`
+: S3 Bucket name to be used for storing the binaries/blobs.
+: Region where the S3 bucket is located or to be created if not present.
+: S3 rest API endpoint. Can help reduce latency of redirection from standard 
endpoint if a different region configured.
+: S3 connection timeout. See [AWS S3 
+: S3 socket timeout. See [AWS S3 
+: Maximum connections to S3. See [AWS S3 
+: Max error retries. See [AWS S3 
 : Default - 17408 (17 KB)
 : Size in bytes. Binaries with size less than or equal to this size would be 
stored in in memory cache
@@ -344,7 +372,7 @@ cacheSizeInMB
 : Size in MB. In memory cache for storing small files whose size is less than 
`maxCachedBinarySize`. This
   helps in better performance when lots of small binaries are accessed 
-#### Oak - SharedS3DataStore (Since Oak 1.2.0)
+#### Oak - SharedS3DataStore (Oak 1.2.x & Oak 1.4.x)
 Supports shared S3 DataStore
@@ -367,6 +395,9 @@ All the above data stores enable local f
 * _PID `org.apache.jackrabbit.oak.plugins.blob.datastore.FileDataStore`_
 * _PID `org.apache.jackrabbit.oak.plugins.blob.datastore.AzureDataStore`_
+: The local file system path used to cache binaries and stage binaries for 
asynchronous uploads.
 : Default - 68719476736
 : Size in bytes of DataStore cache. Cache is disabled when cacheSize <= 0.

Reply via email to