proxmox-iscsi-snapshots

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #java #nodejs #awesome #kubernetes #awesome-list #vue #pytorch #security #ios #mcp

proxmox-iscsi-snapshots

(★ 9)

This Script allows to Snapshot a virtual machine even when its fully on iscsi.

proxmox-iscsi-snapshots Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Enhanced Proxmox LVM Snapshot Manager

A comprehensive snapshot management solution for Proxmox VE that supports both virtual machines and LXC containers with advanced cluster capabilities and intelligent LVM handling.

---

## 🚀 Features

### Core Functionality
- **Universal Support**: Complete snapshot management for both QEMU VMs and LXC containers
- **Intelligent Auto-Detection**: Automatic detection between VMs and containers using 6 different methods
- **Advanced LVM Support**:
  - Thin LVM snapshots (automatic sizing)
  - Regular LVM snapshots (intelligent size calculation)
  - Automatic thin/thick detection
- **Cluster Operations**: Full multi-node Proxmox cluster support with SSH automation

### **Best Effort Atomic Snapshot Creation Behavior:**
- **Phase 1**: Lightning-fast preparation (parallel validation)
- **Phase 2**: Minimal downtime approach (freeze/suspend)
- **Phase 3**: Parallel snapshot creation (all disks simultaneously)
- **Phase 4**: Immediate restore (fastest resume)
- **Phase 5**: Fast metadata (consistent timestamps)

### Snapshot Operations
- **Create Snapshots**: Intelligent snapshot creation with automatic size calculation
- **Delete Snapshots**: Safe snapshot removal with verification
- **List Snapshots**: Detailed overview with creation dates, sizes, and types
- **Revert Snapshots**: Advanced revert functionality with snapshot preservation options

### Enhanced Capabilities
- **Snapshot Preservation**: Option to keep original snapshots during revert operations
- **Interactive & Non-Interactive Modes**: Full automation support for scripting
- **Cross-Node Execution**: Automatic detection and execution on correct cluster nodes
- **SSH Key Management**: Automated SSH setup for cluster communication
- **Comprehensive Error Handling**: Detailed diagnostics and troubleshooting information
---

## 📋 Prerequisites

### Required Configuration (on all PVE nodes)
1. Edit `/etc/lvm/lvm.conf` and ensure the following settings are enabled:
    ```text
    snapshot_autoextend_threshold = 70
    snapshot_autoextend_percent = 20
    ```

2. For cluster support:
   - SSH key authentication between cluster nodes
   - Same script deployed on all nodes

3. Ensure all required Proxmox CLI tools are available (`qm`, `pct`, `lvs`, `vgs`, `lvcreate`, etc.)

---

## 🛠️ Usage

### General Syntax
```bash
./snapshot.sh <action> <vmid/ctid> [<snapshotname>] [options]

```

### Actions

#### List Snapshots

```
./snapshot.sh list <vmid/ctid>

```

#### Create Snapshots

```
./snapshot.sh create <vmid/ctid> <snapshotname>

```

#### Delete Snapshots

```
./snapshot.sh delete <vmid/ctid> <snapshotname>

```

#### Revert Snapshots

```
./snapshot.sh revert <vmid/ctid> <snapshotname> [options]

```

### Command Line Options

#### Detection Options

-   `--container`: Force container mode (use pct commands)
-   `--vm`: Force VM mode (use qm commands)
-   Auto-detection is used if not specified

#### Revert Options

-   `--no-autostart`: Do not start VM/CT after revert (starts by default)
-   `--keep-snapshot`: Keep snapshot after revert (default: ask user)
-   `--delete-snapshot`: Delete snapshot after revert
-   `--non-interactive`: Skip all prompts (for automated execution)
-   `--interactive`: Force interactive mode even for remote execution

### Best Effort Atomic consistency options

-   `--atomic`: Enable Best Effort atomic mode (default, <100μs downtime)
-   `--fast`: Use fast parallel mode (legacy, ~3s downtime)
-   `--test-atomic`: Test best effort atomic consistency after operation

#### Cluster Options

-   `--force-local`: Force local-only operation (skip cluster coordination)
-   `--cluster-sync`: Force cluster synchronization even for local VMs/CTs
-   `--setup-ssh`: Setup SSH keys for cluster communication

