vm-tool 1.0.11__tar.gz → 1.0.13__tar.gz

{vm_tool-1.0.11/vm_tool.egg-info → vm_tool-1.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.11
+Version: 1.0.13
 Summary: A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.
 License: MIT
 Description-Content-Type: text/markdown
@@ -15,7 +15,7 @@ Dynamic: requires-dist
 Dynamic: summary
 
 # **VM Setup Tool**  
-### **A Comprehensive Solution for Streamlining Virtual Machine Configuration with Ansible**
+### **A Comprehensive Solution for Streamlining Virtual Machine Configuration**
 
 ## **Overview**  
 The **VM Setup Tool** is an efficient, user-friendly solution designed to simplify the process of setting up and managing virtual machines (VMs) using Ansible. Ideal for automating VM deployment and configuration, this tool ensures consistency and enhances operational efficiency across your infrastructure.
@@ -65,6 +65,36 @@ By automating these tasks, the tool minimizes errors and saves time, allowing yo
 
 ---
 
+## **Cloud Setup**  
+The **VM Setup Tool** also supports cloud setup for VMs. Use the following example to configure and run the cloud setup:
+
+```python
+from vm_tool.runner import SetupRunner
+
+runner = SetupRunner(
+    github_username='your_github_username',  # e.g., username
+    github_token='your_github_token',        # e.g., token
+    github_project_url='your_github_project_url'  # e.g., https://github.com/username/repo
+)
+
+runner.run_cloud_setup(
+    ssh_username='your_ssh_username',        # e.g., ssh_user
+    ssh_password='your_ssh_password',        # e.g., ssh_password
+    ssh_hostname='your_ssh_hostname'         # e.g., ssh.example.com
+)
+```
+
+### **What Happens During Cloud Setup**  
+When you run the cloud setup, the tool will:  
+1. Connect to the specified cloud VM using SSH.  
+2. Clone the specified GitHub repository to the VM.  
+3. Install **Docker** if it’s not already available on the VM.  
+4. Install **Docker Compose** for managing multi-container applications.  
+5. Create, enable, and start the Docker service on the VM.  
+6. Ensure the Docker container remains active, providing a robust environment for your applications.  
+
+---
+
 ## **SSH Client Feature**  
 The **VM Setup Tool** also includes a dedicated **SSH client** feature to simplify the configuration of SSH access for VMs, including automated SSH key generation and management.
 

vm_tool-1.0.13/README.md

@@ -0,0 +1,111 @@
+# **VM Setup Tool**  
+### **A Comprehensive Solution for Streamlining Virtual Machine Configuration**
+
+## **Overview**  
+The **VM Setup Tool** is an efficient, user-friendly solution designed to simplify the process of setting up and managing virtual machines (VMs) using Ansible. Ideal for automating VM deployment and configuration, this tool ensures consistency and enhances operational efficiency across your infrastructure.
+
+---
+
+## **Pre-requisites**  
+This tool supports projects utilizing **Docker Compose**. Ensure that a `docker-compose.yml` file is present at the root of your project directory before proceeding.
+
+---
+
+## **Installation**  
+Install the VM Setup Tool using **pip**, the Python package manager:  
+
+```bash
+pip install vm-tool
+```
+
+---
+
+## **Example Usage**  
+
+### **Automated VM Setup**  
+Use the following example to configure and run the VM setup:  
+
+```python
+from vm_tool.runner import SetupRunner
+
+runner = SetupRunner(
+    github_username='your_github_username',  # e.g., username
+    github_token='your_github_token',        # e.g., token
+    github_project_url='your_github_project_url'  # e.g., https://github.com/username/repo
+)
+
+runner.run_setup()
+```
+
+### **What Happens During Setup**  
+The VM Setup Tool will:  
+1. Clone the specified GitHub repository to your local machine.  
+2. Install **Docker** if it’s not already available on the target machine.  
+3. Install **Docker Compose** for managing multi-container applications.  
+4. Create, enable, and start the Docker service.  
+5. Ensure the Docker container remains active, providing a robust environment for your applications.  
+
+By automating these tasks, the tool minimizes errors and saves time, allowing you to focus on development and deployment.
+
+---
+
+## **Cloud Setup**  
+The **VM Setup Tool** also supports cloud setup for VMs. Use the following example to configure and run the cloud setup:
+
+```python
+from vm_tool.runner import SetupRunner
+
+runner = SetupRunner(
+    github_username='your_github_username',  # e.g., username
+    github_token='your_github_token',        # e.g., token
+    github_project_url='your_github_project_url'  # e.g., https://github.com/username/repo
+)
+
+runner.run_cloud_setup(
+    ssh_username='your_ssh_username',        # e.g., ssh_user
+    ssh_password='your_ssh_password',        # e.g., ssh_password
+    ssh_hostname='your_ssh_hostname'         # e.g., ssh.example.com
+)
+```
+
+### **What Happens During Cloud Setup**  
+When you run the cloud setup, the tool will:  
+1. Connect to the specified cloud VM using SSH.  
+2. Clone the specified GitHub repository to the VM.  
+3. Install **Docker** if it’s not already available on the VM.  
+4. Install **Docker Compose** for managing multi-container applications.  
+5. Create, enable, and start the Docker service on the VM.  
+6. Ensure the Docker container remains active, providing a robust environment for your applications.  
+
+---
+
+## **SSH Client Feature**  
+The **VM Setup Tool** also includes a dedicated **SSH client** feature to simplify the configuration of SSH access for VMs, including automated SSH key generation and management.
+
+### **Example Usage**  
+
+```python
+from vm_tool.ssh import SSHSetup
+
+ssh_setup = SSHSetup(
+    hostname='your_vm_hostname',  # e.g., vm.example.com
+    username='your_vm_username',  # e.g., user
+    password='your_vm_password',  # e.g., password
+    email='your_email_for_ssh_key'  # e.g., user@example.com
+)
+
+ssh_setup.setup()
+```
+
+### **What Happens During SSH Setup**  
+When you run the SSH setup, the tool will:  
+1. Generate an SSH key pair if none exists.  
+2. Read the public SSH key or create a new one if necessary.  
+3. Configure the VM by adding the public key to the VM's **authorized_keys** file.  
+4. Update the local SSH configuration file with the VM's details.  
+5. Establish an SSH connection to verify the setup.  
+6. Close the connection once setup is complete.  
+
+---
+
+With its comprehensive features, the **VM Setup Tool** eliminates the hassle of manual configurations and enables seamless integration of VMs into your workflows. Start using the tool today to automate and optimize your virtual machine setup process.

{vm_tool-1.0.11 → vm_tool-1.0.13}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 import os
 
 # Read the contents of README.md
-readme_path = os.path.join(os.path.dirname(__file__), 'Readme.md')
+readme_path = os.path.join(os.path.dirname(__file__), 'README.md')
 if os.path.exists(readme_path):
     with open(readme_path, encoding='utf-8') as f:
         long_description = f.read()
@@ -11,7 +11,7 @@ else:
 
 setup(
     name='vm_tool',
-    version='1.0.11',  # This will be updated by bump2version
+    version='1.0.13',  # This will be updated by bump2version
     packages=find_packages(),
     description='A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.',
     long_description=long_description,

{vm_tool-1.0.11 → vm_tool-1.0.13}/vm_tool/cli.py

@@ -2,7 +2,7 @@ import argparse
 
 def main():
     parser = argparse.ArgumentParser(description='Setup VMs using Ansible.')
-    parser.add_argument('--version', action='version', version='1.0.11')
+    parser.add_argument('--version', action='version', version='1.0.13')
 
     args = parser.parse_args()
 

{vm_tool-1.0.11 → vm_tool-1.0.13}/vm_tool/runner.py

@@ -30,6 +30,48 @@ class SetupRunner:
         playbook_path = os.path.join(current_dir, 'vm_setup', 'setup.yml')
         inventory_path = os.path.join(current_dir, 'vm_setup', 'inventory.yml')
 
+        try:
+            # Run the Ansible playbook using ansible-runner
+            r = ansible_runner.run(
+                private_data_dir=venv_dir,
+                playbook=playbook_path,
+                inventory=inventory_path,
+                extravars=extravars
+            )
+
+            if r.rc != 0:
+                raise RuntimeError(f"Ansible playbook execution failed with return code {r.rc}: {r.stdout}")
+
+        except Exception as e:
+            raise RuntimeError(f"An error occurred while running the Ansible playbook: {str(e)}")
+        
+    
+    def run_cloud_setup(self,ssh_username,ssh_password,ssh_hostname):
+        # Construct extravars dictionary
+        extravars = {
+            'SSH_USERNAME': ssh_username,
+            'SSH_PASSWORD': ssh_password,
+            'SSH_HOSTNAME': ssh_hostname,
+            'GITHUB_USERNAME': self.github_username,
+            'GITHUB_TOKEN': self.github_token,
+            'GITHUB_PROJECT_URL': self.github_project_url
+
+        }
+
+        # Get the current directory of this script
+        current_dir = os.path.dirname(os.path.abspath(__file__))
+
+        # Get the virtual environment directory
+        venv_dir = os.path.join(sys.prefix, 'ansible_runner_data')
+
+        # Ensure the directory exists
+        os.makedirs(venv_dir, exist_ok=True)
+
+
+        # Construct dynamic paths
+        playbook_path = os.path.join(current_dir, 'vm_setup', 'setup.yml')
+        inventory_path = os.path.join(current_dir, 'vm_setup', 'cloud_inventory.yml')
+
         try:
             # Run the Ansible playbook using ansible-runner
             r = ansible_runner.run(

vm_tool-1.0.13/vm_tool/vm_setup/cloud_inventory.yml

@@ -0,0 +1,8 @@
+all:
+  hosts:
+    cloud_host:
+      ansible_host: "{{ SSH_HOSTNAME }}"
+      ansible_user: "{{ SSH_USERNAME }}"
+      ansible_ssh_pass: "{{ SSH_PASSWORD }}"
+  vars:
+    ansible_python_interpreter: /usr/bin/python3

{vm_tool-1.0.11 → vm_tool-1.0.13}/vm_tool/vm_setup/setup.yml

@@ -3,25 +3,17 @@
   gather_facts: yes
 
   vars:
-    github_project_url: "{{ lookup('env', 'GITHUB_PROJECT_URL') }}"
-    github_username: "{{ lookup('env', 'GITHUB_USERNAME') }}"
-    github_token: "{{ lookup('env', 'GITHUB_TOKEN') }}"
-    static_playbook_dir: "{{playbook_dir}}"
+    static_playbook_dir: "{{ playbook_dir }}"
 
   tasks:
-
     - name: Set project_dest_dir variable
       set_fact:
         project_dest_dir: "{{ static_playbook_dir }}/project"
-
-    - name: Set project_repo_url variable
-      set_fact:
-        project_repo_url: "{{ github_project_url }}"
     
     - name: Configure Git with GitHub token
       shell: |
         git config --global credential.helper store
-        echo "https://{{ github_username }}:{{ github_token }}@github.com" > ~/.git-credentials
+        echo "https://{{ GITHUB_USERNAME }}:{{ GITHUB_TOKEN }}@github.com" > ~/.git-credentials
       become: yes
     
     - name: Remove existing Project repository if present
@@ -33,7 +25,7 @@
 
     - name: Clone the Project repository
       git:
-        repo: "{{ project_repo_url }}"
+        repo: "{{ GITHUB_PROJECT_URL }}"
         dest: "{{ project_dest_dir }}"
         version: main
       become: yes
@@ -54,4 +46,25 @@
         state: started
         enabled: yes
       become: yes
-      ignore_errors: yes
+      ignore_errors: yes
+
+    # Cleanup section
+    - name: Remove GitHub credentials from git-credentials
+      file:
+        path: ~/.git-credentials
+        state: absent
+      become: yes
+
+    - name: Clear Git credential helper configuration
+      shell: git config --global --unset credential.helper
+      become: yes
+
+    - name: Unset environment variables
+      shell: |
+        unset GITHUB_PROJECT_URL
+        unset GITHUB_USERNAME
+        unset GITHUB_TOKEN
+      environment:
+        GITHUB_PROJECT_URL: "{{ GITHUB_PROJECT_URL }}"
+        GITHUB_USERNAME: "{{ GITHUB_USERNAME }}"
+        GITHUB_TOKEN: "{{ GITHUB_TOKEN }}"

{vm_tool-1.0.11 → vm_tool-1.0.13/vm_tool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.11
+Version: 1.0.13
 Summary: A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.
 License: MIT
 Description-Content-Type: text/markdown
@@ -15,7 +15,7 @@ Dynamic: requires-dist
 Dynamic: summary
 
 # **VM Setup Tool**  
-### **A Comprehensive Solution for Streamlining Virtual Machine Configuration with Ansible**
+### **A Comprehensive Solution for Streamlining Virtual Machine Configuration**
 
 ## **Overview**  
 The **VM Setup Tool** is an efficient, user-friendly solution designed to simplify the process of setting up and managing virtual machines (VMs) using Ansible. Ideal for automating VM deployment and configuration, this tool ensures consistency and enhances operational efficiency across your infrastructure.
@@ -65,6 +65,36 @@ By automating these tasks, the tool minimizes errors and saves time, allowing yo
 
 ---
 
+## **Cloud Setup**  
+The **VM Setup Tool** also supports cloud setup for VMs. Use the following example to configure and run the cloud setup:
+
+```python
+from vm_tool.runner import SetupRunner
+
+runner = SetupRunner(
+    github_username='your_github_username',  # e.g., username
+    github_token='your_github_token',        # e.g., token
+    github_project_url='your_github_project_url'  # e.g., https://github.com/username/repo
+)
+
+runner.run_cloud_setup(
+    ssh_username='your_ssh_username',        # e.g., ssh_user
+    ssh_password='your_ssh_password',        # e.g., ssh_password
+    ssh_hostname='your_ssh_hostname'         # e.g., ssh.example.com
+)
+```
+
+### **What Happens During Cloud Setup**  
+When you run the cloud setup, the tool will:  
+1. Connect to the specified cloud VM using SSH.  
+2. Clone the specified GitHub repository to the VM.  
+3. Install **Docker** if it’s not already available on the VM.  
+4. Install **Docker Compose** for managing multi-container applications.  
+5. Create, enable, and start the Docker service on the VM.  
+6. Ensure the Docker container remains active, providing a robust environment for your applications.  
+
+---
+
 ## **SSH Client Feature**  
 The **VM Setup Tool** also includes a dedicated **SSH client** feature to simplify the configuration of SSH access for VMs, including automated SSH key generation and management.
 

{vm_tool-1.0.11 → vm_tool-1.0.13}/vm_tool.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 LICENSE
 MANIFEST.in
+README.md
 setup.py
 vm_tool/__init__.py
 vm_tool/cli.py
@@ -11,6 +12,7 @@ vm_tool.egg-info/dependency_links.txt
 vm_tool.egg-info/entry_points.txt
 vm_tool.egg-info/requires.txt
 vm_tool.egg-info/top_level.txt
+vm_tool/vm_setup/cloud_inventory.yml
 vm_tool/vm_setup/inventory.yml
 vm_tool/vm_setup/setup.yml
 vm_tool/vm_setup/docker/create_docker_service.yml