From b98fb58a09f1a4548f29c4720a2101b39dc6d218 Mon Sep 17 00:00:00 2001 From: Aleksejs Sinicins Date: Mon, 21 Jan 2019 21:00:58 +0200 Subject: [PATCH] Document registry s3 transfer acceleration option. https://github.com/docker/distribution/pull/2166 --- docs/storage-drivers/s3.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/storage-drivers/s3.md b/docs/storage-drivers/s3.md index 7e2010798..ce1612fb7 100644 --- a/docs/storage-drivers/s3.md +++ b/docs/storage-drivers/s3.md @@ -153,6 +153,18 @@ Amazon S3 or S3 compatible services for object storage. The S3 storage class applied to each registry file. The default value is STANDARD. + + + s3accelerate + + + no + + + Specifies whether the registry should use S3 Transfer Acceleration. You must enable acceleration + endpoint on a bucket before using this option. A boolean value. The default is false. + + @@ -185,6 +197,8 @@ Amazon S3 or S3 compatible services for object storage. `storageclass`: (optional) The storage class applied to each registry file. Defaults to STANDARD. Valid options are STANDARD and REDUCED_REDUNDANCY. +`s3accelerate`: (optional) Whether you would like to use accelerate endpoint for communication with S3. You must enable acceleration on a bucket before using this option. See https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html on how to use enable option. + ## S3 permission scopes The following AWS policy is required by the registry for push and pull. Make sure to replace `S3_BUCKET_NAME` with the name of your bucket. @@ -228,6 +242,11 @@ from edge servers, rather than the geographically limited location of your S3 bucket. The farther your registry is from your bucket, the more improvements are possible. See [Amazon CloudFront](https://aws.amazon.com/cloudfront/details/). +An alternative method for CloudFront that requires less configuration and will use +the same edge servers is [S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html). +Please check acceleration [Requirements](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html#transfer-acceleration-requirements) +to see whether you need CloudFront or S3 Transfer Acceleration. + ## Configuring CloudFront for Distribution If you are unfamiliar with creating a CloudFront distribution, see [Getting