garage/doc/book/src/reference_manual/s3_compatibility.md
Alex Auvolat 8f39360f22
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
Update documentation
2022-01-07 17:14:37 +01:00

2.7 KiB

S3 Compatibility status

Global S3 features

Implemented:

  • path-style URLs (garage.tld/bucket/key)
  • vhost-style URLs (bucket.garage.tld/key)
  • putting and getting objects in buckets
  • multipart uploads
  • listing objects
  • access control on a per-key-per-bucket basis

Not implemented:

Endpoint implementation

All APIs that are not mentionned are not implemented and will return a 400 bad request.

Endpoint Status
AbortMultipartUpload Implemented
CompleteMultipartUpload Implemented
CopyObject Implemented
CreateBucket Implemented
CreateMultipartUpload Implemented
DeleteBucket Implemented
DeleteBucketWebsite Implemented
DeleteObject Implemented
DeleteObjects Implemented
GetBucketLocation Implemented
GetBucketVersioning Stub (see below)
GetBucketWebsite Unsupported
GetObject Implemented
HeadBucket Implemented
HeadObject Implemented
ListBuckets Implemented
ListObjects Implemented, bugs? (see below)
ListObjectsV2 Implemented
PutObject Implemented
PutBucketWebsite Partially implemented (see below)
UploadPart Implemented
  • GetBucketVersioning: Stub implementation (Garage does not yet support versionning so this always returns "versionning not enabled").

  • ListObjects: Implemented, but there isn't a very good specification of what encoding-type=url covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.

  • PutBucketWebsite: Implemented, but only store if website is enabled, not more complexe informations.

  • GetBucketWebsite: Not implemented yet, will be when PubBucketWebsite store more informations.