-
Notifications
You must be signed in to change notification settings - Fork 37
S3 Implement Replication #689
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
blkgrlcto
wants to merge
5
commits into
main
Choose a base branch
from
doc-259-doc-s3-implement-s3-replication-emulation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+43
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a64de31
docs(s3): add S3 Replication documentation
blkgrlcto b6d1b9b
docs(s3): add metadata replication support to S3 Replication section
blkgrlcto ef589a8
docs(s3): add IAM enforcement documentation to S3 Replication section
blkgrlcto 765ce98
Apply suggestion from @bentsku
blkgrlcto 104d813
Update s3.mdx
blkgrlcto File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -260,6 +260,49 @@ LocalStack supports SSE-C parameter validation for the following S3 APIs: | |
|
|
||
| However, LocalStack does not support the actual encryption and decryption of objects using SSE-C. | ||
|
|
||
| ## S3 Replication | ||
|
|
||
| S3 Replication allows you to automatically copy objects from a source bucket to one or more destination buckets. | ||
| Replication can occur within the same region or across regions, and across different accounts. | ||
|
|
||
| LocalStack supports the following replication configurations: | ||
|
|
||
| - **One-way replication**: Objects are replicated from a source bucket to a destination bucket. You can scope replication using prefix-based or tag-based filtering, and optionally override the storage class for objects written to the destination bucket. | ||
| - **Two-way replication**: Both buckets are configured as source and destination for each other, and replication is configured to work in both directions. | ||
|
|
||
| ### IAM enforcement | ||
|
|
||
| LocalStack supports IAM enforcement for S3 replication. | ||
| IAM permissions are evaluated in the context of each replication task using the IAM engine directly, which mirrors how AWS itself handles replication permissions. | ||
|
|
||
| ### Metadata replication | ||
|
|
||
| LocalStack supports replication of object metadata — specifically tags and Object Lock settings. Metadata replication operates in two modes: | ||
| LocalStack supports replication of object metadata, specifically tags and Object Lock settings. Metadata replication operates in two modes: | ||
|
Comment on lines
+280
to
+281
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. note: there are 2 duplicate lines here |
||
|
|
||
| - **Default metadata replication**: When a source object's metadata is modified, those changes are automatically propagated to all of its replicas. This behavior is enabled by default and requires no additional configuration. | ||
| - **Replica metadata synchronization**: When enabled on the destination bucket, metadata changes made directly to a replica are synced back to the source object. This applies only when two-way replication is configured. See [Replication for metadata changes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-for-metadata-changes.html) in the AWS documentation for more details. | ||
|
|
||
| ### ReplicationStatus | ||
|
|
||
| Replicated objects are assigned a `ReplicationStatus` field, which you can inspect with `GetObject` or `HeadObject`. | ||
| The possible values follow AWS semantics: | ||
|
|
||
| | Status | Meaning | | ||
| |---|---| | ||
| | `PENDING` | Replication has been queued but not yet completed | | ||
| | `COMPLETED` | Object was successfully replicated to the destination | | ||
| | `FAILED` | Replication could not be completed | | ||
| | `REPLICA` | This object is itself a copy created by replication | | ||
|
|
||
| :::note | ||
| The following replication features are not yet supported in LocalStack and will be available in a future release: | ||
|
|
||
| - **`s3:ReplicateTags` deny evaluation**: Explicitly denying `s3:ReplicateTags` will not cause replication to be denied if the object has tags. | ||
| - **KMS-encrypted object replication**: Objects encrypted with customer-provided KMS keys are not replicated, even when replication of KMS-encrypted objects is explicitly configured. See [Replicating objects created with server-side encryption using AWS KMS keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-config-for-kms-objects.html#replications) in the AWS documentation for more details. | ||
| - **ACL replication**: Replication of Access Control Lists is not currently supported. | ||
| ::: | ||
|
|
||
| ## Resource Browser | ||
|
|
||
| The LocalStack Web Application provides a [Resource Browser](/aws/connecting/console/resource-browser) for managing S3 buckets & configurations. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.