Skip to content

Commit 9d9624f

Browse files
committed
WIP update docs
1 parent cabb72a commit 9d9624f

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

TAGGING.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@ Tagging allows extra metadata about your files to be send to the external object
44
Currently, this is only implemented for the S3 file system client. [See the S3 docs for more information](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html).
55

66
**Tagging vs metadata**
7+
78
Note object tags are different from object metadata.
89

910
Object metadata is immutable, and attached to the object on upload. With metadata, if you wish to update it (for example during a migration, or the sources changed), you have to copy the object with the new metadata, and delete the old object. This is problematic, since deletion is optional in objectfs.
1011

1112
Object tags are more suitable, since their permissions can be managed separately (e.g. a client can be allowed to modify tags, but not delete objects).
1213

14+
## File system setup
15+
### S3
16+
You must grant `s3:GetObjectTagging` and `s3:PutObjectTagging` permission.
17+
1318
## Sources
1419
The following sources are implemented currently:
1520
### Environment
@@ -22,7 +27,7 @@ What mimetype the file is stored as under the `mdl_files` table.
2227
It is possible you are using objectfs with multiple environments (e.g. prod, staging) that both point to the same bucket. Since files are referenced by contenthash, it generally does not matter where they come from s
2328
If this is the case, for tagging to work as expected, you must ensure object override is turned off for every environment except production.
2429

25-
This means that staging is unable to overwrite objects (thus overwriting tags) for files uploaded elsewhere. However, files uploaded elsewhere can be overwitten (hence overwriting tags) by production. This allows
30+
This means that staging is unable to overwrite objects (thus overwriting tags) for files uploaded elsewhere. However, files uploaded elsewhere can be overwitten (hence overwriting tags) by production.
2631

2732
See this diagram for a visual explanation:
2833

@@ -47,13 +52,13 @@ graph LR
4752
UploadObjectStaging --- Blocked
4853
Blocked -.-> Object
4954
50-
style Object fill:#ffcd75,stroke:#ffa812
51-
style S3 fill:#ffd68f,stroke:#ffa812
52-
style Prod fill:#c2ffcc,stroke:#26ff4a
53-
style UploadObjectProd fill:#c2ffcc,stroke:#26ff4a
54-
style Staging fill:#ddd9ff,stroke:#978aff
55-
style UploadObjectStaging fill:#ddd9ff,stroke:#978aff
56-
style Blocked fill:#ff6161,stroke:#ff0000
55+
style Object fill:#ffffff00,stroke:#ffa812
56+
style S3 fill:#ffffff00,stroke:#ffa812
57+
style Prod fill:#ffffff00,stroke:#26ff4a
58+
style UploadObjectProd fill:#ffffff00,stroke:#26ff4a
59+
style Staging fill:#ffffff00,stroke:#978aff
60+
style UploadObjectStaging fill:#ffffff00,stroke:#978aff
61+
style Blocked fill:#ffffff00,stroke:#ff0000
5762
```
5863

5964
## Reporting

0 commit comments

Comments
 (0)