diff options
author | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
---|---|---|
committer | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
commit | 1c0ba930b8d6aa5d97e6942852240861e6ab9bed (patch) | |
tree | cddc9af5fc2378c76fe5ef6306f807e27648b7a7 /doc/book/working-documents/compatibility-target.md | |
parent | 45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff) | |
download | garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.tar.gz garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.zip |
Reorganize documentation for new website (#213)
This PR should be merged after the new website is deployed.
- [x] Rename files
- [x] Add front matter section to all `.md` files in the book (necessary for Zola)
- [x] Change all internal links to use Zola's linking system that checks broken links
- [x] Some updates to documentation contents and organization
Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
Diffstat (limited to 'doc/book/working-documents/compatibility-target.md')
-rw-r--r-- | doc/book/working-documents/compatibility-target.md | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/doc/book/working-documents/compatibility-target.md b/doc/book/working-documents/compatibility-target.md new file mode 100644 index 00000000..836f3e30 --- /dev/null +++ b/doc/book/working-documents/compatibility-target.md @@ -0,0 +1,108 @@ ++++ +title = "S3 compatibility target" +weight = 5 ++++ + +If there is a specific S3 functionnality you have a need for, feel free to open +a PR to put the corresponding endpoints higher in the list. Please explain +your motivations for doing so in the PR message. + +| Priority | Endpoints | +| -------------------------- | --------- | +| **S-tier** (high priority) | | +| | HeadBucket | +| | GetBucketLocation | +| | CreateBucket | +| | DeleteBucket | +| | ListBuckets | +| | ListObjects | +| | ListObjectsV2 | +| | HeadObject | +| | GetObject | +| | PutObject | +| | CopyObject | +| | DeleteObject | +| | DeleteObjects | +| | CreateMultipartUpload | +| | CompleteMultipartUpload | +| | AbortMultipartUpload | +| | UploadPart | +| | [*ListMultipartUploads*](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/103) | +| | [*ListParts*](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/103) | +| **A-tier** | | +| | GetBucketCors | +| | PutBucketCors | +| | DeleteBucketCors | +| | UploadPartCopy | +| | GetBucketWebsite | +| | PutBucketWebsite | +| | DeleteBucketWebsite | +| ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | +| **B-tier** | | +| | GetBucketAcl | +| | PutBucketAcl | +| | GetObjectLockConfiguration | +| | PutObjectLockConfiguration | +| | GetObjectRetention | +| | PutObjectRetention | +| | GetObjectLegalHold | +| | PutObjectLegalHold | +| **C-tier** | | +| | GetBucketVersioning | +| | PutBucketVersioning | +| | ListObjectVersions | +| | GetObjectAcl | +| | PutObjectAcl | +| | GetBucketLifecycleConfiguration | +| | PutBucketLifecycleConfiguration | +| | DeleteBucketLifecycle | +| **garbage-tier** | | +| | DeleteBucketEncryption | +| | DeleteBucketAnalyticsConfiguration | +| | DeleteBucketIntelligentTieringConfiguration | +| | DeleteBucketInventoryConfiguration | +| | DeleteBucketMetricsConfiguration | +| | DeleteBucketOwnershipControls | +| | DeleteBucketPolicy | +| | DeleteBucketReplication | +| | DeleteBucketTagging | +| | DeleteObjectTagging | +| | DeletePublicAccessBlock | +| | GetBucketAccelerateConfiguration | +| | GetBucketAnalyticsConfiguration | +| | GetBucketEncryption | +| | GetBucketIntelligentTieringConfiguration | +| | GetBucketInventoryConfiguration | +| | GetBucketLogging | +| | GetBucketMetricsConfiguration | +| | GetBucketNotificationConfiguration | +| | GetBucketOwnershipControls | +| | GetBucketPolicy | +| | GetBucketPolicyStatus | +| | GetBucketReplication | +| | GetBucketRequestPayment | +| | GetBucketTagging | +| | GetObjectTagging | +| | GetObjectTorrent | +| | GetPublicAccessBlock | +| | ListBucketAnalyticsConfigurations | +| | ListBucketIntelligentTieringConfigurations | +| | ListBucketInventoryConfigurations | +| | ListBucketMetricsConfigurations | +| | PutBucketAccelerateConfiguration | +| | PutBucketAnalyticsConfiguration | +| | PutBucketEncryption | +| | PutBucketIntelligentTieringConfiguration | +| | PutBucketInventoryConfiguration | +| | PutBucketLogging | +| | PutBucketMetricsConfiguration | +| | PutBucketNotificationConfiguration | +| | PutBucketOwnershipControls | +| | PutBucketPolicy | +| | PutBucketReplication | +| | PutBucketRequestPayment | +| | PutBucketTagging | +| | PutObjectTagging | +| | PutPublicAccessBlock | +| | RestoreObject | +| | SelectObjectContent | |