SNAP Documentation
“SNAP it, Save it, Start again.”
Welcome to the comprehensive documentation for SNAP, the enterprise-grade container checkpointing and state management platform.
What is SNAP?
SNAP enables organizations to capture the complete runtime state of running containers, convert them into portable images, and restore them across different environments. This breakthrough technology transforms containerized applications from stateless to stateful, enabling unprecedented flexibility in application management.
Key Features
- Live Container Checkpointing: Capture complete runtime state without downtime using CRIU
- Checkpoint-to-Image Conversion: Transform checkpoints into portable container images
- Cross-Environment Restoration: Restore states across different Kubernetes/Openshift clusters
- Multi-Cluster Management: Centralized management across multiple clusters
- Enterprise Security: RBAC, audit logging, SSL/TLS encryption
- Automated Workflows: SnapHook webhooks and SnapWatcher operator integration
- Real-time Monitoring: WebSocket-based progress tracking and health monitoring
Quick Start
New to SNAP? Get started quickly:
- Quick Start Guide - Get up and running in minutes
- Installation Guide - Detailed setup instructions
- RBAC Setup Guide - Configure permissions for OpenShift
Documentation Sections
Getting Started
- Quick Start Guide - Essential steps to create your first checkpoint
- Installation Guide - Complete installation and setup
- Configuration Guide - System and cluster configuration
User Guides
- Cluster Management - Managing Kubernetes/OpenShift clusters
- Checkpointing Guide - Creating and managing checkpoints
- Registry Integration - Container registry setup and management
- Automation Guide - Automated workflows and triggers
API Reference
- API Overview - Understanding the SNAP API
- API Endpoints - Complete API reference
- Authentication - API authentication and security
Security & Operations
- Security Guide - Security best practices and configuration
- RBAC Setup Guide - Role-based access control setup
- Troubleshooting Guide - Common issues and solutions
Additional Resources
- FAQ - Frequently asked questions
- Add Cluster Guide - Adding new clusters
- Migration Guide - Migrating between versions
Support
- 📖 Documentation: Comprehensive guides and tutorials
- 🐛 Issues: GitHub Issues
- 📧 Support: support@weaversoft.io
- 💬 Community: Join our community discussions
License
This project is licensed under the MIT License - see the LICENSE file for details.