vmsan

🔥 Firecracker microVM सैंडबॉक्स टूलकिट

कमांड लाइन से अलग-थलग Firecracker microVMs बनाएँ, प्रबंधित करें और कनेक्ट करें। मिलीसेकंड में एक सैंडबॉक्स किया गया VM बूट करें, कमांड चलाएँ, फ़ाइलें स्थानांतरित करें — SSH की आवश्यकता नहीं।

📚 vmsan.dev पर पूर्ण दस्तावेज़ीकरण पढ़ें

✨ विशेषताएँ

• ⚡ मिलीसेकंड बूट — Firecracker microVMs < 200ms में शुरू होते हैं
• 🔒 सुरक्षा अलगाव — jailer, seccomp, cgroups, और प्रति-VM नेटवर्क नेमस्पेस
• 🖥️ इंटरैक्टिव शेल — पूर्ण टर्मिनल समर्थन के साथ WebSocket PTY
• 📂 फ़ाइल स्थानांतरण — SSH के बिना अपलोड और डाउनलोड
• 🐳 डॉकर इमेज — --from-image के साथ किसी भी OCI इमेज से rootfs बनाएँ
• 🏃 कमांड निष्पादन — स्ट्रीमिंग आउटपुट, एनवी इंजेक्शन, और sudo के साथ कमांड चलाएँ
• 🧩 एकाधिक रनटाइम — base, node22, node24, python3.13
• 📸 VM स्नैपशॉट — VM स्थिति सहेजें और पुनर्स्थापित करें
• 📊 JSON आउटपुट — स्क्रिप्टिंग और ऑटोमेशन के लिए --json फ़्लैग

📋 पूर्वापेक्षाएँ

• Linux (x86_64 या aarch64) KVM समर्थन के साथ
• Root/sudo एक्सेस (TAP डिवाइस नेटवर्किंग और jailer के लिए आवश्यक)
• Docker (स्रोत इंस्टॉल, स्थानीय रनटाइम पुनर्निर्माण, और --from-image के लिए)

🚀 इंस्टॉल

curl -fsSL https://vmsan.dev/install | bash

यह सब कुछ डाउनलोड करके ~/.vmsan/ में इंस्टॉल करता है:

• Firecracker + Jailer (नवीनतम रिलीज़)
• Linux कर्नेल (vmlinux 6.1)
• Ubuntu 24.04 rootfs (squashfs से ext4 में रूपांतरित)
• vmsan CLI + in-VM एजेंट
• रनटाइम इमेज (node22, node24, python3.13) पूर्व-निर्मित आर्टिफैक्ट के रूप में डाउनलोड की गई

मानक रिलीज़ इंस्टॉल https://artifacts.vmsan.dev/ से बिल्ट-इन रनटाइम डाउनलोड करते हैं और Docker की आवश्यकता नहीं होती। स्रोत इंस्टॉल अभी भी रनटाइम को स्थानीय रूप से बनाते हैं।

curl -fsSL https://vmsan.dev/install | bash -s -- --uninstall

# डिपेंडेंसीज़ इंस्टॉल करें
bun install

# in-VM एजेंट बनाएँ
cd agent && make install && cd ..

# CLI बनाएँ
bun run build

# स्थानीय बिल्ड लिंक करें
mkdir -p ~/.vmsan/bin
ln -sf "$(pwd)/dist/bin/cli.mjs" ~/.vmsan/bin/vmsan

📖 उपयोग

# VM बनाएँ और शुरू करें
vmsan create --runtime node22 --memory 512 --cpus 2

# Docker इमेज से VM बनाएँ
vmsan create --from-image node:22-alpine

# सभी VMs सूचीबद्ध करें
vmsan list

# VM के अंदर कमांड निष्पादित करें
vmsan exec <vm-id> ls -la

# PTY के साथ इंटरैक्टिव निष्पादन
vmsan exec -i <vm-id> bash

# चल रहे VM शेल से कनेक्ट करें
vmsan connect <vm-id>

# VM पर फ़ाइल अपलोड करें
vmsan upload <vm-id> ./local-file.txt /remote/path/file.txt

# VM से फ़ाइल डाउनलोड करें
vmsan download <vm-id> /remote/path/file.txt ./local-file.txt

