vm-tool 1.0.43

A Comprehensive Tool for Setting Up Virtual Machines.

🚀 VM Setup Tool

Documentation • PyPI • GitHub • Contributing • License

A modern, user-friendly solution for automating and managing virtual machine (VM) setup and configuration using Ansible.

---

✨ Features

• Automated VM setup with Docker & Docker Compose
• Cloud VM provisioning via SSH
• Infrastructure Provisioning: Terraform integration for cloud providers (AWS, etc.)
• Kubernetes Ready: One-click K3s cluster setup
• Observability: Instant Prometheus & Grafana deployment
• CI/CD Pipelines: Auto-generate GitHub Actions workflows
• SSH key management and configuration
• Simple Python API for integration
• One-command version check: vm_tool --version

---

⚡️ Installation

Install the latest version from PyPI:

pip install vm-tool

---

🛠️ Usage Examples

🚀 Universal Deployment (CLI)

1. Generate CI/CD Pipeline

Bootstrap your project with a complete GitHub Actions workflow:

vm_tool generate-pipeline

2. Provision Infrastructure

Provision cloud resources using Terraform (requires Terraform installed):

vm_tool provision --provider aws --action apply --vars region=us-east-1

3. Setup Kubernetes (K3s)

Deploy a lightweight Kubernetes cluster to your servers:

vm_tool setup-k8s --inventory inventory.yml

4. Setup Observability

Deploy Prometheus and Grafana for instant monitoring:

vm_tool setup-monitoring --inventory inventory.yml

🐍 Python API Usage

Automated Local VM Setup

from vm_tool.runner import SetupRunner, SetupRunnerConfig

config = SetupRunnerConfig(
    github_username='your_github_username',
    github_token='your_github_token',
    github_project_url='your_github_project_url',
    github_branch='your_branch_name',
    docker_compose_file_path='path_to_your_docker_compose_file',
    dockerhub_username='your_dockerhub_username',
    dockerhub_password='your_dockerhub_password'
)

runner = SetupRunner(config)
runner.run_setup()

Cloud VM Setup (via SSH)

from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig

config = SetupRunnerConfig(
    github_username='your_github_username',
    github_token='your_github_token',
    github_project_url='your_github_project_url',
    github_branch='your_branch_name',
    docker_compose_file_path='path_to_your_docker_compose_file',
    dockerhub_username='your_dockerhub_username',
    dockerhub_password='your_dockerhub_password'
)

runner = SetupRunner(config)

ssh_configs = [
    SSHConfig(
        ssh_username='your_ssh_username',
        ssh_password='your_ssh_password',
        ssh_hostname='your_ssh_hostname',
        ssh_identity_file='/path/to/your/ssh_key'  # Optional
    )
]

runner.run_cloud_setup(ssh_configs)

SSH Key Management

from vm_tool.ssh import SSHSetup

ssh_setup = SSHSetup(
    hostname='your_vm_hostname',
    username='your_vm_username',
    password='your_vm_password',
    email='your_email_for_ssh_key'
)

ssh_setup.setup()

---

🖥️ Command Line Version Check

Check your installed version at any time:

vm_tool --version

---

⚙️ Configuration Options

• github_username: GitHub username (for private repos)
• github_token: GitHub token (for private repos)
• github_project_url: GitHub repository URL
• github_branch: Branch to use (default: main)
• docker_compose_file_path: Path to Docker Compose file (default: docker-compose.yml)
• dockerhub_username: Docker Hub username (if login needed)
• dockerhub_password: Docker Hub password (if login needed)

---

📚 Learn More

See the Official Documentation for complete guides. Visit the PyPI page for generic details, or the GitHub repository for code and issues.

---

Empower your infrastructure automation with VM Setup Tool – fast, reliable, and developer-friendly!