docker-migration 0.1.0

A tool for migrating Docker applications between servers

Docker Migration Tool

This project provides a comprehensive solution for migrating Docker environments using Docker Compose. It automates the process of preparing Docker data, creating archives, transferring files to a new server, and reinstalling Docker on the new server.

Features

• Identifies Docker images, containers, networks, and other related data from the Docker Compose file.
• Creates backups of Docker data and packages them into zip or tar files.
• Optionally includes additional host files specified in the Docker Compose file.
• Transfers the created archives to a new server via VPN.
• Extracts the archives and reinstalls Docker on the new server.
• Validates the running state of Docker services after installation.

Project Structure

docker-migration-tool
├── src
│   ├── main.py                # Entry point of the application
│   ├── docker_utils           # Package for Docker utilities
│   │   ├── __init__.py
│   │   ├── compose_parser.py   # Parses Docker Compose files
│   │   └── docker_backup.py    # Handles Docker data backup
│   ├── archive                # Package for archiving utilities
│   │   ├── __init__.py
│   │   ├── archiver.py        # Creates and combines archives
│   │   └── extractor.py       # Extracts archives on the new server
│   ├── transfer               # Package for file transfer utilities
│   │   ├── __init__.py
│   │   └── file_transfer.py    # Transfers files via VPN
│   └── validation             # Package for validation utilities
│       ├── __init__.py
│       └── health_check.py     # Checks Docker service health
├── requirements.txt           # Project dependencies
├── setup.py                   # Packaging configuration
├── README.md                  # Project documentation
└── .gitignore                 # Git ignore file

Installation

1. Clone the repository:

   git clone <repository-url>
   cd docker-migration-tool
   

2. Install the required dependencies:

   pip install -r requirements.txt
   

Usage

Basic Usage

1. Navigate to the directory containing your Docker Compose file.
2. Run the migration tool:

   python src/main.py
   

3. Follow the prompts to complete the migration process.

Advanced Options

Backup Mode

python src/main.py --mode backup [options]

Options:

• --backup-all: Backup all Docker resources on the server instead of just those in docker-compose.yml
• --docker-src-base-dir PATH: Include a specific directory containing Docker source files in the backup
• --skip-images: Skip backing up Docker images (which can be large)
• --skip-containers: Skip backing up Docker containers
• --config-only: Only backup configurations (equivalent to using both --skip-images and --skip-containers)
• --pull-images: Pull Docker images defined in docker-compose.yml before backup
• --transfer: Transfer the backup to another location
• --destination PATH: Specify destination path (local path, user@host:/path for SCP, or ftp://user:pass@host/path for FTP)
• --ftp-user USERNAME: FTP username (if not specified in destination)
• --ftp-pass PASSWORD: FTP password (if not specified in destination)
• --no-prompt: Do not prompt for user input (useful for scripted operations)

Restore Mode

python src/main.py --mode restore --backup-file PATH [options]

Options:

• --backup-file PATH: Path to backup file (required for restore mode)
• --compose-file-path PATH: Path to docker-compose.yml file for restoration
• --extract-only: Extract files without restoring Docker components
• --target-dir PATH: Directory to extract application files to (for extract-only mode)

Use Cases

1. Server Migration: Migrate a complete Docker environment from one server to another.
2. Environment Backup: Create a backup of your Docker environment before making significant changes.
3. Disaster Recovery: Restore Docker services quickly after a system failure.
4. Dev/Test Cloning: Clone a production environment to development or testing servers.
5. Configuration Extraction: Extract only configuration files without the Docker images for lightweight backups.
6. Selective Migration: Migrate specific components of your Docker environment by using skip options.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.