#### Debug Options

-   `--debug`: Enable debug output for troubleshooting

* * * * *

📖 Examples
-----------

### Basic Operation

```
# List snapshots for VM 104
./snapshot.sh list 104

# List snapshots for container 108
./snapshot.sh list 108

# Create snapshot for VM (auto-detected)
./snapshot.sh create 104 backup-2025

# Create snapshot for container (auto-detected)
./snapshot.sh create 108 pre-update

# Delete snapshot
./snapshot.sh delete 104 backup-2025

# Revert with snapshot preservation
./snapshot.sh revert 104 backup-2025 --keep-snapshot

```

### Advanced Usage

```
# Force container mode if auto-detection fails
./snapshot.sh create 108 backup --container

# Non-interactive revert for automation
./snapshot.sh revert 104 backup --non-interactive --delete-snapshot --no-autostart

# Setup SSH keys for cluster
./snapshot.sh --setup-ssh

# Debug mode for troubleshooting
./snapshot.sh create 104 test --debug

```

### Cluster Operations

```
# Works automatically across cluster nodes
./snapshot.sh create 104 backup  # Executes on correct node automatically

# Force local execution only
./snapshot.sh create 104 backup --force-local

```

* * * * *

🔧 Advanced Features
--------------------

### Intelligent Snapshot Sizing

The script automatically calculates optimal snapshot sizes:

-   **Small disks** (<50G): 25% of disk size
-   **Medium disks** (50-200G): 20% of disk size
-   **Large disks** (>200G): 15% of disk size
-   **Thin LVM**: Automatic allocation as needed

### Cluster Integration

-   **Automatic node detection**: Finds where VMs/containers are located
-   **Remote execution**: Deploys and executes on correct nodes
-   **SSH automation**: Automatic SSH key setup and testing
-   **Fallback mechanisms**: Multiple methods for reliable operation

### Enhanced Detection System

The script uses 6 different methods to detect VM vs Container:

1.  Config file checking (`/etc/pve/lxc/` vs `/etc/pve/qemu-server/`)
2.  Status command testing (`pct status` vs `qm status`)
3.  Local list checking (`pct list` vs `qm list`)
4.  Cluster API integration (`pvesh`)
5.  Remote node checking via SSH
6.  LVM volume pattern analysis

* * * * *

📊 **Performance Comparison:**
------------------

| **Component** | **Before** | **After** | **Improvement** |
|---------------|------------|-----------|-----------------|
| **Detection** | ~2s | ~0.05s | **40x faster** |
| **Snapshot Creation** | ~20s | ~3s | **6.7x faster** |
| **Remote Execution** | ~13s | ~3s | **4.3x faster** |
| **Downtime** | ~5s | ~0.5s | **10x less** |
| **SSH Connection** | ~2s | ~0.2s | **10x faster** |

| Modus | Downtime | Atomicity | Speed | Rollback |
| --- | --- | --- | --- | --- |
| --atomic automatic | <100μs Best Effort Atomic | NO Best Effort Approach | ~3s Production | Automatic |
| --fast | ~1-3s Near-atomic | No | ~2s Production | Manually |

🐛 Troubleshooting
------------------

### Debug Mode

Enable debug output for detailed troubleshooting:

bash

```
./snapshot.sh create 104 test --debug

```

### Detection Issues

If auto-detection fails, the script provides detailed diagnostics:

```
./snapshot.sh list 999  # Shows detection details for non-existent ID

```

### SSH Issues

Setup SSH keys for cluster communication:

```
./snapshot.sh --setup-ssh

```

* * * * *

🔄 Changelog
------------

### 10.06.2025 Changelog

## 🔥 **Smaller Improvement:**
  - Enables LVM after VM was stopped.
  - Better Snapshot Sizing
  - Changed Script to a bash script.

***

### 07.06.2025 Changelog

## 🔥 **Smaller Improvement:**
 "Near-Atomic" / "Best-Effort Atomic":

- Pre-flight validation: All checks before VM contact
  - Parallel COW creation: Simultaneous snapshot creation
  - Microsecond commit: <100μs for metadata update
  - Transaction rollback: Cleanup in case of errors
  - Consistent timestamps: All snapshots have the same time

