s3fs

s3fs is a utility for Linux and macOS to mount Object Storage buckets via FUSE.

If you experience any issues with s3fs, check the official documentation of the project, in particular, the FAQ.

s3fs performance depends on the speed of your local disk. Use high-speed disks, especially if you store a lot of small files a few hundred kilobytes in size or smaller. You can increase s3fs performance by enabling caching (--use_cache <directory> parameter). The s3fs cache grows indefinitely, so you need to clear it at regular intervals. You can read more in the s3fs documentation.

Getting startedGetting started

1. Create a service account.

2. Assign to the service account the roles required for your project, e.g., storage.editor for a bucket (to work with a particular bucket) or a folder (to work with all buckets in this folder). For more information about roles, see Access management with Yandex Identity and Access Management.

   To work with objects in an encrypted bucket, a user or service account must have the following roles for the encryption key in addition to the storage.configurer role:

   • kms.keys.encrypter: To read the key, encrypt and upload objects.
   • kms.keys.decrypter: To read the key, decrypt and download objects.
   • kms.keys.encrypterDecrypter: This role includes the kms.keys.encrypter and kms.keys.decrypter permissions.

   For more information, see Key Management Service service roles.

3. Create a static access key.

   As a result, you will get the static access key data. To authenticate in Object Storage, you will need the following:

   • key_id: Static access key ID
   • secret: Secret key

   Save key_id and secret: you will not be able to get the key value again.

InstallationInstallation

To install s3fs, follow this guide in the project repository.

SetupSetup

To configure s3fs, save the previously obtained key ID and the secret key to the ~/.passwd-s3fs file in <key_ID>:<secret_key> format and restrict access to the ~/.passwd-s3fs file in the following way:

echo <key_ID>:<secret_key> > ~/.passwd-s3fs
chmod 600 ~/.passwd-s3fs

Mounting a bucketMounting a bucket

1. Select the folder where you want to mount your bucket and make sure you have permissions for this operation.

2. Run this command:

   s3fs <bucket_name> /mount/<folder_path> -o passwd_file=$HOME/.passwd-s3fs \
       -o url=https://storage.yandexcloud.net -o use_path_request_style
   

   To allow other PC users to access the folder, specify the -o allow_other option.

   To set access permissions to the folder you are going to mount the bucket to, specify the -o mp_umask=<required_permissions> option.

You can configure mounting a bucket when starting the system. To do this, open the /etc/fstab file and add a line in the following format:

s3fs#<bucket_name> /mount/<folder_path> fuse _netdev,allow_other,use_path_request_style,url=https://storage.yandexcloud.net,passwd_file=/home/<username>/.passwd-s3fs 0 0

For descriptions of all s3fs parameters, see the project's wiki page on GitHub.