porting_an_lxc_to_docker
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| porting_an_lxc_to_docker [2024/08/11 04:03] – [3. Configuring Docker-Compose] oso | porting_an_lxc_to_docker [2024/10/17 21:42] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 37: | Line 37: | ||
| The process of containerizing the Flask application involved several key steps, including setting up the necessary dependencies, | The process of containerizing the Flask application involved several key steps, including setting up the necessary dependencies, | ||
| - | ====== | + | ====== Using Clean Docker Images for Python Apps and MariaDB ====== |
| When transitioning from LXC containers to Docker, it's often more efficient and cleaner to use base Docker images for your applications rather than attempting to convert existing LXC containers. This approach offers several advantages: | When transitioning from LXC containers to Docker, it's often more efficient and cleaner to use base Docker images for your applications rather than attempting to convert existing LXC containers. This approach offers several advantages: | ||
| Line 47: | Line 47: | ||
| ===== General Outline for Container Creation ===== | ===== General Outline for Container Creation ===== | ||
| - | Here’s a general outline of the steps to create Docker containers for a Python application | + | Here’s a general outline of the steps to create Docker containers for a Python application |
| - | + | ||
| - | ==== 1. Create Dockerfile for Python App ==== | + | |
| - | First, create a `Dockerfile` for your Python application. Use a base image like Debian or Alpine Ubuntu. | + | |
| - | + | ||
| - | * Create a `Dockerfile`: | + | |
| - | < | + | |
| - | FROM python: | + | |
| - | + | ||
| - | WORKDIR /app | + | |
| - | + | ||
| - | COPY requirements.txt requirements.txt | + | |
| - | RUN pip install -r requirements.txt | + | |
| - | + | ||
| - | COPY . . | + | |
| - | + | ||
| - | CMD [" | + | |
| - | </ | + | |
| - | + | ||
| - | * Build the Docker image: | + | |
| - | < | + | |
| - | docker build -t my-python-app . | + | |
| - | </ | + | |
| - | + | ||
| - | ==== 2. Create Dockerfile for MariaDB (optional) ==== | + | |
| - | Next, create a `Dockerfile` for MariaDB or use the official MariaDB image. | + | |
| - | + | ||
| - | * Use the official MariaDB image in your `docker-compose.yml`: | + | |
| - | < | + | |
| - | version: ' | + | |
| - | + | ||
| - | services: | + | |
| - | db: | + | |
| - | image: mariadb | + | |
| - | restart: always | + | |
| - | environment: | + | |
| - | MYSQL_ROOT_PASSWORD: | + | |
| - | MYSQL_DATABASE: | + | |
| - | MYSQL_USER: user | + | |
| - | MYSQL_PASSWORD: | + | |
| - | + | ||
| - | app: | + | |
| - | build: . | + | |
| - | ports: | + | |
| - | - " | + | |
| - | depends_on: | + | |
| - | - db | + | |
| - | </ | + | |
| - | + | ||
| - | ==== 3. Configure Docker Compose ==== | + | |
| - | Use Docker Compose to manage both containers. Create a `docker-compose.yml` file. | + | |
| - | + | ||
| - | * Example `docker-compose.yml`: | + | |
| - | < | + | |
| - | version: ' | + | |
| - | + | ||
| - | services: | + | |
| - | app: | + | |
| - | build: . | + | |
| - | ports: | + | |
| - | - " | + | |
| - | depends_on: | + | |
| - | - db | + | |
| - | + | ||
| - | db: | + | |
| - | image: mariadb | + | |
| - | restart: always | + | |
| - | environment: | + | |
| - | MYSQL_ROOT_PASSWORD: | + | |
| - | MYSQL_DATABASE: | + | |
| - | MYSQL_USER: user | + | |
| - | MYSQL_PASSWORD: | + | |
| - | </ | + | |
| - | + | ||
| - | ==== 4. Deploy Containers ==== | + | |
| - | Deploy your containers using Docker Compose. | + | |
| - | + | ||
| - | * Run the containers: | + | |
| - | < | + | |
| - | docker-compose up -d | + | |
| - | </ | + | |
| - | + | ||
| - | ==== 5. Test and Verify ==== | + | |
| - | Ensure that both containers are running and communicating correctly. | + | |
| - | + | ||
| - | * Check container status: | + | |
| - | < | + | |
| - | docker ps | + | |
| - | </ | + | |
| - | + | ||
| - | * Verify the application is accessible: | + | |
| - | Open your browser and navigate to `http:// | + | |
| - | + | ||
| - | ===== Conclusion ===== | + | |
| - | + | ||
| - | Using clean Docker images for your Python applications and databases provides a more maintainable, | + | |
| - | + | ||
| - | + | ||
| - | ===== V2 ===== | + | |
| ==== 1. Setting Up Dependencies ==== | ==== 1. Setting Up Dependencies ==== | ||
| Line 160: | Line 62: | ||
| The next step was to create a `Dockerfile` to define the environment for the Flask application. The Dockerfile included the following instructions: | The next step was to create a `Dockerfile` to define the environment for the Flask application. The Dockerfile included the following instructions: | ||
| - | < | + | < |
| FROM python: | FROM python: | ||
| + | |||
| + | # Install MariaDB Connector/C library and other dependencies | ||
| + | RUN apt-get update && apt-get install -y \ | ||
| + | libmariadb3 \ | ||
| + | libmariadb-dev \ | ||
| + | gcc \ | ||
| + | && apt-get clean \ | ||
| + | && rm -rf / | ||
| WORKDIR /app | WORKDIR /app | ||
| Line 175: | Line 85: | ||
| **Explanation**: | **Explanation**: | ||
| * `FROM python: | * `FROM python: | ||
| + | * **Explanation of MariaDB Connector/C and Dependencies** | ||
| + | <code dockerfile> | ||
| + | # Install MariaDB Connector/C library and other dependencies | ||
| + | RUN apt-get update && apt-get install -y \ | ||
| + | libmariadb3 \ | ||
| + | libmariadb-dev \ | ||
| + | gcc \ | ||
| + | && apt-get clean \ | ||
| + | && rm -rf / | ||
| + | </ | ||
| + | * **`RUN apt-get update && apt-get install -y \`**: | ||
| + | - This command updates the package list on the Debian-based slim image and installs the specified packages. | ||
| + | * **`libmariadb3`**: | ||
| + | - **What it is**: This is the shared library for MariaDB Connector/ | ||
| + | - **Why it’s needed**: If your Flask app interacts with a MariaDB database, this library allows it to establish that connection. | ||
| + | * **`libmariadb-dev`**: | ||
| + | - **What it is**: This is the development package for MariaDB Connector/ | ||
| + | - **Why it’s needed**: If you have Python packages in `requirements.txt` that need to compile C extensions (for example, `mysqlclient`), | ||
| + | * **`gcc`**: | ||
| + | - **What it is**: The GNU Compiler Collection, a compiler system that supports various programming languages. | ||
| + | - **Why it’s needed**: This is required to compile any C extensions or Python packages that need compilation, | ||
| + | * **`&& | ||
| + | - **What it does**: This cleans up the package lists and removes any cached data from `apt-get`, which reduces the size of the Docker image by removing unnecessary files. | ||
| * `WORKDIR /app`: Sets the working directory inside the container. | * `WORKDIR /app`: Sets the working directory inside the container. | ||
| * `COPY requirements.txt requirements.txt`: | * `COPY requirements.txt requirements.txt`: | ||
| Line 217: | Line 150: | ||
| ==== 5. App code with environment variables ==== | ==== 5. App code with environment variables ==== | ||
| - | |||
| <code python> | <code python> | ||
| Line 329: | Line 261: | ||
| </ | </ | ||
| + | ==== Troubleshooting MariaDB import ==== | ||
| + | < | ||
| + | #5 11.31 | ||
| + | #5 11.31 | ||
| + | #5 11.31 This error typically indicates that MariaDB Connector/ | ||
| + | #5 11.31 must be preinstalled, | ||
| + | #5 11.31 If MariaDB Connector/C is not installed, see installation instructions | ||
| + | #5 11.31 If MariaDB Connector/C is installed, either set the environment variable | ||
| + | #5 11.31 | ||
| + | #5 11.31 ' | ||
| + | #5 11.31 | ||
| + | #5 11.31 [end of output] | ||
| + | </ | ||
| + | The error you're seeing indicates that the `mariadb` Python package requires the MariaDB Connector/C library to be preinstalled, | ||
| + | |||
| + | Here's how you can modify your Dockerfile to install the MariaDB Connector/C library before installing the Python dependencies: | ||
| + | |||
| + | === Updated Dockerfile === | ||
| + | |||
| + | <code dockerfile> | ||
| + | FROM python: | ||
| + | |||
| + | # Install MariaDB Connector/C library and other dependencies | ||
| + | RUN apt-get update && apt-get install -y \ | ||
| + | libmariadb3 \ | ||
| + | libmariadb-dev \ | ||
| + | gcc \ | ||
| + | && apt-get clean \ | ||
| + | && rm -rf / | ||
| + | |||
| + | WORKDIR /app | ||
| + | |||
| + | COPY requirements.txt requirements.txt | ||
| + | RUN pip install -r requirements.txt | ||
| + | |||
| + | COPY . . | ||
| + | |||
| + | CMD [" | ||
| + | </ | ||
| + | |||
| + | === Explanation === | ||
| + | |||
| + | * **Update and install dependencies**: | ||
| + | * **Clean up**: The `apt-get clean && rm -rf / | ||
| + | |||
| + | Now, try building your Docker image again with the updated Dockerfile: | ||
| + | <code bash> | ||
| + | docker-compose up --build | ||
| + | </ | ||
| + | |||
| + | This should resolve the issue with the missing `mariadb_config` and allow the `mariadb` Python package to install correctly. | ||
| + | |||
| + | ==== Troubleshooting Werkzeug ==== | ||
| + | < | ||
| + | app-flask-app-1 | ||
| + | app-flask-app-1 exited with code 1 | ||
| + | </ | ||
| + | |||
| + | The error you're encountering is due to an incompatibility between Flask and Werkzeug versions. Flask 2.1.2 may not be compatible with the latest version of Werkzeug. | ||
| + | |||
| + | To fix this, you can pin the Werkzeug version to one that is compatible with Flask 2.1.2. Based on the error, pinning Werkzeug to version 2.0.3 should resolve the issue. | ||
| + | |||
| + | === Updated requirements.txt === | ||
| + | |||
| + | < | ||
| + | Flask==2.1.2 | ||
| + | mariadb==1.1.4 | ||
| + | Werkzeug==2.0.3 | ||
| + | </ | ||
| + | |||
| + | === Dockerfile (unchanged from previous update) === | ||
| + | |||
| + | <code Dockerfile> | ||
| + | FROM python: | ||
| + | |||
| + | # Install MariaDB Connector/C library and other dependencies | ||
| + | RUN apt-get update && apt-get install -y \ | ||
| + | libmariadb3 \ | ||
| + | libmariadb-dev \ | ||
| + | gcc \ | ||
| + | && apt-get clean \ | ||
| + | && rm -rf / | ||
| + | |||
| + | WORKDIR /app | ||
| + | |||
| + | COPY requirements.txt requirements.txt | ||
| + | RUN pip install -r requirements.txt | ||
| + | |||
| + | COPY . . | ||
| + | |||
| + | CMD [" | ||
| + | </ | ||
| + | |||
| + | === Steps === | ||
| + | |||
| + | - **Update your `requirements.txt`** as shown above. | ||
| + | - **Rebuild the Docker image** with the updated `requirements.txt`: | ||
| + | |||
| + | docker-compose up --build | ||
| + | |||
| + | |||
| + | This should resolve the incompatibility issue between Flask and Werkzeug and allow your Flask app to start without errors. | ||
| ===== Conclusion ===== | ===== Conclusion ===== | ||
| Porting from LXC to Docker is not a trivial task due to the differences in how these containers are designed and managed. It's essential to review the services, configurations, | Porting from LXC to Docker is not a trivial task due to the differences in how these containers are designed and managed. It's essential to review the services, configurations, | ||
| Line 338: | Line 372: | ||
| * LXC documentation: | * LXC documentation: | ||
| + | https:// | ||
porting_an_lxc_to_docker.1723349037.txt.gz · Last modified: 2024/10/17 21:42 (external edit)
