request-vm-on-golem 0.1.0__py3-none-any.whl

request_vm_on_golem-0.1.0.dist-info/METADATA

@@ -0,0 +1,296 @@
+Metadata-Version: 2.1
+Name: request-vm-on-golem
+Version: 0.1.0
+Summary: VM on Golem Requestor CLI - Create and manage virtual machines on the Golem Network
+Home-page: https://github.com/cryptobench/vm-on-golem
+Keywords: golem,vm,cloud,decentralized,cli
+Author: Phillip Jensen
+Author-email: phillip+vm-on-golem@golemgrid.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: System :: Systems Administration
+Requires-Dist: aiohttp (>=3.7.4,<4.0.0)
+Requires-Dist: aiosqlite (>=0.17.0,<0.18.0)
+Requires-Dist: asyncssh (>=2.7.0,<3.0.0)
+Requires-Dist: click (>=8.0.1,<9.0.0)
+Requires-Dist: colorlog (>=6.7.0,<7.0.0)
+Requires-Dist: cryptography (>=3.4.7,<4.0.0)
+Requires-Dist: pydantic (>=1.8.2,<2.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Project-URL: Repository, https://github.com/cryptobench/vm-on-golem
+Description-Content-Type: text/markdown
+
+# VM on Golem Requestor
+
+A sophisticated command-line interface for managing virtual machines on the Golem Network. The requestor works in tandem with provider nodes to create and manage VMs with secure SSH access.
+
+## Architecture Overview
+
+```mermaid
+graph TB
+    subgraph Requestor
+        CLI[CLI Interface]
+        DB[Local Database]
+        SSH[SSH Manager]
+        PC[Provider Client]
+    end
+    
+    subgraph Provider
+        API[Provider API]
+        VM[VM Manager]
+        Proxy[SSH Proxy]
+        RT[Resource Tracker]
+    end
+    
+    CLI --> PC
+    PC --> API
+    SSH --> Proxy
+    VM --> RT
+```
+
+## How It Works
+
+### 1. VM Creation Flow
+
+```mermaid
+sequenceDiagram
+    participant User
+    participant CLI
+    participant SSH
+    participant Provider
+    participant VM
+    
+    User->>CLI: Create VM Command
+    CLI->>SSH: Generate SSH Key
+    SSH-->>CLI: Key Pair
+    CLI->>Provider: Create VM Request + Public Key
+    Provider->>VM: Launch with Cloud-Init
+    Provider->>Proxy: Configure SSH Port
+    Provider-->>CLI: VM Details + Port
+    CLI->>DB: Save VM State
+    CLI-->>User: Connection Info
+```
+
+When you create a VM:
+1. The requestor generates an SSH key pair or uses your system's existing keys
+2. The provider receives the public key and injects it during VM creation via cloud-init
+3. The provider allocates a dedicated port and configures SSH forwarding
+4. Connection details are stored locally for future access
+
+### 2. SSH Connection Flow
+
+```mermaid
+sequenceDiagram
+    participant User
+    participant CLI
+    participant DB
+    participant Proxy
+    participant VM
+    
+    User->>CLI: SSH Command
+    CLI->>DB: Get VM Details
+    DB-->>CLI: Connection Info
+    CLI->>Proxy: SSH Connection
+    Proxy->>VM: Forward Connection
+    VM-->>User: Interactive Shell
+```
+
+The SSH connection process:
+1. The CLI retrieves stored VM details from the local database
+2. The provider's proxy system forwards your SSH connection to the VM
+3. All traffic is securely routed through the allocated port
+
+## Installation
+
+```bash
+# Install using pip
+pip install golem-vm-requestor
+
+# Or install from source
+git clone https://github.com/golem/vm-on-golem.git
+cd vm-on-golem/requestor-server
+pip install -e .
+```
+
+## Usage
+
+### Provider Discovery
+
+List available providers with their resources:
+
+```bash
+golem vm providers
+```
+
+Example output:
+```
+────────────────────────────────────────────────
+  🌍 Available Providers (3 total)
+────────────────────────────────────────────────
+Provider ID     Country   CPU    Memory    Storage
+provider-1      🌍 SE     💻 4    🧠 8GB    💾 40GB
+provider-2      🌍 US     💻 8    🧠 16GB   💾 80GB
+provider-3      🌍 DE     💻 2    🧠 4GB    💾 20GB
+────────────────────────────────────────────────
+```
+
+### Creating a VM
+
+```bash
+golem vm create my-webserver --provider-id provider-1 --cpu 2 --memory 4 --storage 20
+```
+
+The system will:
+1. Verify provider availability
+2. Check resource requirements
+3. Set up SSH access
+4. Deploy and configure the VM
+5. Save connection details locally
+
+Example output:
+```
+────────────────────────────────────────────────
+  🎉 VM Deployed Successfully!
+────────────────────────────────────────────────
+
+  VM Details
+  ┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
+  🏷️  Name      : my-webserver
+  💻 Resources  : 2 CPU, 4GB RAM, 20GB Storage
+  🟢 Status     : running
+
+  Connection Details
+  ┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
+  🌐 IP Address : 192.168.1.100
+  🔌 Port       : 50800
+
+  Quick Connect
+  ┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
+  🔑 SSH Command : ssh -i ~/.golem/ssh/id_rsa -p 50800 ubuntu@192.168.1.100
+────────────────────────────────────────────────
+```
+
+### Managing VMs
+
+List your VMs:
+```bash
+golem vm list
+```
+
+Example output:
+```
+────────────────────────────────────────────────
+  📋 Your VMs (2 total)
+────────────────────────────────────────────────
+Name          Status         IP Address      Resources
+my-webserver  ● running     192.168.1.100   2 CPU, 4GB RAM
+my-database   ● stopped     192.168.1.101   4 CPU, 8GB RAM
+────────────────────────────────────────────────
+```
+
+Other commands:
+```bash
+# SSH into a VM
+golem vm ssh my-webserver
+
+# Stop a VM
+golem vm stop my-webserver
+
+# Start a VM
+golem vm start my-webserver
+
+# Destroy a VM
+golem vm destroy my-webserver
+```
+
+## Configuration
+
+The requestor uses a hierarchical configuration system:
+
+1. Environment Variables:
+```bash
+# Discovery Service
+export GOLEM_REQUESTOR_DISCOVERY_URL="http://discovery.golem.network:7465"
+
+# Base Directory (default: ~/.golem)
+export GOLEM_REQUESTOR_BASE_DIR="/path/to/golem/dir"
+
+# Individual Paths (override base dir)
+export GOLEM_REQUESTOR_SSH_KEY_DIR="/path/to/keys"
+export GOLEM_REQUESTOR_DB_PATH="/path/to/database.db"
+
+# Environment Mode
+export GOLEM_REQUESTOR_ENVIRONMENT="production"  # or "development"
+```
+
+2. Directory Structure:
+```
+~/.golem/
+  ├── ssh/              # SSH keys
+  │   ├── id_rsa       # Private key
+  │   └── id_rsa.pub   # Public key
+  └── vms.db           # SQLite database
+```
+
+## Technical Details
+
+### SSH Key Management
+
+The system intelligently handles SSH keys:
+1. Uses existing system SSH keys if available
+2. Generates and manages Golem-specific keys if needed
+3. Ensures proper key permissions (0600 for private, 0644 for public)
+4. Supports key reuse across VMs
+
+### State Management
+
+Local state is maintained in SQLite:
+- VM details and configuration
+- Provider information
+- Connection parameters
+- VM status tracking
+
+### Provider Integration
+
+The requestor communicates with providers through:
+1. Discovery service for provider location
+2. Direct API calls for VM management
+3. SSH proxy system for secure access
+4. Resource tracking for capacity management
+
+## Error Handling
+
+The system provides clear error messages and recovery steps:
+
+```
+Error: Unable to establish SSH connection (VM may be starting up)
+Solution: Wait a few moments and try again. The VM is likely still initializing.
+
+Error: Provider is no longer available (they may have gone offline)
+Solution: Choose a different provider or wait for the original to come back online.
+
+Error: VM not found in local database
+Solution: The VM may have been manually removed. Use 'golem vm list' to see available VMs.
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run the tests
+5. Submit a pull request
+
+

request_vm_on_golem-0.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+requestor/__init__.py,sha256=OqSUAh1uZBMx7GW0MoSMg967PVdmT8XdPJx3QYjwkak,116
+requestor/cli/__init__.py,sha256=e3E4oEGxmGj-STPtFkQwg_qIWhR0JAiAQdw3G1hXciU,37
+requestor/cli/commands.py,sha256=RCdAAoyFbzfAxd2_EXXCymSEP7VQMGu7VjnsYWd-tB8,24223
+requestor/config.py,sha256=CWULCWpzpGwSSgn7L2IMUNywHK7Bng_b84kmObVLFLc,2191
+requestor/db/__init__.py,sha256=Gm5DfWls6uvCZZ3HGGnyRHswbUQdeA5OGN8yPwH0hc8,88
+requestor/db/sqlite.py,sha256=kqutQMs3srcZHa5kI1cbHvOYr66cCfQCb2xuioNAbLc,4638
+requestor/errors.py,sha256=wVpHBuYgQx5pTe_SamugfK-k768noikY1RxvPOjQGko,665
+requestor/provider/__init__.py,sha256=fmW23aYUVciF8-gmBZkG-PLhn22upmcDzdPfAOLHG6g,103
+requestor/provider/client.py,sha256=OUP7CoOCCtKD6DB9eqFkOXK6A2BLFdM4DWSkoulJQxg,3213
+requestor/run.py,sha256=mFqoP93KuRpQZ8pmzP5pHvByaDjHJ9xRYRjYC77s6bg,1386
+requestor/ssh/__init__.py,sha256=hNgSqJ5s1_AwwxVRyFjUqh_LTBpI4Hmzq0F-f_wXN9g,119
+requestor/ssh/manager.py,sha256=h-93AXFJqzGo2lNTG2u-q4ivU9cCFeNDhYN55skPLBo,6566
+requestor/utils/logging.py,sha256=oFNpO8pJboYM8Wp7g3HOU4HFyBTKypVdY15lUiz1a4I,3721
+requestor/utils/spinner.py,sha256=PUHJdTD9jpUHur__01_qxXy87WFfNmjQbD_sLG-KlGo,2459
+request_vm_on_golem-0.1.0.dist-info/METADATA,sha256=Kz8UZmfYOlHkDDQ_aaJFBuVQqvPHa1QyEXU7epzvU_k,8898
+request_vm_on_golem-0.1.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+request_vm_on_golem-0.1.0.dist-info/entry_points.txt,sha256=Z-skRNpJ8aZcIl_En9mEm1ygkp9FKy0bzQoL3zO52-0,44
+request_vm_on_golem-0.1.0.dist-info/RECORD,,

request_vm_on_golem-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

request_vm_on_golem-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+golem=requestor.run:main
+

requestor/__init__.py

@@ -0,0 +1,7 @@
+"""
+VM on Golem Requestor Node
+
+A simple CLI tool for managing VMs on the Golem Network.
+"""
+
+__version__ = "0.1.0"

requestor/cli/__init__.py

@@ -0,0 +1 @@
+"""CLI interface for VM on Golem."""