***
### 6.06.2025 Changelog

### 🔥 **Major Improvements:**

---

## ⚡ **Performance Optimizations (6x faster)**

### **Ultra-Fast Snapshot Creation:**
- **Best Effort Atomic Consistency**: 5-phase process with <1s downtime
- **Parallel Processing**: Simultaneous snapshot creation for all disks
- **Filesystem Freeze**: QEMU Guest Agent integration for sub-second downtime
- **Smart Sizing**: Intelligent snapshot size calculation
- **Total Time**: ~20s → ~3s (**6.7x faster**)

### **Remote-Execution Optimization:**
- **In-Memory Execution**: Script transfer without filesystem I/O
- **SSH Multiplexing**: Connection reuse
- **Connection Pooling**: 2-minute SSH cache
- **Parallel Node Detection**: Simultaneous cluster search
- **Compression**: Automatic LZ4/XZ/GZIP selection
- **Remote Time**: ~13s → ~3s (**4.3x faster**)

---

## 🔒 **Best Effort Atomic Consistency & Reliability**

### **Best Effort Atomic Snapshot Creation:**
```
Phase 1: Lightning-fast preparation (parallel validation)
Phase 2: Minimal downtime approach (freeze/suspend)
Phase 3: Parallel snapshot creation (all disks simultaneously)
Phase 4: Immediate restore (fastest resume)
Phase 5: Fast metadata (consistent timestamps)
```

### **Enhanced Error Handling:**
- **All-or-Nothing**: Automatic cleanup on failures
- **Rollback Protection**: Backup snapshots before revert
- **Robust Detection**: 6 fallback methods for VM/CT recognition
- **Cache Management**: Intelligent cache invalidation

---

## 🖥️ **User Experience Improvements**

### **Better Output:**
- **Emojis & Icons**: ✅ ❌ ⚡ 🚀 for better readability
- **Progress Indicators**: Real progress display
- **Performance Metrics**: Execution time display
- **Detailed Logs**: Extended debug information

### **Enhanced Detection:**
- **Fast Detection**: 5-minute cache for type recognition
- **Cluster-Aware**: Automatic node detection
- **Fallback Methods**: 6 different detection methods
- **Auto-Detection**: No manual `--container/--vm` needed

---

## ⚙️ **System-Level Optimizations**

### **Storage Optimizations:**
```bash
# Automatically applied:
vm.dirty_ratio = 5
vm.dirty_background_ratio = 2
I/O Scheduler: noop for SSDs, mq-deadline for HDDs
```

### **SSH Optimizations:**
```bash
# Automatic SSH configuration:
ControlMaster auto
ControlPersist 600
Compression yes
```

---

## 🛠️ **New Features**

### **Metadata Management:**
- **Consistent Timestamps**: Unified snapshot times
- **Creation Time Fix**: Correct date/time display
- **Metadata Persistence**: Survive system reboots

### **Cache System:**
- **Instance Detection**: 5-minute cache
- **Disk Lists**: 30-second cache
- **SSH Connections**: 2-minute cache
- **Smart Invalidation**: Automatic cache cleanup

### **Enhanced Commands:**
- **Fast Deletion**: Parallel snapshot deletion
- **Robust Revert**: Improved merge detection
- **Better Listing**: Extended snapshot information

---

## 🔧 **Technical Improvements**

### **Code Optimization:**
- **Parallel Execution**: Background jobs for everything
- **Memory Efficiency**: Reduced RAM usage
- **Error Recovery**: Automatic error handling
- **Resource Cleanup**: Better temporary file management

### **Cluster Support:**
- **Auto-Discovery**: Automatic node detection
- **Load Balancing**: Intelligent node selection
- **Failover**: Robust cluster communication
- **SSH Key Management**: Automatic setup

---

## 📊 **Performance Comparison:**

---

## 🎯 **Backward Compatibility**

### **100% Compatible:**
- All original commands work
- Same parameters and options
- Existing snapshots preserved
- Cluster setup unchanged

