From fd310f5e9ffa13f5a76c1fb1ef73b2873cbf95fe Mon Sep 17 00:00:00 2001 From: Denis Kirillov Date: Tue, 2 Apr 2024 10:00:44 +0300 Subject: [PATCH] [#343] docs: Actualize s3 compatibility table Signed-off-by: Denis Kirillov --- docs/aws_s3_compat.md | 325 ++++++++++++++++++++---------------------- 1 file changed, 155 insertions(+), 170 deletions(-) diff --git a/docs/aws_s3_compat.md b/docs/aws_s3_compat.md index 7d0c07f7..8a43bd54 100644 --- a/docs/aws_s3_compat.md +++ b/docs/aws_s3_compat.md @@ -1,73 +1,58 @@ # S3 API support Reference: + * [AWS S3 API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/s3-api.pdf) -| | Legend | -|----|-------------------------------------------| -| 🟢 | Supported | -| 🟡 | Partially supported | -| 🔵 | Not supported yet, but will be in future | -| 🔴 | Not applicable or will never be supported | +| | Legend | +|-----|-------------------------------------------| +| 🟢 | Supported | +| 🟡 | Partially supported | +| 🔵 | Not supported yet, but will be in future | +| 🔴 | Not applicable or will never be supported | ## Object -| | Method | Comments | -|----|------------------------|-----------------------------------------| -| 🟢 | CopyObject | Done on gateway side | -| 🟢 | DeleteObject | | -| 🟢 | DeleteObjects | aka DeleteMultipleObjects | -| 🟢 | GetObject | | -| 🔴 | GetObjectTorrent | We don't plan implementing BT gateway | -| 🟢 | HeadObject | | -| 🟢 | ListParts | Parts loaded with MultipartUpload | -| 🟢 | ListObjects | | -| 🟢 | ListObjectsV2 | | -| 🟢 | PutObject | Content-MD5 header deprecated | -| 🔵 | SelectObjectContent | Need to have some Lambda to execute SQL | -| 🔵 | WriteGetObjectResponse | Waiting for Lambda to be developed | -| 🟢 | GetObjectAttributes | | +| | Method | Comments | +|-----|------------------------|-----------------------------------------| +| 🟢 | CopyObject | Done on gateway side | +| 🟢 | DeleteObject | | +| 🟢 | DeleteObjects | aka DeleteMultipleObjects | +| 🟢 | GetObject | | +| 🔴 | GetObjectTorrent | We don't plan implementing BT gateway | +| 🟢 | HeadObject | | +| 🟢 | ListParts | Parts loaded with MultipartUpload | +| 🟢 | ListObjects | | +| 🟢 | ListObjectsV2 | | +| 🟢 | PutObject | Content-MD5 header deprecated | +| 🔵 | SelectObjectContent | Need to have some Lambda to execute SQL | +| 🔵 | WriteGetObjectResponse | Waiting for Lambda to be developed | +| 🟢 | GetObjectAttributes | | ## ACL For now there are some limitations: -* [Bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-policies.html) supports only one `Principal` per `Statement`. -Principal must be `"AWS": "*"` (to refer all users) or `"CanonicalUser": "0313b1ac3a8076e155a7e797b24f0b650cccad5941ea59d7cfd51a024a8b2a06bf"` (hex encoded public key of desired user). -* Resource in bucket policy is an array. Each item MUST contain bucket name, CAN contain object name (wildcards are not supported): -```json -{ - "Statement": [ - { - "Resource": [ - "arn:aws:s3:::bucket", - "arn:aws:s3:::bucket/some/object" - ] - } - ] -} -``` -* AWS conditions and wildcard are not supported in [resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html) -* Only `CanonicalUser` (with hex encoded public key) and `All Users Group` are supported in [ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html) -| | Method | Comments | -|----|--------------|-----------------| -| 🟡 | GetObjectAcl | See Limitations | -| 🟡 | PutObjectAcl | See Limitations | +| | Method | Comments | +|-----|--------------|-----------------------------------| +| 🟢 | GetObjectAcl | Objects can have only private acl | +| 🔴 | PutObjectAcl | Use PutBucketPolicy instead | ## Locking For now there are some limitations: + * Retention period can't be shortened, only extended. * You can't delete locks or object with unexpired lock. -| | Method | Comments | -|-----|----------------------------|---------------------------| -| 🟡 | GetObjectLegalHold | | -| 🟢 | GetObjectLockConfiguration | GetBucketObjectLockConfig | -| 🟡 | GetObjectRetention | | -| 🟡 | PutObjectLegalHold | | -| 🟢 | PutObjectLockConfiguration | PutBucketObjectLockConfig | -| 🟡 | PutObjectRetention | | +| | Method | Comments | +|-----|----------------------------|-------------------------------| +| 🟡 | GetObjectLegalHold | | +| 🟢 | GetObjectLockConfiguration | aka GetBucketObjectLockConfig | +| 🟡 | GetObjectRetention | | +| 🟡 | PutObjectLegalHold | | +| 🟢 | PutObjectLockConfiguration | aka PutBucketObjectLockConfig | +| 🟡 | PutObjectRetention | | ## Multipart @@ -75,185 +60,185 @@ CompleteMultipartUpload operations may take long time to complete. Gateway sends whitespace characters to keep connection with the client alive. In this case, gateway is unable to set proper HTTP headers like `X-Amz-Version-Id`. -| | Method | Comments | -|----|-------------------------|----------| -| 🟢 | AbortMultipartUpload | | -| 🟢 | CompleteMultipartUpload | | -| 🟢 | CreateMultipartUpload | | -| 🟢 | ListMultipartUploads | | -| 🟢 | ListParts | | -| 🟢 | UploadPart | | -| 🟢 | UploadPartCopy | | +| | Method | Comments | +|-----|-------------------------|----------| +| 🟢 | AbortMultipartUpload | | +| 🟢 | CompleteMultipartUpload | | +| 🟢 | CreateMultipartUpload | | +| 🟢 | ListMultipartUploads | | +| 🟢 | ListParts | | +| 🟢 | UploadPart | | +| 🟢 | UploadPartCopy | | ## Tagging -| | Method | Comments | -|----|---------------------|----------| -| 🟢 | DeleteObjectTagging | | -| 🟢 | GetObjectTagging | | -| 🟢 | PutObjectTagging | | +| | Method | Comments | +|-----|---------------------|----------| +| 🟢 | DeleteObjectTagging | | +| 🟢 | GetObjectTagging | | +| 🟢 | PutObjectTagging | | ## Versioning See also `GetObject` and other method parameters. -| | Method | Comments | -|----|--------------------|--------------------------| -| 🟢 | ListObjectVersions | ListBucketObjectVersions | -| 🔵 | RestoreObject | | +| | Method | Comments | +|-----|--------------------|--------------------------| +| 🟢 | ListObjectVersions | ListBucketObjectVersions | +| 🔵 | RestoreObject | | ## Bucket -| | Method | Comments | -|----|----------------------|-----------| -| 🟢 | CreateBucket | PutBucket | -| 🟢 | DeleteBucket | | -| 🟢 | GetBucketLocation | | -| 🟢 | HeadBucket | | -| 🟢 | ListBuckets | | -| 🔵 | PutPublicAccessBlock | | +| | Method | Comments | +|-----|----------------------|-----------| +| 🟢 | CreateBucket | PutBucket | +| 🟢 | DeleteBucket | | +| 🟢 | GetBucketLocation | | +| 🟢 | HeadBucket | | +| 🟢 | ListBuckets | | +| 🔵 | PutPublicAccessBlock | | ## Acceleration -| | Method | Comments | -|----|----------------------------------|---------------------| -| 🔴 | GetBucketAccelerateConfiguration | GetBucketAccelerate | -| 🔴 | PutBucketAccelerateConfiguration | | +| | Method | Comments | +|-----|----------------------------------|---------------------| +| 🔴 | GetBucketAccelerateConfiguration | GetBucketAccelerate | +| 🔴 | PutBucketAccelerateConfiguration | | ## ACL -| | Method | Comments | -|----|--------------|---------------------| -| 🟡 | GetBucketAcl | See ACL limitations | -| 🟡 | PutBucketAcl | See ACL Limitations | +| | Method | Comments | +|-----|--------------|------------------------------| +| 🟡 | GetBucketAcl | Only canned acl is supported | +| 🟡 | PutBucketAcl | Only canned acl is supported | ## Analytics -| | Method | Comments | -|----|------------------------------------|----------| -| 🔵 | DeleteBucketAnalyticsConfiguration | | -| 🔵 | GetBucketAnalyticsConfiguration | | -| 🔵 | ListBucketAnalyticsConfigurations | | -| 🔵 | PutBucketAnalyticsConfiguration | | +| | Method | Comments | +|-----|------------------------------------|----------| +| 🔵 | DeleteBucketAnalyticsConfiguration | | +| 🔵 | GetBucketAnalyticsConfiguration | | +| 🔵 | ListBucketAnalyticsConfigurations | | +| 🔵 | PutBucketAnalyticsConfiguration | | ## CORS -| | Method | Comments | -|----|------------------|----------| -| 🟢 | DeleteBucketCors | | -| 🟢 | GetBucketCors | | -| 🟢 | PutBucketCors | | +| | Method | Comments | +|-----|------------------|----------| +| 🟢 | DeleteBucketCors | | +| 🟢 | GetBucketCors | | +| 🟢 | PutBucketCors | | ## Encryption -| | Method | Comments | -|----|------------------------|----------| -| 🔵 | DeleteBucketEncryption | | -| 🔵 | GetBucketEncryption | | -| 🔵 | PutBucketEncryption | | +| | Method | Comments | +|-----|------------------------|----------| +| 🔵 | DeleteBucketEncryption | | +| 🔵 | GetBucketEncryption | | +| 🔵 | PutBucketEncryption | | ## Inventory -| | Method | Comments | -|----|------------------------------------|----------| -| 🔵 | DeleteBucketInventoryConfiguration | | -| 🔵 | GetBucketInventoryConfiguration | | -| 🔵 | ListBucketInventoryConfigurations | | -| 🔵 | PutBucketInventoryConfiguration | | +| | Method | Comments | +|-----|------------------------------------|----------| +| 🔵 | DeleteBucketInventoryConfiguration | | +| 🔵 | GetBucketInventoryConfiguration | | +| 🔵 | ListBucketInventoryConfigurations | | +| 🔵 | PutBucketInventoryConfiguration | | ## Lifecycle -| | Method | Comments | -|----|---------------------------------|----------| -| 🔵 | DeleteBucketLifecycle | | -| 🔵 | GetBucketLifecycle | | -| 🔵 | GetBucketLifecycleConfiguration | | -| 🔵 | PutBucketLifecycle | | -| 🔵 | PutBucketLifecycleConfiguration | | +| | Method | Comments | +|-----|---------------------------------|----------| +| 🔵 | DeleteBucketLifecycle | | +| 🔵 | GetBucketLifecycle | | +| 🔵 | GetBucketLifecycleConfiguration | | +| 🔵 | PutBucketLifecycle | | +| 🔵 | PutBucketLifecycleConfiguration | | ## Logging -| | Method | Comments | -|----|------------------|----------| -| 🔵 | GetBucketLogging | | -| 🔵 | PutBucketLogging | | +| | Method | Comments | +|-----|------------------|----------| +| 🔵 | GetBucketLogging | | +| 🔵 | PutBucketLogging | | ## Metrics -| | Method | Comments | -|----|----------------------------------|----------| -| 🔵 | DeleteBucketMetricsConfiguration | | -| 🔵 | GetBucketMetricsConfiguration | | -| 🔵 | ListBucketMetricsConfigurations | | -| 🔵 | PutBucketMetricsConfiguration | | +| | Method | Comments | +|-----|----------------------------------|----------| +| 🔵 | DeleteBucketMetricsConfiguration | | +| 🔵 | GetBucketMetricsConfiguration | | +| 🔵 | ListBucketMetricsConfigurations | | +| 🔵 | PutBucketMetricsConfiguration | | ## Notifications -| | Method | Comments | -|----|------------------------------------|---------------| -| 🔵 | GetBucketNotification | | -| 🔵 | GetBucketNotificationConfiguration | | -| 🔵 | ListenBucketNotification | non-standard? | -| 🔵 | PutBucketNotification | | -| 🔵 | PutBucketNotificationConfiguration | | +| | Method | Comments | +|-----|------------------------------------|---------------| +| 🔵 | GetBucketNotification | | +| 🔵 | GetBucketNotificationConfiguration | | +| 🔵 | ListenBucketNotification | non-standard? | +| 🔵 | PutBucketNotification | | +| 🔵 | PutBucketNotificationConfiguration | | ## Ownership controls -| | Method | Comments | -|----|-------------------------------|----------| -| 🔵 | DeleteBucketOwnershipControls | | -| 🔵 | GetBucketOwnershipControls | | -| 🔵 | PutBucketOwnershipControls | | +| | Method | Comments | +|-----|-------------------------------|----------| +| 🔵 | DeleteBucketOwnershipControls | | +| 🔵 | GetBucketOwnershipControls | | +| 🔵 | PutBucketOwnershipControls | | ## Policy and replication -| | Method | Comments | -|----|-------------------------|-----------------------------| -| 🔵 | DeleteBucketPolicy | | -| 🔵 | DeleteBucketReplication | | -| 🔵 | DeletePublicAccessBlock | | -| 🟡 | GetBucketPolicy | See ACL limitations | -| 🔵 | GetBucketPolicyStatus | | -| 🔵 | GetBucketReplication | | -| 🟢 | PostPolicyBucket | Upload file using POST form | -| 🟡 | PutBucketPolicy | See ACL limitations | -| 🔵 | PutBucketReplication | | +| | Method | Comments | +|-----|-------------------------|------------------------------| +| 🟢 | DeleteBucketPolicy | | +| 🔵 | DeleteBucketReplication | | +| 🔵 | DeletePublicAccessBlock | | +| 🟢 | GetBucketPolicy | | +| 🔵 | GetBucketPolicyStatus | | +| 🔵 | GetBucketReplication | | +| 🟢 | PostPolicyBucket | Upload file using POST form | +| 🟡 | PutBucketPolicy | Conditions are not supported | +| 🔵 | PutBucketReplication | | ## Request payment -| | Method | Comments | -|----|-------------------------|----------| -| 🔴 | GetBucketRequestPayment | | -| 🔴 | PutBucketRequestPayment | | +| | Method | Comments | +|-----|-------------------------|----------| +| 🔴 | GetBucketRequestPayment | | +| 🔴 | PutBucketRequestPayment | | ## Tagging -| | Method | Comments | -|----|---------------------|----------| -| 🟢 | DeleteBucketTagging | | -| 🟢 | GetBucketTagging | | -| 🟢 | PutBucketTagging | | +| | Method | Comments | +|-----|---------------------|----------| +| 🟢 | DeleteBucketTagging | | +| 🟢 | GetBucketTagging | | +| 🟢 | PutBucketTagging | | ## Tiering -| | Method | Comments | -|----|---------------------------------------------|----------| -| 🔵 | DeleteBucketIntelligentTieringConfiguration | | -| 🔵 | GetBucketIntelligentTieringConfiguration | | -| 🔵 | ListBucketIntelligentTieringConfigurations | | -| 🔵 | PutBucketIntelligentTieringConfiguration | | +| | Method | Comments | +|-----|---------------------------------------------|----------| +| 🔵 | DeleteBucketIntelligentTieringConfiguration | | +| 🔵 | GetBucketIntelligentTieringConfiguration | | +| 🔵 | ListBucketIntelligentTieringConfigurations | | +| 🔵 | PutBucketIntelligentTieringConfiguration | | ## Versioning -| | Method | Comments | -|----|---------------------|----------| -| 🟢 | GetBucketVersioning | | -| 🟢 | PutBucketVersioning | | +| | Method | Comments | +|-----|---------------------|----------| +| 🟢 | GetBucketVersioning | | +| 🟢 | PutBucketVersioning | | ## Website -| | Method | Comments | -|----|---------------------|----------| -| 🔵 | DeleteBucketWebsite | | -| 🔵 | GetBucketWebsite | | -| 🔵 | PutBucketWebsite | | +| | Method | Comments | +|-----|---------------------|----------| +| 🔵 | DeleteBucketWebsite | | +| 🔵 | GetBucketWebsite | | +| 🔵 | PutBucketWebsite | |