Add note on S3 replication #3507
Merged
Conversation
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
It's not clear from these docs that S3 object replication doesn't work reliably. This commit spells this out and explains why.
eedugon
reviewed
Oct 16, 2025
| Unfortunately this replication is not compatible with {{es}} snapshots. | ||
| The objects that {{es}} writes to the repository refer to other objects which already exist in the repository, and {{es}} only deletes an object from the repository after it becomes unreferenced by all other objects. | ||
| AWS S3 replication will apply operations to the replica repository in a different order from the order in which {{es}} applies them to the primary repository, and this may leave the replica repository in an invalid state, with objects referring to other objects that do not exist. | ||
| To replicate a repository's contents elsewhere you must follow the [repository backup](snapshot-and-restore/self-managed.md#snapshots-repository-backup) process. |
There was a problem hiding this comment.
Suggested change
| To replicate a repository's contents elsewhere you must follow the [repository backup](snapshot-and-restore/self-managed.md#snapshots-repository-backup) process. | |
| To replicate a repository's contents elsewhere, follow the [repository backup](/deploy-manage/tools/snapshot-and-restore/self-managed.md#snapshots-repository-backup) process. |
There was a problem hiding this comment.
The previous should fix the link that is making the build to fail.
Comment on lines
382
to
383
| AWS S3 supports [replication of objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html), both within a single region and across regions. | ||
| Unfortunately this replication is not compatible with {{es}} snapshots. |
There was a problem hiding this comment.
The original proposal is going to place the 5 lines in the same paragraph, i'm going to propose to divide the content in 3 different paragraphs.
Suggested change
| AWS S3 supports [replication of objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html), both within a single region and across regions. | |
| Unfortunately this replication is not compatible with {{es}} snapshots. | |
| AWS S3 supports [replication of objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html), both within a single region and across regions. However, this replication mechanism is not compatible with {{es}} snapshots. | |
| AWS S3 supports [replication of objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html), both within a single region and across regions. | ||
| Unfortunately this replication is not compatible with {{es}} snapshots. | ||
| The objects that {{es}} writes to the repository refer to other objects which already exist in the repository, and {{es}} only deletes an object from the repository after it becomes unreferenced by all other objects. | ||
| AWS S3 replication will apply operations to the replica repository in a different order from the order in which {{es}} applies them to the primary repository, and this may leave the replica repository in an invalid state, with objects referring to other objects that do not exist. |
There was a problem hiding this comment.
Suggested change
| AWS S3 replication will apply operations to the replica repository in a different order from the order in which {{es}} applies them to the primary repository, and this may leave the replica repository in an invalid state, with objects referring to other objects that do not exist. | |
| Because AWS S3 replication can apply operations to the replica repository in a different order than {{es}} applies them to the primary repository, the replica repository can become invalid, with objects referring to others that do not exist. | |
|
removing myself as a reviewer since @eedugon looked at this. @DaveCTurner no need to request one of us directly (my colleagues are usually a little faster with reviews than I am 😅) |
|
Thanks Edu, good call on splitting up into multiple paragraphs. I expanded the middle paragraph a little and made some of the changes you suggested. |
🔍 Preview links for changed docs |
eedugon
approved these changes
Oct 20, 2025
Co-authored-by: Edu González de la Herrán <[email protected]>
rhr323
pushed a commit
to rhr323/docs-content
that referenced
this pull request
Oct 27, 2025
It's not clear from these docs that S3 object replication doesn't work reliably. This commit spells this out and explains why. Co-authored-by: Edu González de la Herrán <[email protected]>
DaveCTurner
added a commit
to DaveCTurner/elastic-docs-content
that referenced
this pull request
Oct 28, 2025
naemono
pushed a commit
to naemono/docs-content
that referenced
this pull request
Oct 28, 2025
It's not clear from these docs that S3 object replication doesn't work reliably. This commit spells this out and explains why. Co-authored-by: Edu González de la Herrán <[email protected]>
DaveCTurner
added a commit
that referenced
this pull request
Oct 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
It's not clear from these docs that S3 object replication doesn't work
reliably. This commit spells this out and explains why.