vm-tool 1.0.21__tar.gz → 1.0.24__tar.gz

{vm_tool-1.0.21/vm_tool.egg-info → vm_tool-1.0.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.21
+Version: 1.0.24
 Summary: A Comprehensive Tool for Setting Up Virtual Machines.
 Home-page: https://github.com/thesunnysinha/vm_tool
 Author: Sunny Sinha
@@ -86,6 +86,7 @@ config = SetupRunnerConfig(
     github_username='your_github_username',  # Required if the repository is private, e.g., username
     github_token='your_github_token',        # Required if the repository is private, e.g., token
     github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
+    github_branch='your_branch_name',        # Optional, defaults to 'main'
     docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
     dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
     dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
@@ -120,6 +121,7 @@ config = SetupRunnerConfig(
     github_username='your_github_username',  # Required if the repository is private, e.g., username
     github_token='your_github_token',        # Required if the repository is private, e.g., token
     github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
+    github_branch='your_branch_name',        # Optional, defaults to 'main'
     docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
     dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
     dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
@@ -130,13 +132,15 @@ runner = SetupRunner(config)
 ssh_configs = [
     SSHConfig(
         ssh_username='your_ssh_username_1',        # e.g., ssh_user_1
-        ssh_password='your_ssh_password_1',        # e.g., ssh_password_1
-        ssh_hostname='your_ssh_hostname_1'         # e.g., ssh1.example.com
+        ssh_password='your_ssh_password_1',        # Optional, only use if you don’t want to use SSH key
+        ssh_hostname='your_ssh_hostname_1',         # e.g., ssh1.example.com
+        ssh_identity_file='/path/to/your/ssh_key_1'            # Optional, path to SSH Identity file
     ),
     SSHConfig(
         ssh_username='your_ssh_username_2',        # e.g., ssh_user_2
-        ssh_password='your_ssh_password_2',        # e.g., ssh_password_2
-        ssh_hostname='your_ssh_hostname_2'         # e.g., ssh2.example.com
+        ssh_password='your_ssh_password_2',        # Optional, only use if you don’t want to use SSH key
+        ssh_hostname='your_ssh_hostname_2',         # e.g., ssh2.example.com
+        ssh_key='/path/to/your/ssh_key_2'            # Optional, path to SSH Identity file
     )
     # Add more SSHConfig instances as needed
 ]

{vm_tool-1.0.21 → vm_tool-1.0.24}/README.md

@@ -32,6 +32,7 @@ config = SetupRunnerConfig(
     github_username='your_github_username',  # Required if the repository is private, e.g., username
     github_token='your_github_token',        # Required if the repository is private, e.g., token
     github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
+    github_branch='your_branch_name',        # Optional, defaults to 'main'
     docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
     dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
     dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
@@ -66,6 +67,7 @@ config = SetupRunnerConfig(
     github_username='your_github_username',  # Required if the repository is private, e.g., username
     github_token='your_github_token',        # Required if the repository is private, e.g., token
     github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
+    github_branch='your_branch_name',        # Optional, defaults to 'main'
     docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
     dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
     dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
@@ -76,13 +78,15 @@ runner = SetupRunner(config)
 ssh_configs = [
     SSHConfig(
         ssh_username='your_ssh_username_1',        # e.g., ssh_user_1
-        ssh_password='your_ssh_password_1',        # e.g., ssh_password_1
-        ssh_hostname='your_ssh_hostname_1'         # e.g., ssh1.example.com
+        ssh_password='your_ssh_password_1',        # Optional, only use if you don’t want to use SSH key
+        ssh_hostname='your_ssh_hostname_1',         # e.g., ssh1.example.com
+        ssh_identity_file='/path/to/your/ssh_key_1'            # Optional, path to SSH Identity file
     ),
     SSHConfig(
         ssh_username='your_ssh_username_2',        # e.g., ssh_user_2
-        ssh_password='your_ssh_password_2',        # e.g., ssh_password_2
-        ssh_hostname='your_ssh_hostname_2'         # e.g., ssh2.example.com
+        ssh_password='your_ssh_password_2',        # Optional, only use if you don’t want to use SSH key
+        ssh_hostname='your_ssh_hostname_2',         # e.g., ssh2.example.com
+        ssh_key='/path/to/your/ssh_key_2'            # Optional, path to SSH Identity file
     )
     # Add more SSHConfig instances as needed
 ]

{vm_tool-1.0.21 → vm_tool-1.0.24}/setup.py

@@ -11,7 +11,7 @@ else:
 
 setup(
     name='vm_tool',
-    version='1.0.21',  # This will be updated by bump2version
+    version='1.0.24',  # This will be updated by bump2version
     packages=find_packages(),
     description='A Comprehensive Tool for Setting Up Virtual Machines.',
     long_description=long_description,

{vm_tool-1.0.21 → vm_tool-1.0.24}/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.21')
+    parser.add_argument('--version', action='version', version='1.0.24')
 
     args = parser.parse_args()
 

{vm_tool-1.0.21 → vm_tool-1.0.24}/vm_tool/runner.py

@@ -2,75 +2,123 @@ import sys
 import ansible_runner
 import os
 import yaml
-from pydantic import BaseModel, validator
+from pydantic import BaseModel, validator, model_validator
 from typing import List, Optional
 
 class SetupRunnerConfig(BaseModel):
+    """
+    Configuration model for setting up the runner.
+    
+    Attributes:
+        github_username (Optional[str]): GitHub username for authentication.
+        github_token (Optional[str]): GitHub token for authentication.
+        github_project_url (str): URL of the GitHub repository.
+        github_branch (str): GitHub branch to use (default: 'main').
+        docker_compose_file_path (str): Path to the Docker Compose file (default: 'docker-compose.yml').
+        dockerhub_username (Optional[str]): DockerHub username (optional).
+        dockerhub_password (Optional[str]): DockerHub password (required if username is provided).
+    """
+
     github_username: Optional[str] = None
     github_token: Optional[str] = None
     github_project_url: str
+    github_branch: str = "main"  # Default to main branch
     docker_compose_file_path: str = 'docker-compose.yml'
     dockerhub_username: Optional[str] = None
     dockerhub_password: Optional[str] = None
 
     @validator('docker_compose_file_path', pre=True, always=True)
     def set_default_docker_compose_file_path(cls, v):
+        """Ensures a default value for the Docker Compose file path."""
         return v or 'docker-compose.yml'
 
     @validator('dockerhub_password', always=True)
     def check_dockerhub_password(cls, v, values):
+        """Ensures that a password is provided if a DockerHub username is set."""
         if values.get('dockerhub_username') and not v:
             raise ValueError("DockerHub password must be provided if DockerHub username is specified")
         return v
-    
+
     @validator('dockerhub_username', always=True)
     def check_dockerhub_username(cls, v, values):
+        """Ensures that a username is provided if a DockerHub password is set."""
         if values.get('dockerhub_password') and not v:
             raise ValueError("DockerHub username must be provided if DockerHub password is specified")
         return v
-    
+
     @validator('github_token', always=True)
     def check_github_token(cls, v, values):
+        """Ensures that a GitHub token is provided if a GitHub username is set."""
         if values.get('github_username') and not v:
             raise ValueError("GitHub token must be provided if GitHub username is specified")
         return v
-    
+
     @validator('github_username', always=True)
     def check_github_username(cls, v, values):
+        """Ensures that a GitHub username is provided if a GitHub token is set."""
         if values.get('github_token') and not v:
             raise ValueError("GitHub username must be provided if GitHub token is specified")
         return v
 
 class SSHConfig(BaseModel):
+    """
+    Configuration model for SSH authentication.
+
+    Attributes:
+        ssh_username (str): SSH username.
+        ssh_hostname (str): SSH host/IP.
+        ssh_password (Optional[str]): SSH password (optional if identity file is provided).
+        ssh_identity_file (Optional[str]): Path to SSH private key file (optional if password is provided).
+    """
+
     ssh_username: str
-    ssh_password: str
     ssh_hostname: str
+    ssh_password: Optional[str] = None
+    ssh_identity_file: Optional[str] = None
+
+    @model_validator(mode="before")
+    def validate_authentication(cls, values):
+        """Ensures that either an SSH password or identity file is provided for authentication."""
+        password = values.get('ssh_password')
+        identity_file = values.get('ssh_identity_file')
+        if not password and not identity_file:
+            raise ValueError("Either ssh_password or ssh_identity_file must be provided.")
+        return values
 
 class SetupRunner:
+    """
+    Main class to handle setup execution.
+
+    Attributes:
+        github_username (str): GitHub username.
+        github_token (str): GitHub token.
+        github_project_url (str): GitHub repository URL.
+        github_branch (str): GitHub branch to use.
+        docker_compose_file_path (str): Path to Docker Compose file.
+        dockerhub_username (str): DockerHub username.
+        dockerhub_password (str): DockerHub password.
+    """
+
     def __init__(self, config: SetupRunnerConfig):
+        """Initializes the setup runner with the given configuration."""
         self.github_username = config.github_username
         self.github_token = config.github_token
         self.github_project_url = config.github_project_url
+        self.github_branch = config.github_branch
         self.docker_compose_file_path = config.docker_compose_file_path
         self.dockerhub_username = config.dockerhub_username
         self.dockerhub_password = config.dockerhub_password
 
     def _run_ansible_playbook(self, extravars, inventory_file):
-        # Get the current directory of this script
+        """Executes an Ansible playbook with the given variables and inventory."""
         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', 'main.yml')
         inventory_path = os.path.join(current_dir, 'vm_setup', inventory_file)
 
         try:
-            # Run the Ansible playbook using ansible-runner
             r = ansible_runner.run(
                 private_data_dir=venv_dir,
                 playbook=playbook_path,
@@ -85,11 +133,12 @@ class SetupRunner:
             raise RuntimeError(f"An error occurred while running the Ansible playbook: {str(e)}")
 
     def run_setup(self):
-        # Construct extravars dictionary
+        """Runs the setup process using Ansible."""
         extravars = {
             'GITHUB_USERNAME': self.github_username,
             'GITHUB_TOKEN': self.github_token,
             'GITHUB_PROJECT_URL': self.github_project_url,
+            'GITHUB_BRANCH': self.github_branch,
             'DOCKERHUB_USERNAME': self.dockerhub_username,
             'DOCKERHUB_PASSWORD': self.dockerhub_password,
             'EXECUTION_TYPE': "normal"
@@ -101,10 +150,9 @@ class SetupRunner:
         self._run_ansible_playbook(extravars, 'inventory.yml')
 
     def run_cloud_setup(self, ssh_configs: List[SSHConfig]):
-        # Define the path for the dynamic inventory file
+        """Runs the cloud setup using Ansible with dynamic inventory generation."""
         inventory_file_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'vm_setup', 'dynamic_inventory.yml')
 
-        # Create dynamic inventory content
         inventory_content = {
             'all': {
                 'hosts': {},
@@ -116,21 +164,25 @@ class SetupRunner:
 
         for i, ssh_config in enumerate(ssh_configs):
             host_key = f'cloud_host_{i}'
-            inventory_content['all']['hosts'][host_key] = {
+            host_entry = {
                 'ansible_host': ssh_config.ssh_hostname,
                 'ansible_user': ssh_config.ssh_username,
-                'ansible_ssh_pass': ssh_config.ssh_password
             }
+            if ssh_config.ssh_identity_file:
+                host_entry['ansible_ssh_private_key_file'] = ssh_config.ssh_identity_file
+            elif ssh_config.ssh_password:
+                host_entry['ansible_ssh_pass'] = ssh_config.ssh_password
+
+            inventory_content['all']['hosts'][host_key] = host_entry
 
-        # Write dynamic inventory to a file
         with open(inventory_file_path, 'w') as inventory_file:
             yaml.dump(inventory_content, inventory_file)
 
-        # Construct extravars dictionary
         extravars = {
             'GITHUB_USERNAME': self.github_username,
             'GITHUB_TOKEN': self.github_token,
             'GITHUB_PROJECT_URL': self.github_project_url,
+            'GITHUB_BRANCH': self.github_branch,
             'DOCKERHUB_USERNAME': self.dockerhub_username,
             'DOCKERHUB_PASSWORD': self.dockerhub_password,
             'EXECUTION_TYPE': "cloud"

{vm_tool-1.0.21 → vm_tool-1.0.24}/vm_tool/vm_setup/docker/install_docker_and_compose.yml

@@ -10,10 +10,28 @@
       register: docker_compose_installed
       ignore_errors: yes
 
-    # - name: Update apt package index
-    #   ansible.builtin.apt:
-    #     update_cache: yes
-    #   when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
+    - 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:
@@ -25,6 +43,7 @@
           - 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:
@@ -32,14 +51,14 @@
           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: Add Docker repository
+    - 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=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-      when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
-
-    - name: Set up the Docker stable repository
-      ansible.builtin.command: echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          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
@@ -47,7 +66,7 @@
         update_cache: yes
       when: docker_installed.rc != 0 or docker_compose_installed.rc != 0
 
-    - name: Install Docker and Docker Compose
+    - name: Install Docker and Docker Compose (if available in repo)
       ansible.builtin.apt:
         name:
           - docker-ce
@@ -55,6 +74,8 @@
           - 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
@@ -62,9 +83,10 @@
         name: docker
         enabled: yes
         state: started
-      when: docker_installed.rc != 0
-      
+      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-1.0.21 → vm_tool-1.0.24}/vm_tool/vm_setup/github/git_configuration.yml

@@ -1,5 +1,11 @@
 - name: Git Configuration Playbook
   block:
+    - name: Ensure Git is installed
+      package:
+        name: git
+        state: present
+      become: yes
+
     - name: Configure Git with GitHub token
       shell: |
         git config --global credential.helper store
@@ -7,16 +13,27 @@
       become: yes
       when: GITHUB_TOKEN is defined and GITHUB_USERNAME is defined
 
+    - name: Check if project directory exists
+      stat:
+        path: "{{ project_dest_dir }}"
+      register: project_dir_stat
+
     - name: Remove existing Project repository if present
       file:
         path: "{{ project_dest_dir }}"
         state: absent
         force: yes
       become: yes
+      when: project_dir_stat.stat.exists
+
+    - name: Log the GitHub repository being cloned
+      debug:
+        msg: "Cloning repository from {{ GITHUB_PROJECT_URL }} (branch: {{ GITHUB_BRANCH }})"
 
-    - name: Clone the Project repository
+    - name: Clone the Project repository with shallow clone
       git:
         repo: "{{ GITHUB_PROJECT_URL }}"
         dest: "{{ project_dest_dir }}"
-        version: main
-      become: yes
+        version: "{{ GITHUB_BRANCH }}"
+        depth: 1
+      become: yes

{vm_tool-1.0.21 → vm_tool-1.0.24}/vm_tool/vm_setup/main.yml

@@ -2,9 +2,6 @@
   hosts: all
   gather_facts: yes
 
-  vars:
-    static_playbook_dir: "{{ playbook_dir }}"
-
   tasks:
     - name: Setup
       include_tasks: setup.yml

vm_tool-1.0.24/vm_tool/vm_setup/setup.yml

@@ -0,0 +1,11 @@
+- name: Setup VM
+  block:
+    - name: Set project_dest_dir variable for cloud
+      set_fact:
+        project_dest_dir: "{{ ansible_user_dir }}/project"
+      when: EXECUTION_TYPE == "cloud"
+
+    - name: Set project_dest_dir variable for normal
+      set_fact:
+        project_dest_dir: "{{ playbook_dir }}/project"
+      when: EXECUTION_TYPE == "normal"

{vm_tool-1.0.21 → vm_tool-1.0.24/vm_tool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.21
+Version: 1.0.24
 Summary: A Comprehensive Tool for Setting Up Virtual Machines.
 Home-page: https://github.com/thesunnysinha/vm_tool
 Author: Sunny Sinha
@@ -86,6 +86,7 @@ config = SetupRunnerConfig(
     github_username='your_github_username',  # Required if the repository is private, e.g., username
     github_token='your_github_token',        # Required if the repository is private, e.g., token
     github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
+    github_branch='your_branch_name',        # Optional, defaults to 'main'
     docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
     dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
     dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
@@ -120,6 +121,7 @@ config = SetupRunnerConfig(
     github_username='your_github_username',  # Required if the repository is private, e.g., username
     github_token='your_github_token',        # Required if the repository is private, e.g., token
     github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
+    github_branch='your_branch_name',        # Optional, defaults to 'main'
     docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
     dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
     dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
@@ -130,13 +132,15 @@ runner = SetupRunner(config)
 ssh_configs = [
     SSHConfig(
         ssh_username='your_ssh_username_1',        # e.g., ssh_user_1
-        ssh_password='your_ssh_password_1',        # e.g., ssh_password_1
-        ssh_hostname='your_ssh_hostname_1'         # e.g., ssh1.example.com
+        ssh_password='your_ssh_password_1',        # Optional, only use if you don’t want to use SSH key
+        ssh_hostname='your_ssh_hostname_1',         # e.g., ssh1.example.com
+        ssh_identity_file='/path/to/your/ssh_key_1'            # Optional, path to SSH Identity file
     ),
     SSHConfig(
         ssh_username='your_ssh_username_2',        # e.g., ssh_user_2
-        ssh_password='your_ssh_password_2',        # e.g., ssh_password_2
-        ssh_hostname='your_ssh_hostname_2'         # e.g., ssh2.example.com
+        ssh_password='your_ssh_password_2',        # Optional, only use if you don’t want to use SSH key
+        ssh_hostname='your_ssh_hostname_2',         # e.g., ssh2.example.com
+        ssh_key='/path/to/your/ssh_key_2'            # Optional, path to SSH Identity file
     )
     # Add more SSHConfig instances as needed
 ]

vm_tool-1.0.21/vm_tool/vm_setup/setup.yml

@@ -1,5 +0,0 @@
-- name: Setup VM
-  block:
-    - name: Set project_dest_dir variable
-      set_fact:
-        project_dest_dir: "{{ static_playbook_dir }}/project"