Skip to content

Commit 889e3fa

Browse files
committed
Explain shadow listing behavior
1 parent df0d1a4 commit 889e3fa

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/migration/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,18 @@ Here’s how Tigris handles data migration under the hood:
3434
- When an object is deleted, it’s removed from both the Tigris and shadow
3535
buckets.
3636

37+
<!-- prettier-ignore -->
38+
:::note
39+
Object listing behavior depends on whether write-through mode is
40+
enabled. When write-through is enabled, the list API returns the full contents
41+
of the shadow bucket. When write-through is disabled, the list API only includes
42+
objects that have already been migrated into Tigris; objects that exist solely
43+
in the shadow bucket are not listed until they are accessed and migrated.
44+
45+
<!-- prettier-ignore -->
46+
47+
:::
48+
3749
## Enable Data Migration in the Tigris Dashboard
3850

3951
To enable data migration from a S3-Compatible bucket:
@@ -91,8 +103,10 @@ permissions to access your S3 bucket:
91103
- If you're using an existing user, go to the `Security credentials` tab and
92104
click `Create access key` under the `Access keys` section.
93105

94-
Make sure the access keys you generate have permissions to list, read, write,
95-
and delete objects in the relevant S3 bucket.
106+
Make sure the access keys you generate have permissions to list and read objects
107+
in the relevant S3 bucket. Additionally, if migration is configured in
108+
write-through mode, the keys should have permissions to write and delete
109+
objects.
96110

97111
### Create Google Cloud Storage Access Keys for Migration
98112

0 commit comments

Comments
 (0)