Storage-Users
Purpose and description to be added
CLI Commands
Manage Unfinished Uploads
When using Infinite Scale as user storage, a directory named storage/users/uploads can be found in the Infinite Scale data folder. This is an intermediate directory based on TUS which is an open protocol for resumable uploads. Each upload consists of a blob and a blob.info file. Note that the term blob is just a placeholder.
-
If an upload succeeds, the blob file will be moved to the target and the blob.info file will be deleted.
-
In case of incomplete uploads, the blob and blob.info files will continue to receive data until either the upload succeeds in time or the upload expires based on the
STORAGE_USERS_UPLOAD_EXPIRATIONvariable, see the table below for details. -
In case of expired uploads, the blob and blob.info files will not be removed automatically. Thus a lot of data can pile up over time wasting storage space.
-
In the rare case of a failure, after the upload succeeded but the file was not moved to its target location, which can happen when postprocessing fails, the situation is the same as with expired uploads.
Example cases for expired uploads
- When a user uploads a big file but the file exceeds the user-quota, the upload can't be moved to the target after it has finished. The file stays at the upload location until it is manually cleared.
- If the bandwidth is limited and the file to transfer can't be transferred completely before the upload expiration time is reached, the file expires and can't be processed.
There are two commands available to manage unfinished uploads
ocis storage-users uploads <command>
COMMANDS:
list Print a list of all incomplete uploads
clean Clean up leftovers from expired uploads
Command Examples
Command to identify incomplete uploads
ocis storage-users uploads list
Incomplete uploads:
- 455bd640-cd08-46e8-a5a0-9304908bd40a (file_example_PPT_1MB.ppt, Size: 1028608, Expires: 2022-08-17T12:35:34+02:00)
Command to clear expired uploads
ocis storage-users uploads clean
Cleaned uploads:
- 455bd640-cd08-46e8-a5a0-9304908bd40a (Filename: file_example_PPT_1MB.ppt, Size: 1028608, Expires: 2022-08-17T12:35:34+02:00)
Purge Expired Space Trash-Bins Items
This command is about purging old trash-bin items of project spaces (spaces that have been created manually) and personal spaces.
ocis storage-users trash-bin <command>
COMMANDS:
purge-expired Purge all expired items from the trashbin
The configuration for the purge-expired command is done by using the following environment variables.
-
STORAGE_USERS_PURGE_TRASH_BIN_USER_IDis used to obtain space trash-bin information and takes the system admin user as the default which is theOCIS_ADMIN_USER_IDbut can be set individually. It should be noted, that theOCIS_ADMIN_USER_IDis only assigned automatically when using the single binary deployment and must be manually assigned in all other deployments. The command only considers spaces to which the assigned user has access and delete permission. -
STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFOREhas a default value of30 days, which means the command will delete all files older than30 days. The value is human-readable, valid values are24h,60m,60setc.0is equivalent to disable and prevents the deletion ofpersonal spacetrash-bin files. -
STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFOREhas a default value of30 days, which means the command will delete all files older than30 days. The value is human-readable, valid values are24h,60m,60setc.0is equivalent to disable and prevents the deletion ofproject spacetrash-bin files.
Caching
The storage-users service caches file metadata via the configured store in STORAGE_USERS_CACHE_STORE. Possible stores are:
memory: Basic in-memory store and the default.redis: Stores metadata in a configured Redis cluster.redis-sentinel: Stores metadata in a configured Redis Sentinel cluster.etcd: Stores metadata in a configured etcd cluster.nats-js: Stores metadata using the key-value-store feature of nats jetstreamnoop: Stores nothing. Useful for testing. Not recommended in productive enviroments.
- Note that in-memory stores are by nature not reboot persistent.
- Though usually not necessary, a database name can be configured for event stores if the event store supports this. Generally not applicapable for stores of type
in-memory,redisandredis-sentinel. These settings are blank by default which means that the standard settings of the configured store applies. - The
storage-usersservice can be scaled if not usingin-memorystores and the stores are configured identically over all instances. - When using
redis-sentinel, the Redis master to use is configured viaSTORAGE_SYSTEM_CACHE_NODESin the form of<sentinel-host>:<sentinel-port>/<redis-master>like10.10.0.200:26379/mymaster.