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

vm_tool-1.0.12/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include vm_tool/vm_setup *

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.10
+Version: 1.0.12
 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.

vm_tool-1.0.12/README.md

@@ -0,0 +1,81 @@
+# **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.
+
+---
+
+## **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.10 → vm_tool-1.0.12}/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.10',  # This will be updated by bump2version
+    version='1.0.12',  # 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.10 → vm_tool-1.0.12}/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.10')
+    parser.add_argument('--version', action='version', version='1.0.12')
 
     args = parser.parse_args()
 

vm_tool-1.0.12/vm_tool/vm_setup/docker/create_docker_service.yml

@@ -0,0 +1,53 @@
+- name: Clean up Docker Environment and Set up Docker Service
+  block:
+    - name: Check if Docker Service File Exists
+      ansible.builtin.stat:
+        path: "{{ service_file_path }}"
+      register: service_file_stat
+    
+    - name: Stop project service and ignore errors
+      ansible.builtin.systemd:
+        name: project
+        state: stopped
+      ignore_errors: yes
+
+    # - name: Run Docker System Prune
+    #   ansible.builtin.command:
+    #     cmd: docker system prune -f
+    #   ignore_errors: yes
+
+    - name: Remove Existing Docker Service File
+      ansible.builtin.file:
+        path: "{{ service_file_path }}"
+        state: absent
+      when: service_file_stat.stat.exists
+
+    - name: Create Docker Service File
+      ansible.builtin.file:
+        path: "{{ service_file_path }}"
+        state: touch
+        mode: '0644'
+
+    - name: Insert Docker Service Configuration
+      ansible.builtin.blockinfile:
+        path: "{{ service_file_path }}"
+        block: |
+          [Unit]
+          Description=Project Docker Container
+          After=docker.service
+
+          [Service]
+          Type=simple
+          WorkingDirectory={{ project_dest_dir }}
+          ExecStart=docker compose -f docker-compose.yml up -d
+          Restart=always
+          RestartSec=10s
+
+          [Install]
+          WantedBy=multi-user.target
+
+    - name: Reload Systemd Daemon
+      ansible.builtin.systemd:
+        daemon_reload: yes
+
+  become: yes

vm_tool-1.0.12/vm_tool/vm_setup/docker/install_docker_and_compose.yml

@@ -0,0 +1,70 @@
+- 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: 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
+
+    - 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: Add Docker repository
+      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
+      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
+      ansible.builtin.apt:
+        name:
+          - docker-ce
+          - docker-ce-cli
+          - containerd.io
+          - docker-compose-plugin
+        state: present
+      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
+      
+    - name: Change permissions for Docker socket
+      ansible.builtin.command: sudo chmod 666 /var/run/docker.sock
+      ignore_errors: yes
+  become: yes

vm_tool-1.0.12/vm_tool/vm_setup/inventory.yml

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

vm_tool-1.0.12/vm_tool/vm_setup/setup.yml

@@ -0,0 +1,77 @@
+- name: Setup Docker and Docker Compose on Ubuntu
+  hosts: all
+  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
+      become: yes
+    
+    - name: Remove existing Project repository if present
+      file:
+        path: "{{ project_dest_dir }}"
+        state: absent
+        force: yes
+      become: yes
+
+    - name: Clone the Project repository
+      git:
+        repo: "{{ project_repo_url }}"
+        dest: "{{ project_dest_dir }}"
+        version: main
+      become: yes
+
+    - name: Set service_file_path variable
+      set_fact:
+        service_file_path: /etc/systemd/system/project.service
+
+    - name: Adding Docker and Compose packages
+      include_tasks: docker/install_docker_and_compose.yml
+
+    - name: Create Docker Service
+      include_tasks: docker/create_docker_service.yml
+
+    - name: Enable and start project service
+      ansible.builtin.systemd:
+        name: project
+        state: started
+        enabled: yes
+      become: 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.10 → vm_tool-1.0.12/vm_tool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: vm_tool
-Version: 1.0.10
+Version: 1.0.12
 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.

{vm_tool-1.0.10 → vm_tool-1.0.12}/vm_tool.egg-info/SOURCES.txt

@@ -1,4 +1,6 @@
 LICENSE
+MANIFEST.in
+README.md
 setup.py
 vm_tool/__init__.py
 vm_tool/cli.py
@@ -9,4 +11,8 @@ vm_tool.egg-info/SOURCES.txt
 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.egg-info/top_level.txt
+vm_tool/vm_setup/inventory.yml
+vm_tool/vm_setup/setup.yml
+vm_tool/vm_setup/docker/create_docker_service.yml
+vm_tool/vm_setup/docker/install_docker_and_compose.yml