Welcome to ChubaoFS(Chubao File System)

Getting Started

• Introduction
  • High Level Architecture
  • Features
• Run Cluster by Yum Tools
• Run Cluster Manually
  • Building
  • Deployment
  • Mount Client
  • Upgrading

Design Documentation

• Resource Manager (Master)
  • Utilization-Based Distribution/Placement
  • Replica Placement
  • Meta Partition Splitting
  • Exception Handling
• Metadata Subsystem
  • Internal Structure
  • Replication
  • Failure Recovery
• Data Subsystem
  • Features
  • HTTP APIs
• Object Subsystem (ObjectNode)
  • Structure
  • Features
  • Semantic Transform
  • User
  • Authentication
  • Invisible Temporary Data
  • Object Mode Conflict (Important)
  • Supported S3 Features
  • Unsupported S3 Features
  • Supported APIs
  • Supported SDKs
• Client
  • Client Caching
  • Integration with FUSE

User Documentation

• Resource Manager (Master)
  • Features
  • Configurations
  • Start Service
• Meta Subsystem
  • Notice
• Data Subsystem
  • How To Start DataNode
  • Configurations
  • Notice
• Object Subsystem (ObjectNode)
  • How To start ObjectNode
  • Configurations
  • Fetch Authentication Keys
  • Using Object Storage Interface
• Console
  • How To Start Console
  • Configurations
  • Notice
• Client
  • Prerequisite
  • Prepare Config File
  • Mount
  • Unmount
• Monitor
  • Metrics
  • Grafana DashBoard Config
• Tune FUSE Performance
  • Fetch Linux kernel source code
  • Optimize FUSE linux kernel module
  • Build against current running Linux kernel
  • Install kernel module
• Run Cluster by Yum Tools
• Run Cluster on Docker

Administration

• Resource Manager (Master) API
  • Cluster
  • Metanode Related
  • Datanode Related
  • Volume
  • Meta Partition
  • Data Partition
  • Master Management
  • User
• Meta Node API
  • Meta Partition
  • Inode
  • Dentry
• Command Line Interface
  • CLI

use case

• Use Cases
  • Machine Learning
  • ElasticSearch
  • Nginx Log Storage
  • Spark
  • MySQL Database Backup

Evaluation

• Performance
  • Environment
  • Small File Performance and Scalability
  • IO Performance and Scalability
    • 1. Sequential Read
    • 2. Sequential Write
    • 3. Random Read
    • 4. Random Write
  • Metadata Performance and Scalability
• Integrity
• Workload
• Scalability

Contributing

• Contributing to ChubaoFS
  • Bug Reports
  • Patch Guidelines
  • Credits

FAQ

• Environment Requirements and Capacity Planning
  • Environment Requirements
  • Capacity Planning
  • Multi-Zone Deploy
• Q&A
  • Compile
  • Node & Disk Failure
  • Performance of Data and Metadata
  • Capacity Management
  • Zone
  • Node status is abnormal
  • Upgrade
  • Update Configuration Online
  • Update Configuration Offline
  • Handle Logs
  • Data Loss and Consistence
  • Fuse Client