vm-tool 1.0.12__tar.gz → 1.0.14__tar.gz

{vm_tool-1.0.12/vm_tool.egg-info → vm_tool-1.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.12
+Version: 1.0.14
 Summary: A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.
 License: MIT
 Description-Content-Type: text/markdown
@@ -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.12 → vm_tool-1.0.14}/README.md

@@ -49,6 +49,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.
 
@@ -78,4 +108,4 @@ When you run the SSH setup, the tool will:
 
 ---
 
-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.
+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.12 → vm_tool-1.0.14}/setup.py

@@ -11,7 +11,7 @@ else:
 
 setup(
     name='vm_tool',
-    version='1.0.12',  # This will be updated by bump2version
+    version='1.0.14',  # 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.12 → vm_tool-1.0.14}/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.12')
+    parser.add_argument('--version', action='version', version='1.0.14')
 
     args = parser.parse_args()
 

{vm_tool-1.0.12 → vm_tool-1.0.14}/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.12 → vm_tool-1.0.14}/vm_tool/ssh.py

@@ -32,7 +32,7 @@ class SSHSetup:
         self.client = paramiko.SSHClient()
         self.client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
 
-    def generate_ssh_key(self, email):
+    def __generate_ssh_key(self, email):
         """
         Generates an SSH key pair.
 
@@ -42,7 +42,7 @@ class SSHSetup:
         print(f"Generating SSH key for email: {email}")
         os.system(f'ssh-keygen -t rsa -b 4096 -C "{email}"')
 
-    def read_or_generate_public_key(self, email):
+    def __read_or_generate_public_key(self, email):
         """
         Reads the public SSH key or generates a new one if it doesn't exist.
 
@@ -54,12 +54,12 @@ class SSHSetup:
         """
         public_key_path = f'{self.private_key_path}.pub'
         if not os.path.exists(public_key_path):
-            self.generate_ssh_key(email)
+            self.__generate_ssh_key(email)
         with open(public_key_path, 'r') as file:
             print(f"Reading public key from {public_key_path}")
             return file.read()
 
-    def configure_vm(self, vm_ip, vm_password, public_key):
+    def __configure_vm(self, vm_ip, vm_password, public_key):
         """
         Configures the VM by adding the public SSH key to the authorized keys.
 
@@ -73,7 +73,7 @@ class SSHSetup:
         self.client.exec_command(f'echo "{public_key}" >> ~/.ssh/authorized_keys')
         self.client.close()
 
-    def update_ssh_config(self):
+    def __update_ssh_config(self):
         """
         Updates the local SSH config file with the VM details.
         """
@@ -89,14 +89,14 @@ Host {self.hostname}
         with open(f'{os.path.expanduser("~")}/.ssh/config', 'a') as file:
             file.write(config)
 
-    def establish_connection(self):
+    def __establish_connection(self):
         """
         Establishes an SSH connection to the VM.
         """
         print(f"Establishing SSH connection to {self.hostname}.")
         self.client.connect(self.hostname, username=self.username, key_filename=self.private_key_path)
 
-    def close_connection(self):
+    def __close_connection(self):
         """
         Closes the SSH connection.
         """
@@ -109,9 +109,9 @@ Host {self.hostname}
         Sets up the SSH configuration and keys for the VM.
         """
         print("Starting SSH setup.")
-        public_key = self.read_or_generate_public_key(self.email)
-        self.configure_vm(self.hostname, self.password, public_key)
-        self.update_ssh_config()
-        self.establish_connection()
-        self.close_connection()
+        public_key = self.__read_or_generate_public_key(self.email)
+        self.__configure_vm(self.hostname, self.password, public_key)
+        self.__update_ssh_config()
+        self.__establish_connection()
+        self.__close_connection()
         print("SSH setup completed.")

vm_tool-1.0.14/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.12 → vm_tool-1.0.14}/vm_tool/vm_setup/setup.yml

@@ -3,24 +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 }}"
 
   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
@@ -32,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
@@ -72,6 +65,6 @@
         unset GITHUB_USERNAME
         unset GITHUB_TOKEN
       environment:
-        GITHUB_PROJECT_URL: "{{ github_project_url }}"
-        GITHUB_USERNAME: "{{ github_username }}"
-        GITHUB_TOKEN: "{{ github_token }}"
+        GITHUB_PROJECT_URL: "{{ GITHUB_PROJECT_URL }}"
+        GITHUB_USERNAME: "{{ GITHUB_USERNAME }}"
+        GITHUB_TOKEN: "{{ GITHUB_TOKEN }}"

{vm_tool-1.0.12 → vm_tool-1.0.14/vm_tool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.12
+Version: 1.0.14
 Summary: A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.
 License: MIT
 Description-Content-Type: text/markdown
@@ -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.12 → vm_tool-1.0.14}/vm_tool.egg-info/SOURCES.txt

@@ -12,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