# चल रहे VM का स्नैपशॉट लें
vmsan snapshot create <vm-id>

# स्नैपशॉट सूचीबद्ध करें
vmsan snapshot list

# स्नैपशॉट से VM पुनर्स्थापित करें
vmsan create --snapshot <snapshot-id>

# VM रोकें
vmsan stop <vm-id>

# VM हटाएँ
vmsan remove <vm-id>

वैश्विक फ़्लैग

कमांड

⚠️ ज्ञात सीमाएँ

• कोई अंतर-VM नेटवर्किंग नहीं (0.4.0 के लिए योजना)
• कोई घोषणात्मक कॉन्फ़िग / vmsan.toml नहीं (0.5.0 के लिए योजना)
• कोई मल्टी-होस्ट समर्थन नहीं (0.7.0 के लिए योजना)
• नेटवर्क अलगाव के लिए परमाणु नियम अनुप्रयोग के साथ nftables का उपयोग करता है (0.2.0 के बाद से)
• कोई DNS या SNI फ़िल्टरिंग नहीं (0.3.0 के लिए योजना)
• VMs से ICMP डिफ़ॉल्ट रूप से अवरुद्ध (ICMP टनलिंग को रोकता है)
• UDP को DNS को छोड़कर डिफ़ॉल्ट रूप से अवरुद्ध (UDP बहिर्निकासी को रोकता है; QUIC/HTTP3 काम नहीं करेगा)
• NTP (UDP 123) अवरुद्ध — समय सिंक के लिए kvm-clock का उपयोग किया जाता है, लंबे समय तक चलने वाले VMs में बहाव हो सकता है
• होस्ट फ़ायरवॉल (ufw/firewalld) को vmsan ट्रैफ़िक के लिए स्पष्ट अनुमति नियमों की आवश्यकता हो सकती है
• केवल Linux — KVM समर्थन आवश्यक
• प्राथमिक प्लेटफ़ॉर्म: Ubuntu 24.04 LTS

🛠️ डेवलपमेंट

# बिल्ड
bun run build

# स्थानीय बिल्ड लिंक करें
ln -sf "$(pwd)/dist/bin/cli.mjs" ~/.vmsan/bin/vmsan

# डेव मोड (वॉच)
bun run dev

# परीक्षण चलाएँ
bun run test

# टाइप जाँच
bun run typecheck

# लिंट और फ़ॉर्मेट
bun run lint
bun run fmt

🏗️ आर्किटेक्चर

bin/            CLI प्रवेश बिंदु
src/
  commands/     CLI उपकमांड
  services/     Firecracker क्लाइंट, एजेंट क्लाइंट, VM सेवा
  lib/          उपयोगिताएँ (jailer, नेटवर्किंग, शेल, लॉगिंग)
  errors/       टाइप की गई त्रुटि प्रणाली
  generated/    Firecracker API प्रकार परिभाषाएँ
agent/          Go एजेंट जो VM के अंदर चलता है
docs/           दस्तावेज़ीकरण साइट (vmsan.dev)

यह कैसे काम करता है

1. vmsan हल्के microVMs बनाने के लिए Firecracker का उपयोग करता है, जिसमें सुरक्षा अलगाव के लिए jailer होता है
2. प्रत्येक VM को अपने स्वयं के /30 सबनेट (198.19.{slot}.0/30) के साथ एक TAP नेटवर्क डिवाइस मिलता है
3. VM के अंदर एक Go-आधारित एजेंट चलता है, जो कमांड निष्पादन, फ़ाइल संचालन और शेल एक्सेस के लिए HTTP API प्रदर्शित करता है
4. CLI होस्ट-गेस्ट नेटवर्क पर एजेंट के साथ संवाद करता है

अवस्था ~/.vmsan/ में संग्रहीत होती है:

~/.vmsan/
  vms/          VM अवस्था फ़ाइलें (JSON)
  jailer/       Chroot निर्देशिकाएँ
  bin/          एजेंट बाइनरी
  kernels/      VM कर्नेल इमेज
  rootfs/       बेस रूट फ़ाइलसिस्टम
  registry/     Docker इमेज rootfs कैश
  snapshots/    VM स्नैपशॉट

⚖️ vmsan की तुलना