jackrabbit-oak-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexander Klimetschek (JIRA)" <j...@apache.org>
Subject [jira] [Created] (OAK-5923) Document S3 datastore
Date Sat, 11 Mar 2017 00:05:04 GMT
Alexander Klimetschek created OAK-5923:

             Summary: Document S3 datastore
                 Key: OAK-5923
                 URL: https://issues.apache.org/jira/browse/OAK-5923
             Project: Jackrabbit Oak
          Issue Type: Documentation
          Components: blob
            Reporter: Alexander Klimetschek

The S3 datastore is currently hardly documented.

The [generic blobstore documentation|http://jackrabbit.apache.org/oak/docs/plugins/blobstore.html]
is very much focused about the internal class structures, but quite confusing for someone
who wants to configure a specific datastore such as file and s3 (the only ones right now).
S3 settings are not documented at all, the [config page|http://jackrabbit.apache.org/oak/docs/osgi_config.html#config-blobstore]
only mentions the generic maxCachedBinarySize and cacheSizeInMB.

The best bet is the [Adobe AEM product documentation|https://docs.adobe.com/docs/en/aem/6-2/deploy/platform/data-store-config.html],
but that is for an older version and a few things changed since then.

Specific items below. Some have been confusing people using oak-blob-cloud 1.5.15:
- "secret" property unclear (new)
- secretKey & accessKey can be omitted to leverage IAM roles (new)
- drop of proactiveCaching property (new)
- aws bucket/region/etc. settings
- config options (timeout, retries, threads)
- understanding caching behavior and performance optimization
- shared vs. non-shared options
- migrating from a previous version, how to update the config

This message was sent by Atlassian JIRA

View raw message