vm-tool 1.0.32__py3-none-any.whl

vm_tool/vm_setup/docker/install_docker_and_compose.yml

@@ -0,0 +1,92 @@
+- name: Install Docker and Docker Compose on Ubuntu
+  block:
+    - name: Check if Docker is installed
+      ansible.builtin.command: docker --version
+      register: docker_installed
+      ignore_errors: yes
+
+    - name: Check if Docker Compose is installed
+      ansible.builtin.command: docker compose version
+      register: docker_compose_installed
+      ignore_errors: yes
+
+    - name: Log Docker installation status
+      ansible.builtin.debug:
+        msg: "Docker is {{ 'installed' if docker_installed.rc == 0 else 'not installed' }}"
+
+    - name: Log Docker Compose installation status
+      ansible.builtin.debug:
+        msg: "Docker Compose is {{ 'installed' if docker_compose_installed.rc == 0 else 'not installed' }}"
+
+    - name: Get system architecture
+      ansible.builtin.command: dpkg --print-architecture
+      register: system_arch
+      changed_when: false
+
+    - name: Get Ubuntu version codename
+      ansible.builtin.command: lsb_release -cs
+      register: ubuntu_codename
+      changed_when: false
+
+    - name: Update apt package index
+      ansible.builtin.apt:
+        update_cache: yes
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Install prerequisites
+      ansible.builtin.apt:
+        name:
+          - curl
+          - apt-transport-https
+          - ca-certificates
+          - gnupg
+          - lsb-release
+          - software-properties-common
+        state: present
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Add Docker GPG key
+      ansible.builtin.shell:
+        cmd: |
+          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --yes --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Determine correct Ubuntu codename
+      set_fact:
+        ubuntu_codename_fixed: "{{ 'jammy' if ubuntu_codename.stdout == 'noble' else ubuntu_codename.stdout }}"
+
+    - name: Add Docker repository (auto-detect architecture)
+      ansible.builtin.shell:
+        cmd: |
+          echo "deb [arch={{ system_arch.stdout }} signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu {{ ubuntu_codename_fixed }} stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Update apt package index again
+      ansible.builtin.apt:
+        update_cache: yes
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Install Docker and Docker Compose (if available in repo)
+      ansible.builtin.apt:
+        name:
+          - docker-ce
+          - docker-ce-cli
+          - containerd.io
+          - docker-compose-plugin
+        state: present
+      ignore_errors: yes
+      register: docker_install_status
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Enable and Start Docker service
+      ansible.builtin.systemd:
+        name: docker
+        enabled: yes
+        state: started
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+
+    - name: Change permissions for Docker socket
+      ansible.builtin.command: sudo chmod 666 /var/run/docker.sock
+      ignore_errors: yes
+      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+  become: yes

vm_tool/vm_setup/docker/login_to_docker_hub.yml

@@ -0,0 +1,6 @@
+- name: Dockerhub Login
+  block:
+    - name: Log in to Docker Hub
+      shell: echo "{{ DOCKERHUB_PASSWORD }}" | docker login --username "{{ DOCKERHUB_USERNAME }}" --password-stdin
+      ignore_errors: yes
+      become: yes

vm_tool/vm_setup/github/git_configuration.yml

