Skip to content

Commit 2cb905f

Browse files
committed
Explain shadow listing behavior
1 parent df0d1a4 commit 2cb905f

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/migration/index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ 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+
:::note Object listing behavior depends on whether write-through mode is
38+
enabled. When write-through is enabled, the list API returns the full contents
39+
of the shadow bucket. When write-through is disabled, the list API only includes
40+
objects that have already been migrated into Tigris; objects that exist solely
41+
in the shadow bucket are not listed until they are accessed and migrated. :::
42+
3743
## Enable Data Migration in the Tigris Dashboard
3844

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

94-
Make sure the access keys you generate have permissions to list, read, write,
95-
and delete objects in the relevant S3 bucket.
100+
Make sure the access keys you generate have permissions to list and read objects
101+
in the relevant S3 bucket. Additionally, if migration is configured in
102+
write-through mode, the keys should have permissions to write and delete
103+
objects.
96104

97105
### Create Google Cloud Storage Access Keys for Migration
98106

0 commit comments

Comments
 (0)