Skip to content

Quick Start

Quick Start Guide

Starting the System

  1. Start Master Server
Terminal window
make master
  1. Start Chunk Servers
Terminal window
# Start chunk servers with different locations and space limits
make chunk chunk1 0 0 1024 # Origin with 1GB
make chunk chunk2 100 0 2048 # East with 2GB
make chunk chunk3 0 100 1024 # North with 1GB
  1. Start Client Interface
Terminal window
# Start client at specific location
make client client1 50 50 # Center location

Basic Operations

File Operations

  1. Upload a File
client = GFSClient("configs/config.toml", "client1", x=10, y=20)
client.upload_file("local_file.txt", "/gfs/remote_file.txt")
  1. Download a File
client.download_file("/gfs/remote_file.txt", "downloaded_file.txt")
  1. Append to File
with open("data.txt", "rb") as f:
client.append_to_file("/gfs/remote_file.txt", f.read())

Using the Web Interface

  1. Access File Explorer

    • Navigate to “File Explorer” tab
    • Browse directory structure
    • Upload/download files
    • Create directories
  2. Monitor System

    • Check “Network Graph” tab
    • View chunk server status
    • Monitor space usage
    • Track client connections

Location-Aware Features

  1. Server Placement
Terminal window
# Strategic server placement
make chunk cs1 0 0 1024 # Center
make chunk cs2 100 100 1024 # Northeast
make chunk cs3 100 0 1024 # East
  1. Client Positioning
Terminal window
# Position clients near their data
make client client1 25 25 # Near center
make client client2 75 75 # Northeast quadrant

Space Management

  1. Configure Space Limits
Terminal window
# Varying space capacities
make chunk chunk1 10 20 2048 # 2GB space
make chunk chunk2 30 40 1024 # 1GB space
  1. Monitor Usage
    • Check space usage in web interface
    • Monitor replication status
    • View space distribution

System Monitoring

  1. Monitor Logs
Terminal window
# Check component logs
tail -f logs/master_*.log
tail -f logs/chunk_server_*.log

Common Operations

File Management

  1. Create directory structure
  2. Upload files
  3. Download files
  4. Append to existing files

System Administration

  1. Monitor server health
  2. Check replication status
  3. Verify space usage
  4. Track client connections

Best Practices

  1. Server Deployment

    • Distribute servers geographically
    • Balance space allocation
    • Monitor server health
  2. Client Usage

    • Position clients strategically
    • Monitor connection quality
    • Track operation success
  3. Data Management

    • Regular backups
    • Space monitoring
    • Replication verification

Troubleshooting

  1. Connection Issues

    • Verify master server is running
    • Check chunk server status
    • Confirm network connectivity
  2. Space Issues

    • Monitor available space
    • Check replication status
    • Verify chunk distribution
  3. Performance Issues

    • Check server load
    • Monitor network traffic
    • Verify client positioning

Next Steps

  1. Explore Advanced Features
  2. Learn about System Components
  3. Configure for production use