X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/9f37e0dd819730350a82c229c12e7856c325212e..52a04643aff653c4302fb20d147e9a4dc551298d:/doc/install/configure-s3-object-storage.html.textile.liquid
diff --git a/doc/install/configure-s3-object-storage.html.textile.liquid b/doc/install/configure-s3-object-storage.html.textile.liquid
index b960ac1fda..6a3c396d60 100644
--- a/doc/install/configure-s3-object-storage.html.textile.liquid
+++ b/doc/install/configure-s3-object-storage.html.textile.liquid
@@ -43,8 +43,8 @@ Volumes are configured in the @Volumes@ section of the cluster configuration fil
# If you are not using an IAM role for authentication,
# specify access credentials here instead.
- AccessKey: ""
- SecretKey: ""
+ AccessKeyID: ""
+ SecretAccessKey: ""
# Storage provider region. For Google Cloud Storage, use ""
# or omit.
@@ -64,6 +64,9 @@ Volumes are configured in the @Volumes@ section of the cluster configuration fil
# might be needed for other S3-compatible services.
V2Signature: false
+ # Use the AWS S3 v2 Go driver instead of the goamz driver.
+ UseAWSS3v2Driver: false
+
# Requested page size for "list bucket contents" requests.
IndexPageSize: 1000
@@ -94,3 +97,9 @@ Volumes are configured in the @Volumes@ section of the cluster configuration fil
# classes" in the "Admin" section of doc.arvados.org.
StorageClasses: null
+
+Two S3 drivers are available. Historically, Arvados has used the @goamz@ driver to talk to S3-compatible services. More recently, support for the @aws-sdk-go-v2@ driver was added. This driver can be activated by setting the @UseAWSS3v2Driver@ flag to @true@.
+
+The @aws-sdk-go-v2@ does not support the old S3 v2 signing algorithm. This will not affect interacting with AWS S3, but it might be an issue when Keep is backed by a very old version of a third party S3-compatible service.
+
+The @aws-sdk-go-v2@ driver can improve read performance by 50-100% over the @goamz@ driver, but it has not had as much production use. See the "wiki":https://dev.arvados.org/projects/arvados/wiki/Keep_real_world_performance_numbers for details.