Object Lock (Technical Preview)

Technical Preview Service Release

S3 Compatible Object Lock is in early development with restricted availability to invited customers for the purpose of testing or validating compatibility. Please refer to our Terms of Service for more information on release definitions.

Summary

Overview

Storj is currently developing S3 Compatible Object Lock. As part of that development, we have an early Technical Preview Service Release that can be used to test compatibility. Note that any testing will not be representative of real-world performance, and there is no value in testing anything outside the correctness of the implementation.

FAQ

  • When will Object Lock be in Beta? When will it be fully released?
    • We expect to begin an open beta of Object Lock in Q3 of calendar year 2024.
    • We tentatively plan to add Governance Mode and Legal Hold to the beta in Q3 of calendar year 2024, with the goal of rolling out Object Lock fully by the end of calendar year 2024.
  • Why would I test this Technical Preview?
    • We used this particular Technical Preview to do our own validation against key tools that implement S3's Object Lock, for example, Veeam.
    • If your product or an integration uses Object Lock, you can use this Technical Preview to validate compatibility before we get into Beta.
  • How do I test the Technical Preview?
    • We are only opening testing to select customers and partners. Feel free to indicate your interest in the upcoming beta by filling out the form below.
  • How do I sign up to join the Beta when it arrives?
    • Fill out this form to be the first to know when the beta is arriving: Sign Up Form
  • Why doesn't the initial version support Governance Mode and Legal Hold?
    • Our initial goal is to implement the most common S3 features regarding immutability and deliver them as quickly as possible, which led us to focus on the strictest form of object lock: Compliance Mode.
  • How do I give feedback or request features related to Object Lock?

Instructions

  1. Register on https://satellite.qa.storj.io
    1. This satellite is separate from our production satellites, so you will need to create a new account. You may use the same email you use on US1, EU1 or AP1.
  2. Generate S3-compatible credentials
  3. Use https://gateway.staging.storjshare.io with generated credentials:
    1. The Object Lock alpha implementation is enabled only using this specific endpoint.

Technical Details

New S3 Actions Supported:

ActionAPI DescriptionDescription of Change(s)
GetObjectLockConfigurationGets the object lock configuration for a bucket.Will return the ObjectLockConfiguration with ObjectLockEnabled either as Enabled or empty. Rule will not be included as a response element as specifying a bucket-level object Lock rule is initially out of scope.
PutObjectRetentionPlaces an object retention configuration on an object.<br>The only value supported for Mode is COMPLIANCE as Governance Mode is initially out of scope.
GetObjectRetentionRetrieves an object's retention settings.

Existing S3 Actions Updated

MethodAPI DescriptionDescription of Change(s)
CreateBucketCreates a new bucket.CreateBucket will now accept the following request parameter:<br>- x-amz-bucket-object-lock-enabled
HeadObjectRetrieves metadata from an object without returning the object itself.HeadObject will now return:<br>- Mode (only Compliance is supported initially) that is currently in place for the requested object<br>- Date/time that the object's lock will expire
GetObjectRetrieves an object from a bucket.GetObject will now return:<br>- Mode (only Compliance is supported initially) that is currently in place for the requested object<br>- Date/time that the object's lock will expire
PutObjectAdds an object to a bucket.PutObject will now:<br> - Prevent locked object versions from being overwritten<br><br>PutObject will now accept the following request parameters:<br>- x-amz-object-lock-mode (only Compliance is supported initially) <br>- x-amz-object-lock-retain-until-date
CopyObjectCreates a copy of an object that is already stored on Storj.CopyObject will now accept the following request parameters:<br>- x-amz-object-lock-mode (only Compliance is supported initially) <br>- x-amz-object-lock-retain-until-date
CreateMultipartUploadThis action initiates a multipart upload and returns an upload ID.CreateMultipartUpload will now accept the following request parameters:<br>- x-amz-object-lock-mode (only Compliance is supported initially) <br>- x-amz-object-lock-retain-until-date<br><br>Storj has a unique object level TTL. Any request that has both a TTL and a retention period will be rejected to prevent TTL's from conflicting with object lock retention periods.
DeleteBucketDeletes the specified bucket.Forced deletion of a bucket with locked objects will be prevented.
DeleteObjectRemoves an object from a bucket.Deletion of an object with a retention set will be prevented.

In addition to the new and updated actions supported above, we have a follow on roadmap item to implement the remaining scope of S3 Compatible Lock, mainly the addition of Governance Mode and Legal hold. These additional actions are outlined in the roadmap item here: https://github.com/storj/roadmap/issues/98

Previous
Multipart Part Size