Files
rustfs/docs/examples
Copilot ad99019749 Add complete MNMD Docker deployment example with startup coordination and VolumeNotFound fix (#642)
* Initial plan

* Add MNMD Docker deployment example with 4 nodes x 4 drives

- Create docs/examples/mnmd/ directory structure
- Add docker-compose.yml with proper disk indexing (1..4)
- Add wait-and-start.sh for startup coordination
- Add README.md with usage instructions and alternatives
- Add CHECKLIST.md with step-by-step verification
- Fixes VolumeNotFound issue by using correct volume paths
- Implements health checks and startup ordering
- Uses service names for stable inter-node addressing

Co-authored-by: houseme <4829346+houseme@users.noreply.github.com>

* Add docs/examples README as index for deployment examples

Co-authored-by: houseme <4829346+houseme@users.noreply.github.com>

* Add automated test script for MNMD deployment

- Add test-deployment.sh with comprehensive validation
- Test container status, health, endpoints, connectivity
- Update README to reference test script
- Make script executable

Co-authored-by: houseme <4829346+houseme@users.noreply.github.com>

* improve code

* improve code

* improve dep crates `cargo shear --fix`

* upgrade aws-sdk-s3

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: houseme <4829346+houseme@users.noreply.github.com>
Co-authored-by: houseme <housemecn@gmail.com>
2025-10-12 13:15:14 +08:00
..

RustFS Deployment Examples

This directory contains practical deployment examples and configurations for RustFS.

Available Examples

MNMD (Multi-Node Multi-Drive)

Complete Docker Compose example for deploying RustFS in a 4-node, 4-drive-per-node configuration.

Features:

  • Proper disk indexing (1..4) to avoid VolumeNotFound errors
  • Startup coordination via wait-and-start.sh script
  • Service discovery using Docker service names
  • Health checks with alternatives for different base images
  • Comprehensive documentation and verification checklist

Use Case: Production-ready multi-node deployment for high availability and performance.

Quick Start:

cd docs/examples/mnmd
docker-compose up -d

See also:

Other Deployment Examples

For additional deployment examples, see:

  • examples/ - Root-level examples directory with:
    • docker-quickstart.sh - Quick start script for basic deployments
    • enhanced-docker-deployment.sh - Advanced deployment scenarios
    • docker-comprehensive.yml - Docker Compose with multiple profiles
  • .docker/compose/ - Docker Compose configurations:
    • docker-compose.cluster.yaml - Basic cluster setup
    • docker-compose.observability.yaml - Observability stack integration

Contributing

When adding new examples:

  1. Create a dedicated subdirectory under docs/examples/
  2. Include a comprehensive README.md
  3. Provide working configuration files
  4. Add verification steps or checklists
  5. Document common issues and troubleshooting

Support

For issues or questions: