Administration Guide

We explain core administrative tasks and practices that operators of LeoFS will want to consider.

• leofs-adm Command Line
• Launch and Operation Flow
  • Operation Flow Diagram
  • LeoFS launch order
    • Description of the Operations
  • LeoFS launch step by step
    • Start LeoFS Manager’s master
    • Start LeoFS Manager’s slave
    • Start LeoFS Storage
    • Connect LeoFS Manager with leofs-adm
    • The “start” command - Start LeoFS storage cluster
    • Confirm state of the every LeoFS storage
    • Start LeoFS Gateway
    • Confirm state of the every node
• General Commands
  • status
  • status <node>
  • whereis <file-path>
• LeoFS Storage Operation
  • LeoFS Storage’s Cluster Operation
    • detach <storage-node>
    • suspend <storage-node>
    • resume <storage-node>
    • start
    • rebalance
  • Storage MQ Operation
    • Since
    • Overview
    • mq-stats <storage-node>
    • mq-suspend <storage-node> <mq-id>
    • mq-resume <storage-node> <mq-id>
    • See Also
• Recover Commands
  • recover-file <file-path>
  • recover-node <node>
  • recover-ring <node>
  • recover-cluster <cluster-id>
• Data Compaction Commands
  • compact-start <storage-node> (all | <num-of-targets>) [<num-of-compaction-procs>]
  • compact-suspend <storage-node>
  • compact-resume <storage-node>
  • compact-status <storage-node>
  • diagnose-start <storage-node>
  • du <storage-node>
  • du detail <storage-node>
• LeoFS Gateway Operation
  • purge-cache <file-path>
  • remove-gateway <gateway-node>
• LeoFS Manager Maintenance
  • backup-mnesia <backup-filepath>
  • restore-mnesia <backup-filepath>
  • update-managers <manager-master> <manager-slave>
  • dump-ring (<manager-node>|<storage-node>|<gateway-node>)
• S3-API Commands
  • S3-API Commands - User
    • create-user <user-id> <password>
    • delete-user <user-id>
    • get-users
    • update-user-role <user-id> <role-id>
  • S3-API Commands - Endpoint
    • add-endpoint <endpoint>
    • delete-endpoint <endpoint>
    • get-endpoints
  • S3-API Commands - Bucket
    • add-bucket <bcuket> <access-key-id>
    • delete-bucket <bucket> <access-key-id>
    • get-buckets
    • get-bucket <access-key-id>
    • chown-bucket <bucket> <access-key-id>
    • update-acl <bucket> <access-key-id>
    • Canned ACL
• Administration of Multi Datacenter Replication
  • join-cluster <remote-manager-master>:<rpc-port> <remote-manager-slave>:<rpc-port>
  • remove-cluster <remote-manager-master>:<rpc-port> <remote-manager-slave>:<rpc-port>
  • cluster-status
• System Maintenance
  • Upgrade your old version LeoFS to v1.3.1
    • Upgrade flow diagram
    • Takeover a part of confugurations
    • Adjust Every Path
  • Attach/Detach node into a Storage-cluster in operation
  • LeoFS Gateway Access-log Format
    • Since
    • Overview
    • Sample
    • Format
  • LeoFS Storage Data Diagnosis log Format
    • Since
    • Overview
    • Sample - List of files
    • Format - List of files
    • Sample - Report of a data diagnosis / data compaction
    • Format - Report of a data diagnosis / data compaction
    • Diagnosis Log Dir
    • Diagnosis Log Files
  • Recover a storage-node
    • Since
    • Overview
    • Workflow
    • See also
• Administration of CDN Integration
  • Since
  • How to integrate LeoFS with CDN
  • How to use http_custom_header.conf
  • How to write http_custom_header.conf
  • Use cases
  • Appendix
    • Syntax for the expire field
    • List of verified CDN services