MinIOVFS mounts one bucket on a self-hosted MinIO server: every object becomes
a file and every / in a key a folder. It reaches MinIO through its S3 API.
Set up credentials as in MinIO setup.
Install
Configure
endpoint_url is required, since the server is self-hosted. region defaults
to us-east-1. A mount takes MountMode.READ, WRITE or EXEC.
Fields
Seconds a request may wait to connect, or between two reads of its answer, before it fails; a download that keeps flowing is never cut off.
Region requests are signed for; the gateway’s endpoint does not depend on it.
Named profile in the shared AWS config and credentials files that supplies credentials when no access key pair is given.
Address the bucket in the URL path (
<endpoint>/<bucket>/<key>) instead of as a subdomain of the endpoint.Key prefix inside the bucket that the mount treats as its root; keys outside it are not visible. Leading slashes are dropped and a trailing
/ is added.Authentication
Credentials come from the first of:access_key_idandsecret_access_key, a MinIO access key, withsession_tokenfor temporary credentials.aws_profile, a profile in~/.aws/credentials.- The AWS credential chain: environment variables, then the instance or container role.
readonly to read, readwrite to write.
A request the credentials may not make answers Permission denied.
Layout
/minio/data/file.txt is the key data/file.txt. Folders come from the / in
keys; MinIO stores no folder objects.
Behavior
- Key prefix:
key_prefix="users/42/"mounts only that part of the bucket, so/minio/notes.mdis the keyusers/42/notes.md. - Conditional writes: MinIO ignores copy and delete conditions, so under
write: conditionalMirage refuses acpormvwithin the mount, amvout of it,rmandfind -delete(ENOTSUP); acpormvinto it from another mount is a write and goes through. See S3-compatible VFSes.
Integration
MinIO answers these commands through its own API, so fewer objects are read. See Integration.md5sum: the object’s ETag, when it is the MD5 (a single-part upload, unencrypted or under SSE-S3).find: one recursive listing.du: one recursive listing.ls -Randtree: one recursive listing.
VFS.md
The VFS.md an agent reads with MinIO mounted at/<path>.
<mode> is the mount’s mode: read, write or exec. The commands shown are
those of a write mount.
- Rendered
- Raw
Virtual Filesystem
Supported Unix Commands for VFSUnix commands work on each path as on a local filesystem, as far as the path supports them:
Limitations of Unix Commands for VFSWhere a path differs from a local filesystem:
Run
man <cmd> or <cmd> --help for one command’s usage.