@@ -0,0 +1,68 @@
+- name: Git Configuration Playbook
+  block:
+    - name: Ensure Git is installed
+      package:
+        name: git
+        state: present
+      become: yes
+    
+    # --- Git Credential Setup ---
+    - name: Check if Git credentials file exists
+      stat:
+        path: ~/.git-credentials
+      register: git_credentials_stat
+
+    - name: Read contents of Git credentials file
+      slurp:
+        src: ~/.git-credentials
+      register: git_credentials_content
+      when: git_credentials_stat.stat.exists
+
+    - name: Decode Git credentials content
+      set_fact:
+        git_credentials: "{{ git_credentials_content.content | b64decode }}"
+      when: git_credentials_stat.stat.exists
+
+    - name: Fail if Git credentials not configured and vars not provided
+      fail:
+        msg: >
+          Git credentials not found and GITHUB_USERNAME/GITHUB_TOKEN not provided. Aborting.
+      when: >
+        (not git_credentials_stat.stat.exists or
+        ("{{ GITHUB_USERNAME }}" not in git_credentials | default(''))) and
+        (GITHUB_USERNAME is not defined or GITHUB_TOKEN is not defined)
+
+    - name: Configure Git with GitHub token if not already configured
+      shell: |
+        git config --global credential.helper store
+        echo "https://{{ GITHUB_USERNAME }}:{{ GITHUB_TOKEN }}@github.com" > ~/.git-credentials
+      become: yes
+      when: >
+        (not git_credentials_stat.stat.exists or
+        ("{{ GITHUB_USERNAME }}" not in git_credentials | default(''))) and
+        (GITHUB_USERNAME is defined and GITHUB_TOKEN is defined)
+
+    # --- Git Clone or Pull Logic ---
+    - name: Check if .git directory exists (repo already cloned)
+      stat:
+        path: "{{ project_dest_dir }}/.git"
+      register: project_dir_stat
+
+    - name: Pull latest changes if repository already exists
+      shell: |
+        cd {{ project_dest_dir }}
+        git remote set-url origin {{ GITHUB_PROJECT_URL }}
+        git fetch origin
+        git checkout {{ GITHUB_BRANCH }}
+        git pull origin {{ GITHUB_BRANCH }}
+      when: project_dir_stat.stat.exists
+      become: yes
+
+    - name: Clone the Project repository if not already cloned
+      git:
+        repo: "{{ GITHUB_PROJECT_URL }}"
+        dest: "{{ project_dest_dir }}"
+        version: "{{ GITHUB_BRANCH }}"
+        depth: 1
+      when: not project_dir_stat.stat.exists
+      become: yes

vm_tool/vm_setup/inventory.yml

@@ -0,0 +1 @@
+localhost ansible_connection=local

vm_tool/vm_setup/k8s.yml

@@ -0,0 +1,15 @@
+---
+- name: Install K3s
+  hosts: all
+  become: true
+  tasks:
+    - name: Install K3s
+      shell: curl -sfL https://get.k3s.io | sh -
+      args:
+        creates: /usr/local/bin/k3s
+
+    - name: Get Kubeconfig
+      fetch:
+        src: /etc/rancher/k3s/k3s.yaml
+        dest: "{{ lookup('env', 'HOME') }}/.kube/config_k3s"
+        flat: true

vm_tool/vm_setup/main.yml

@@ -0,0 +1,27 @@
+- name: Main Playbook
+  hosts: all
+  gather_facts: yes
+
+  tasks:
+    - name: Setup
+      include_tasks: setup.yml
+
+    - name: Git Configuration
+      include_tasks: github/git_configuration.yml
+      when: DEPLOY_MODE | default('pull') != 'push'
+
+    - name: Push Code (Zero Touch)
+      include_tasks: push_code.yml
+      when: DEPLOY_MODE | default('pull') == 'push'
+
+    - name: Setup Project Environment File
+      include_tasks: setup_project_env.yml
+
+    - name: Docker Setup
+      include_tasks: docker/docker_setup.yml
+
+    - name: Project Service
+      include_tasks: project_service.yml
+
+    - name: Cleanup
+      include_tasks: cleanup.yml

vm_tool/vm_setup/monitoring.yml

@@ -0,0 +1,42 @@
+---
+- name: Install Monitoring Stack
+  hosts: all
+  become: true
+  tasks:
+    - name: Create monitoring directory
+      file:
+        path: /opt/monitoring
+        state: directory
+
+    - name: Create docker-compose.yml for monitoring
+      copy:
+        dest: /opt/monitoring/docker-compose.yml
+        content: |
+          version: '3'
+          services:
+            prometheus:
+              image: prom/prometheus
+              ports:
+                - 9090:9090
+              volumes:
+                - ./prometheus.yml:/etc/prometheus/prometheus.yml
+            grafana:
+              image: grafana/grafana
+              ports:
+                - 3000:3000
+    
+    - name: Create prometheus config
+      copy:
+        dest: /opt/monitoring/prometheus.yml
+        content: |
+          global:
+            scrape_interval: 15s
+          scrape_configs:
+            - job_name: 'prometheus'
+              static_configs:
+                - targets: ['localhost:9090']
+
+    - name: Start monitoring services
+      command: docker compose up -d
+      args:
+        chdir: /opt/monitoring

vm_tool/vm_setup/project_service.yml

@@ -0,0 +1,17 @@
+- name: Project Service Playbook
+  block:
+    - name: Set systemd service unit variables
+      set_fact:
+        systemd_unit_name: "{{ project_name }}-{{ branch_name }}.service"
+        systemd_unit_path: "/etc/systemd/system/{{ systemd_unit_name }}.service"
+
+    - name: Create Docker Service 
+      include_tasks: docker/create_docker_service.yml
+
+    - name: Enable and start service
+      ansible.builtin.systemd:
+        name: "{{ systemd_unit_name }}"
+        state: started
+        enabled: yes
+      become: yes
+      ignore_errors: yes

