How rockstor/rockstor-core works
Project type and purpose
• Rockstor is a full-stack, open-source NAS appliance built in Python/Django with a JavaScript-driven web UI and a CLI.
• It exposes RESTful APIs, manages BTRFS/ZFS volumes, services (NFS, SMB, iSCSI, SNMP, UPS), and Docker “Rock-ons.”
File structure
• Top-level “conf” + “etc” dirs define systemd, nginx, supervisord, PostgreSQL, and UPS configurations.
• “src/rockstor” contains:
• Django project (manage.py, settings.py, wsgi.py, urls.py)
• Two main Django apps:
– storageadmin: admin UI, models, views, templates, Backbone/Marionette front-end assets under static/js/templates & views.
– smart_manager: metrics collection, task scheduling, replication broker & consumer, internal REST views.
• CLI tools under cli/ invoking the same REST API.
• System modules under system/ abstract OS-level commands (disk, network, services, smartctl).
• Scripts for bootstrapping, DB prep, scheduled tasks (cron wrappers).
• Build and deployment: build.sh, gulpfile.js for JS assets, Poetry/pyproject.toml for Python deps.
README for additional insights
• Reinforces Django + BTRFS foundation, REST APIs, Docker plugin sub-system.
• Emphasizes community, extensibility via Rock-ons registry.
Main components and interactions
a. Clients
• Web Browser/UI: loads HTML/CSS/JS (Backbone on top of Django templates) → speaks JSON to REST API.
• CLI (rock): command-line wrapper around REST calls.
b. API Gateway
• Django REST Framework endpoints (storageadmin and smart_manager routers).
c. Business Logic
• storageadmin.app: CRUD models for pools, shares, users, services, API keys, plugins.
• smart_manager.app: collects metrics, runs scheduled tasks, replication sender/receiver, SNMP probes.
• python/system modules: abstract calls to OS tools (btrfs, zfs, network, services, smartd, samba, docker).
d. Data Layer
• PostgreSQL (configured via conf/postgresql_*.sql + pg_hba.conf).
• Django ORM migrations in both apps.
e. Scheduler & Workers
• Huey/cron (scheduled_tasks under scripts and smart_manager) for scrubs, snapshots, replication triggers.
f. Persistence & Filesystem
• BTRFS/ZFS volumes under /dev; file sharing via NFS/SMB/iSCSI.
g. External Services & Integration
• Nginx (reverse proxy to Gunicorn).
• Supervisord or systemd to manage Gunicorn, scheduler, watchers.
• Docker daemon for Rock-ons (plugins).
• UPS (via upssched), SNMP daemons.
h. Logging & Monitoring
• var/log/* for system logs, Rockstor logs.
Architectural patterns & design principles
• MVC: Django (models → views → templates & REST serializers).
• CLI & Web UI both reuse the same REST API (API-first design).
• Modular “system” layer isolates OS interactions.
• Asynchronous scheduling via Python tasks & cron wrappers.
• Front-end uses Backbone/Marionette modules, templates, and a single-page app pattern.