OtterScale

OtterScale is a hyper-converged infrastructure (HCI) platform that unifies compute, storage, and networking into a scalable solution. Seamlessly manage VMs, containers, GPUs, and applications through a single control plane with enterprise-grade performance.

Note

Click below to view screenshots and explore the interface.

📸 Screenshots

Home	Scope Selector
Create Scope	Create Scope Settings
Scope Settings	Application Store
Machines	Machines Dark
Storage	Networking
Application Management	Application Workloads

✨ Key Features

• 🖥️ Virtualization: KVM/QEMU VMs with live migration and GPU management
• 🐳 Container Orchestration: Native Kubernetes and Juju charm deployment
• 💾 Distributed Storage: Built-in Ceph clusters with automated backup
• 📊 Monitoring: Integrated Prometheus and Grafana stack
• 🔐 Security: RBAC with LDAP/AD integration and SSO
• 🛒 Application Marketplace: Curated catalog of ready-to-deploy apps
• ⚡ High Availability: Multi-node deployment with automatic failover

🚀 Quick Start

Important

Requirements: Git, Docker, 8GB RAM, 100GB disk space

1. Clone the repository:

   git clone --depth 1 https://github.com/otterscale/otterscale.git
   cd otterscale

2. Set up environment:

   cp .env.example .env
   # Edit .env file with your settings

3. Start OtterScale:

   docker compose up -d

4. Access web interface:

Open your browser and navigate to http://localhost:3000 (or your configured port).

Tip

If you cannot access http://localhost:3000, check if the port is in use or refer to the troubleshooting guide.

For production deployments, see our deployment guide.

🔧 Development

Important

Requirements: Go 1.25+, Docker, Protobuf compiler, Make, Git

System Dependencies

# Ubuntu/Debian
sudo apt-get install libcephfs-dev librbd-dev librados-dev build-essential

# CentOS/RHEL/Fedora
sudo dnf install libcephfs-devel librbd-devel librados-devel gcc gcc-c++ make

Build from Source

git clone https://github.com/otterscale/otterscale.git
cd otterscale
make build
make test

Development Commands: make (show targets), make build, make test, make lint, make proto, make image

📚 Documentation & Support

• Getting Started - Setup and configuration guide
• API Reference - gRPC and REST API docs
• Architecture - System components overview
• Deployment - Production best practices

Need Help?

• GitHub Issues - Bug reports and feature requests
• GitHub Discussions - Community Q&A
• Enterprise Support - Commercial inquiries

🗺️ Roadmap

Version	Topic	Status
v0.5.0	Inception: Proof of Concept	✅ Complete
v0.6.0	Foundation: Full-Stack Readiness	✅ Complete
v0.7.0	Governance: Project-Centric Isolation	⏳ In Progress
v0.8.0	Storage+: Cloud-Native Data Fabric	⏳ In Progress
v0.9.0	Expansion: Hybrid Fleet Adoption	⏳ In Progress
v0.10.0	Autonomy: Immutable Infrastructure	📅 Planned
v0.11.0	Orchestration: Async Lifecycle Control	📅 Planned

🤝 Contributing

We welcome contributions! Please:

1. Fork the repository and create a feature branch
2. Make changes and add tests
3. Ensure code passes tests and linting
4. Submit a pull request

Follow Conventional Commits and review our Contributing Guidelines.

🔒 Security

For security vulnerabilities, email security@otterscale.com instead of creating public issues.

🙏 Acknowledgements

We extend our heartfelt gratitude to those who make OtterScale possible:

• Open Source Community: Thanks to contributors, early adopters, and active members in GitHub Issues and Discussions for code, feedback, and ideas.
• Core Technologies:
  • Kubernetes: Container orchestration
  • Ceph: Distributed storage
  • Juju: Application deployment
  • MAAS: Metal provisioning

Your support drives OtterScale’s mission to build better hyper-converged solutions! 🌟

📄 License

Licensed under GNU Affero General Public License v3.0 (AGPL-3.0). Open source with copyleft requirements.