vm_tool/vm_setup/push_code.yml

@@ -0,0 +1,40 @@
+- name: Push Code Playbook
+  block:
+    - name: Ensure project directory exists
+      file:
+        path: "{{ project_dest_dir }}"
+        state: directory
+        mode: '0755'
+
+    - name: Copy project files to target
+      copy:
+        src: "{{ playbook_dir }}/../../" 
+        dest: "{{ project_dest_dir }}/"
+        # Note: In ansible-runner, playbook_dir is inside private_data_dir/project/vm_setup.
+        # We need to be careful about the source path.
+        # However, ansible_runner isolates execution.
+        # Better approach: Pass SOURCE_PATH as extravar.
+      when: false # Placeholder, we will use synchronize or better strategy.
+
+    # Re-thinking: simple 'copy' of just the compose file is safer for now if we don't know build context.
+    # But usually context is needed. 
+    # Let's rely on 'synchronize' (rsync) if available, or just copy the compose file if user only provided that.
+    
+    # For MVP of 'deploy-docker', let's copy the DOCKER_COMPOSE_FILE_PATH and .env if exists.
+    - name: Copy Docker Compose file
+      copy:
+        src: "{{ SOURCE_PATH }}/{{ DOCKER_COMPOSE_FILE_PATH }}"
+        dest: "{{ project_dest_dir }}/{{ DOCKER_COMPOSE_FILE_PATH }}"
+
+    - name: Copy Env file
+      copy:
+        src: "{{ SOURCE_PATH }}/{{ ENV_FILE_PATH | default('.env') }}"
+        dest: "{{ project_dest_dir }}/{{ ENV_FILE_PATH | default('.env') }}"
+      failed_when: false
+
+    - name: Deploy application
+      shell: "{{ DEPLOY_COMMAND | default('docker-compose up -d --remove-orphans') }}"
+      args:
+        chdir: "{{ project_dest_dir }}"
+      environment:
+        GITHUB_REPOSITORY_OWNER: "{{ GITHUB_REPOSITORY_OWNER | default('') }}"

vm_tool/vm_setup/setup.yml

@@ -0,0 +1,17 @@
+- name: Setup VM
+  block:
+    # --- Extract Project Name from GITHUB_PROJECT_URL ---
+    - name: Extract project name from GITHUB_PROJECT_URL
+      set_fact:
+        project_name: "{{ GITHUB_PROJECT_URL | basename | regex_replace('\\.git$', '') }}"
+
+    # --- Set project_dest_dir based on EXECUTION_TYPE ---
+    - name: Set project_dest_dir variable for cloud
+      set_fact:
+        project_dest_dir: "{{ ansible_user_dir }}/{{ project_name }}"
+      when: EXECUTION_TYPE == "cloud"
+
+    - name: Set project_dest_dir variable for normal
+      set_fact:
+        project_dest_dir: "{{ playbook_dir }}/{{ project_name }}"
+      when: EXECUTION_TYPE == "normal"

vm_tool/vm_setup/setup_project_env.yml

@@ -0,0 +1,7 @@
+---
+- name: Create environment file if env_path and env_data are provided
+  when: ENV_PATH is defined and ENV_DATA is defined and PROJECT_PATH is defined
+  copy:
+    dest: "{{ project_dest_dir }}/{{ ENV_PATH }}"
+    content: "{{ ENV_DATA | to_nice_yaml }}"
+    mode: '0644'

vm_tool/webhooks.py

