othman.suseno/calypso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
dcb54c26ec3e89fc2f609abae008a7205f3e6135
calypso/docs/alpha/README.md
Warp Agent 5ec4cc0319 add bacula installation docs
2026-01-04 19:42:58 +07:00

3.3 KiB
Raw Blame History

AtlasOS - Calypso Documentation

Alpha Release

This directory contains the Software Requirements Specification (SRS) and Software Design Specification (SDS) documentation for the Calypso backup appliance management system.

Documentation Structure

Software Requirements Specification (SRS)

Located in srs/ directory:

  • SRS-00-Overview.md: Overview and introduction
  • SRS-01-Storage-Management.md: ZFS storage management requirements
  • SRS-02-File-Sharing.md: SMB/NFS share management requirements
  • SRS-03-iSCSI-Management.md: iSCSI target management requirements
  • SRS-04-Tape-Library-Management.md: Physical and VTL management requirements
  • SRS-05-Backup-Management.md: Bacula/Bareos integration requirements
  • SRS-06-Object-Storage.md: S3-compatible object storage requirements
  • SRS-07-Snapshot-Replication.md: ZFS snapshot and replication requirements
  • SRS-08-System-Management.md: System configuration and management requirements
  • SRS-09-Monitoring-Alerting.md: Monitoring and alerting requirements
  • SRS-10-IAM.md: Identity and access management requirements
  • SRS-11-User-Interface.md: User interface and experience requirements

Software Design Specification (SDS)

Located in sds/ directory:

  • SDS-00-Overview.md: Design overview and introduction
  • SDS-01-System-Architecture.md: System architecture and component design
  • SDS-02-Database-Design.md: Database schema and data models
  • SDS-03-API-Design.md: REST API design and endpoints
  • SDS-04-Security-Design.md: Security architecture and implementation
  • SDS-05-Integration-Design.md: External system integration patterns

Coding Standards

  • CODING-STANDARDS.md: Code style, naming conventions, and best practices for Go and TypeScript/React

Infrastructure Review

  • INFRASTRUCTURE-REVIEW.md: Review of current infrastructure and environment against architecture specification
  • Calypso_System_Architecture.md: System architecture specification document

Technology Stack

  • TECHNOLOGY-STACK.md: Comprehensive list of all technologies, frameworks, libraries, and tools used in Calypso

Quick Reference

Features Implemented

  1. ✅ Storage Management (ZFS pools, datasets, disks)
  2. ✅ File Sharing (SMB/CIFS, NFS)
  3. ✅ iSCSI Management (SCST integration)
  4. ✅ Tape Library Management (Physical & VTL)
  5. ✅ Backup Management (Bacula/Bareos integration)
  6. ✅ Object Storage (S3-compatible)
  7. ✅ Snapshot & Replication
  8. ✅ System Management (Network, Services, NTP, SNMP, License)
  9. ✅ Monitoring & Alerting
  10. ✅ Identity & Access Management (IAM)
  11. ✅ User Interface (React SPA)

Technology Stack

  • Backend: Go 1.21+, Gin, PostgreSQL
  • Frontend: React 18, TypeScript, Vite, TailwindCSS
  • External: ZFS, SCST, Bacula/Bareos, MHVTL

Document Status

Version: 1.0.0-alpha
Last Updated: 2025-01-XX
Status: In Development

Contributing

When updating documentation:

  1. Update the relevant SRS or SDS document
  2. Update the version and date in the document
  3. Update this README if structure changes
  4. Maintain consistency across documents

Related Documentation

  • Implementation guides: ../on-progress/
  • Technical specifications: ../../src/srs-technical-spec-documents/