From 6989c5b01ff6d99276a411adfa96b19ca44b7194 Mon Sep 17 00:00:00 2001 From: Cyrill Troxler Date: Mon, 6 Aug 2018 19:27:24 +0200 Subject: [PATCH] Update README --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 20ec526..416159f 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,10 @@ metadata: stringData: accessKeyID: secretAccessKey: - endpoint: + # If not on S3, set it to "" region: - # specify which mounter to use - # can be set to s3fs, goofys or s3ql - mounter: # Currently only for s3ql # If not using s3ql, set it to "" encryptionKey: @@ -71,6 +70,8 @@ If something does not work as expected, check the troubleshooting section below. # Additional configuration ## Mounter +As S3 is not a real file system there are some limitations to consider here. Depending on what mounter you are using, you will have different levels of POSIX compability. Also depending on what S3 storage backend you are using there are not always [consistency guarantees](https://github.com/gaul/are-we-consistent-yet#observed-consistency). + The driver can be configured to use one of these mounters to mount buckets: * [s3fs](https://github.com/s3fs-fuse/s3fs-fuse) @@ -109,8 +110,7 @@ All mounters have different strengths and weaknesses depending on your use case. * Supports compression before upload (Not yet implemented in this driver) * Supports encryption before upload (Not yet implemented in this driver) -# Limitations -As S3 is not a real file system there are some limitations to consider here. Depending on what mounter you are using, you will have different levels of POSIX compability. Also depending on what S3 storage backend you are using there are not always consistency guarantees. The detailed limitations can be found on the documentation of [s3fs](https://github.com/s3fs-fuse/s3fs-fuse#limitations) and [goofys](https://github.com/kahing/goofys#current-status). +Fore more detailed limitations consult the documentation of the different projects. # Troubleshooting ## Issues while creating PVC