@@ -0,0 +1,83 @@
+"""Webhook support for deployment notifications."""
+
+import json
+import logging
+from typing import Any, Dict, Optional
+from datetime import datetime
+
+import requests
+
+logger = logging.getLogger(__name__)
+
+
+class WebhookSender:
+    """Send webhook notifications for deployment events."""
+
+    def __init__(self, webhook_url: Optional[str] = None):
+        self.webhook_url = webhook_url
+
+    def send(
+        self, event: str, data: Dict[str, Any], webhook_url: Optional[str] = None
+    ) -> bool:
+        """Send webhook notification.
+
+        Args:
+            event: Event type (e.g., 'deployment.success', 'deployment.failed')
+            data: Event data
+            webhook_url: Override default webhook URL
+
+        Returns:
+            True if webhook sent successfully, False otherwise
+        """
+        url = webhook_url or self.webhook_url
+        if not url:
+            logger.warning("No webhook URL configured")
+            return False
+
+        payload = {
+            "event": event,
+            "timestamp": datetime.utcnow().isoformat() + "Z",
+            "data": data,
+        }
+
+        try:
+            response = requests.post(
+                url,
+                json=payload,
+                headers={"Content-Type": "application/json"},
+                timeout=10,
+            )
+            response.raise_for_status()
+            logger.info(f"Webhook sent successfully: {event}")
+            return True
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Failed to send webhook: {e}")
+            return False
+
+    def deployment_started(self, host: str, **kwargs):
+        """Send deployment started event."""
+        return self.send("deployment.started", {"host": host, **kwargs})
+
+    def deployment_success(self, host: str, duration: float, **kwargs):
+        """Send deployment success event."""
+        return self.send(
+            "deployment.success", {"host": host, "duration_seconds": duration, **kwargs}
+        )
+
+    def deployment_failed(self, host: str, error: str, **kwargs):
+        """Send deployment failed event."""
+        return self.send("deployment.failed", {"host": host, "error": error, **kwargs})
+
+    def rollback_started(self, host: str, **kwargs):
+        """Send rollback started event."""
+        return self.send("rollback.started", {"host": host, **kwargs})
+
+    def rollback_success(self, host: str, **kwargs):
+        """Send rollback success event."""
+        return self.send("rollback.success", {"host": host, **kwargs})
+
+    def health_check_failed(self, host: str, check_type: str, **kwargs):
+        """Send health check failed event."""
+        return self.send(
+            "health_check.failed", {"host": host, "check_type": check_type, **kwargs}
+        )

vm_tool-1.0.32.dist-info/METADATA

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: vm_tool
+Version: 1.0.32
+Summary: A Comprehensive Tool for Setting Up Virtual Machines.
+Home-page: https://github.com/thesunnysinha/vm_tool
+Author: Sunny Sinha
+Author-email: Sunny Sinha <thesunnysinha@gmail.com>
+License: MIT
+Project-URL: Documentation, https://vm-tool.sunnysinha.online/
+Project-URL: Source, https://github.com/thesunnysinha/vm_tool
+Project-URL: Tracker, https://github.com/thesunnysinha/vm_tool/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+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 :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ansible
+Requires-Dist: ansible-runner
+Requires-Dist: paramiko
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: check-manifest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: bump-my-version; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings[python]; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# 🚀 VM Setup Tool
+
+[![PyPI version](https://img.shields.io/pypi/v/vm-tool.svg)](https://pypi.org/project/vm-tool/) [![Python versions](https://img.shields.io/pypi/pyversions/vm-tool.svg)](https://pypi.org/project/vm-tool/)
+
+[**Documentation**](https://vm-tool.sunnysinha.online/) • [**PyPI**](https://pypi.org/project/vm-tool/) • [**GitHub**](https://github.com/thesunnysinha/vm_tool) • [**Contributing**](CONTRIBUTING) • [**License**](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:
+
+```bash
+pip install vm-tool
+```
+
+---
+
+## 🛠️ Usage Examples
+
+### 🚀 Universal Deployment (CLI)
+
+#### 1. Generate CI/CD Pipeline
+
+Bootstrap your project with a complete GitHub Actions workflow:
+
+```bash
+vm_tool generate-pipeline
+```
+
+#### 2. Provision Infrastructure
+
+Provision cloud resources using Terraform (requires Terraform installed):
+
+```bash
+vm_tool provision --provider aws --action apply --vars region=us-east-1
+```
+
+#### 3. Setup Kubernetes (K3s)
+
+Deploy a lightweight Kubernetes cluster to your servers:
+
+```bash
+vm_tool setup-k8s --inventory inventory.yml
+```
+
+#### 4. Setup Observability
+
+Deploy Prometheus and Grafana for instant monitoring:
+
+```bash
+vm_tool setup-monitoring --inventory inventory.yml
+```
+
+### 🐍 Python API Usage
+
+#### Automated Local VM Setup
+
+```python
+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)
+
+```python
+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
+
+```python
+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:
+
+```bash
+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](https://vm-tool.sunnysinha.online/) for complete guides. Visit the [PyPI page](https://pypi.org/project/vm-tool/) for generic details, or the [GitHub repository](https://github.com/thesunnysinha/vm_tool) for code and issues.
+
+---
+
+Empower your infrastructure automation with **VM Setup Tool** – fast, reliable, and developer-friendly!