### **New Options:**
```bash
--debug           # Extended debug output
--non-interactive # Fully automated mode
--interactive     # Force interactive mode
--no-banner       # Suppress support banner
--setup-ssh       # Setup SSH optimization
```

---

## 🔍 **Bug Fixes**

### **Fixed:**
- ❌ Intermittent "No disks found" errors
- ❌ Cache issues with remote execution
- ❌ Incorrect creation time display
- ❌ Revert problems with Thin LVM
- ❌ Race conditions in parallel processing

### **Improved:**
- ✅ Robust disk detection with multiple fallbacks
- ✅ Consistent timestamps for all snapshots
- ✅ Better merge detection for revert operations
- ✅ More stable remote execution

---

## 🚀 **Summary**

**From a simple snapshot tool to an enterprise-grade, ultra-fast cluster manager with atomic consistency!**

- **6x faster performance** 
- **Best Effort Atomic Consistency** (All-or-Nothing)
- **<1s downtime** for VMs with Guest Agent
- **4x faster remote execution**
- **Intelligent caching systems**
- **Enterprise-grade error handling**

***
### 4.06.2025

### Major Enhancements Added

-   ✅ **Complete LXC Container Support**
-   ✅ **Enhanced Auto-Detection System** (6 methods)
-   ✅ **Advanced LVM Support** (thin/thick)
-   ✅ **Robust Cluster Support**
-   ✅ **Improved Remote Execution**
-   ✅ **Enhanced Command Line Options**
-   ✅ **Better Error Handling & Debugging**
-   ✅ **Intelligent Snapshot Sizing**
-   ✅ **Advanced Revert Functionality**
-   ✅ **Enhanced Snapshot Listing**

### New Functions

-   Enhanced detection with multiple fallback methods
-   Diagnostic information display
-   Thin LVM detection and handling
-   Snapshot preservation during revert
-   SSH automation and testing
-   Cross-cluster execution

* * * * *

🗺️ Roadmap
-----------

### 🎯 Version 2.0 - GUI Integration (Q2 2025)

-   **Native Proxmox VE Integration**

-   Proxmox VE plugin development
    -   Integration with existing Proxmox web interface
    -   Custom menu items and panels
    -   Seamless authentication with Proxmox users/permissions
-   **Enhanced GUI Features**

-   Visual snapshot timeline and management
    -   Drag-and-drop snapshot operations
    -   Bulk operations interface
    -   Advanced filtering and search capabilities

🤝 Contributing
---------------

We welcome contributions! Feel free to:

-   Submit **pull requests** for improvements
-   Report **issues** via GitHub Issues
-   Suggest **new features** or enhancements
-   Improve **documentation**

### Development

The script is designed to be:

-   **Cluster-ready** for production environments
-   **Automation-friendly** with non-interactive modes
-   **User-friendly** with comprehensive error messages
-   **Extensible** for future enhancements

* * * * *

📄 License
----------

This program is free software: you can redistribute it and/or modify it under the terms of the **GNU Affero General Public License** as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but **WITHOUT ANY WARRANTY**; without even the implied warranty of **MERCHANTABILITY** or **FITNESS FOR A PARTICULAR PURPOSE**. See the **GNU Affero General Public License** for more details.

You should have received a copy of the **GNU Affero General Public License** along with this program. If not, see <https://www.gnu.org/licenses/agpl-3.0.html>.

* * * * *

📞 Support
----------

For questions, support, or feature requests:

-   🐛 **Issues**: [GitHub Issues](https://github.com/MrMasterbay/proxmox-iscsi-snapshots/issues)
-   💬 **Discussions**: [Discord Coming Soon]
-   📧 **Contact**: <nico.schmidt@ns-tech.cloud>

### Follow Development

-   🔗 **Links**: [linktr.ee/bagstube_nico](https://linktr.ee/bagstube_nico)
-   💖 **Support**: [ko-fi.com/bagstube_nico](https://ko-fi.com/bagstube_nico)

* * * * *

**Enhanced Proxmox LVM Snapshot Manager** - Making snapshot management simple, reliable, and powerful! 🚀

proxmox-iscsi-snapshots

proxmox-iscsi-snapshots Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

proxmox-iscsi-snapshots

proxmox-iscsi-snapshots Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README