Document registry s3 transfer acceleration option.

https://github.com/docker/distribution/pull/2166
This commit is contained in:
Aleksejs Sinicins 2019-01-21 21:00:58 +02:00
parent 2186a91607
commit b98fb58a09

View file

@ -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.
</td>
</tr>
<tr>
<td>
<code>s3accelerate</code>
</td>
<td>
no
</td>
<td>
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 <code>false</code>.
</td>
</tr>
</table>
@ -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