使用說明

zosfs是一個輕量化工具，無需安裝直接執行操作命令即可，以下說明介紹掛載bucket、卸載已掛載bucket等操作。

使用限制

zosfs為特定掛載場景優化，因此存在一定的使用限制，請使用前仔細閱讀zosfs使用限制章節，了解工具的限制條件。

注意
我們建議您在使用zosfs工具前，了解工具的使用限制，并對工具進行使用測試，避免對您的業務產生影響。

掛載bucket

1.創建 ~/.aws/credentials 文件，內容如下，需填入AccessKey與SecretKey。

[default] 
aws_access_key_id = <your-accesskey>
aws_secret_access_key = <your-secretkey>

2.通過zosfs將您的ZOS bucket掛載到指定目錄。

zosfs --profile {aksk_group_name} --log-file {logfile_path} --endpoint {endpoint} {bucket_name} {mount_point}

{aksk_group_name}: ~/.aws/credentials中所使用的aksk組名，默認為default
{logfile_path}: 日志文件的保存路徑
{endpoint}: 服務端點地址
{bucket_name}: 如果掛載桶，則為“存儲桶名稱”；如果掛載桶下某目錄，則為“存儲桶名稱:/桶內目錄路徑”
{mount_point}: 掛載點

示例：
zosfs --profile default --log-file /var/log/zosfs.log --endpoint //127.0.0.1:8081/ my-bucket /mnt/my-mount-point
zosfs --profile default --log-file /var/log/zosfs.log --endpoint //127.0.0.1:8081/ my-bucket:/mydir /mnt/my-mount-point

卸載已掛載bucket

1.卸載 zosfs，可以使用以下命令，若由于device busy卸載失敗，建議稍后重試，避免數據丟失。

umount {mount_point}

2.執行以下命令可以強制卸載掛載目錄。

umount -l {mount_point}

參數說明

S3參數

--endpoint
默認值：無
用途：s3的endpoint，可能值為//127.0.0.1:8081/

--storage-class
默認值：STANDARD
用途：存儲類型
合法值：STANDARD，STANDARD_IA

--profile
默認值：無
用途：使用$HOME/.aws/credentials中的命名配置文件，而不是“default”
合法值：$HOME/.aws/credentials配置文件中寫明的aksk組名

--shared-config
默認值：無
用途：使用不同的共享配置文件，而不是$HOME/.aws/credentials和$HOME/.aws/config

--use-content-type
默認值：false
用途：根據文件擴展名和/etc/mime.types設置內容類型，默認關閉

--no-checksum
默認值：false
用途：禁用內容的MD5和SHA256校驗和

--acl
默認值：""
用途：要應用于對象的ACL。
合法值："private"，"public-read"，"public-read-write"，"authenticated-read"，""

--subdomain
默認值：false
用途：啟用S3的子域模式

--skip-cert-verify
默認值：false
用途：控制客戶端是否驗證服務器的證書鏈和主機名

Tuning常用參數

--memory-limit
默認值：1000
用途：用于數據緩存的最大內存（MB）
合法值：大于等于128的整數

--entry-limit
默認值：100000
用途：內存中緩存的最大元數據條目數（1個條目使用約1KB的內存）
合法值：大于等于10000的整數

--gc-interval
默認值：250
用途：在此數量的數據buffer被分配后強制執行垃圾回收
合法值：非負整數

--single-part
默認值：5
用途：單文件上傳的最大大小（MB），如果超過該值則分段上傳，不能少于5MB
合法值：5~5120的整數

--part-sizes
默認值："5:1000,25:1000,125"
用途：分片的大小（MB），s3的總分片數為10000，默認為1000個5MB，1000個25MB，剩余為125MB

--disable-xattr
默認值：false
用途：禁用擴展屬性

--stat-cache-ttl
默認值：time.Minute
用途：緩存文件元數據的時間

Tuning高級參數

說明
以下Tuning高級參數不建議您隨意調整，若業務確有需要，請仔細閱讀參數說明，避免影響性能。

讀取預加載相關參數
--read-ahead
默認值：5120
用途：默認情況下，每次讀請求預加載的數據大小（KB）
合法值：非負整數

--small-read-count
默認值：4
用途：判斷單個文件句柄內讀取是否隨機，需要檢查的最后若干次讀取請求的數量
合法值：非負整數

--small-read-cutoff
默認值：128
用途：觸發小規模預加載的最后若干次讀取請求的最大平均大小（KB）
合法值：非負整數

--read-ahead-small
默認值：128
用途：當檢測到小的隨機讀請求時，每次讀請求預加載的小規模數據大小（KB）
合法值：非負整數

--large-read-cutoff
默認值：20480
用途：觸發大規模預加載的連續讀取請求的大小（KB）
合法值：非負整數

--read-ahead-large
默認值：102400
用途：當檢測到長的線性讀請求時，每次讀請求預加載的大規模數據大小（KB）
合法值：非負整數

--read-ahead-parallel
默認值：20480
用途：觸發大規模預加載后，單個大規模讀請求被拆分得到的并行讀請求數據大小（KB）
合法值：非負整數

--read-merge
默認值：512
用途：兩次讀請求被合并為一個讀請求所需要滿足的最大間距大小（KB）
合法值：非負整數

注意
為了提升讀取性能，讀取預加載數據大小被分為三檔，需要嚴格滿足：read-ahead-small < read-ahead < read-ahead-large

File system

--o
默認值：無
用途：系統額外的掛載選項

--dir-mode 
默認值：0755
用途：目錄的權限

--file-mode
默認值：0644
用途：文件的權限 

--uid
默認值：當前用戶uid
用途：所有inode的uid 

--gid   
默認值：當前用戶gid
用途：所有inode的gid 

--setuid
默認值：當前用戶uid
用途：放棄當前root權限，設置成uid 

--setgid
默認值：當前用戶gid
用途：放棄當前root組，設置成gid 

Debug

--debug
默認值：false
用途：允許通用的debug輸出


--debug_fuse
默認值：false
用途：允許fuse相關的debug輸出


--debug_s3
默認值：false
用途：允許s3相關的debug輸出


--pprof
默認值：""
用途：指定“端口”或“主機:端口”以在該端口上啟用pprof HTTP分析器


--f
默認值：false
用途：在前臺執行zosfs


--log-file
默認值：""
用途：將日志重定向到文件，“stderr”（前臺默認）或“syslog”（后臺默認）


--print-stats
默認值：30 * time.Second
用途：I/O統計打印間隔，設置為0以禁用