Skip to content

Commit 60b8d49

Browse files
committed
Explain shadow listing behavior
1 parent df0d1a4 commit 60b8d49

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/migration/index.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,16 @@ 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+
<!-- prettier-ignore -->
45+
:::
46+
3747
## Enable Data Migration in the Tigris Dashboard
3848

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

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

97109
### Create Google Cloud Storage Access Keys for Migration
98110

0 commit comments

Comments
 (0)