183-create-dockerfile (#185)

* 183 add dockerfile

* 183 remove dockerfile

* 183 add dockerfile

* 183 update dockerfile

* 183 add GA workflow to build and push docker image

* 183 update readme

* 183 slight fix to readme

* 183 add PYTHONUNBUFFERED to dockerfile

* 183 ignore warnings in main.py remove from dockerfile

* 183 change in line with comments

* 183 testing building container on push to branch

* 183 revert workflow to only build docker on main

Author: AdrianMontaguSmartDCSIT

.github/workflows/build-push.yml

@@ -0,0 +1,39 @@
+name: Build and Push Docker Image
+on:
+    workflow_dispatch:
+    push:
+      branches:
+        - 'main'
+      tags:
+        - 'v*'
+
+jobs:
+  build-and-push:
+    if: |
+        github.repository == 'xtuml/otel2puml'
+            && github.actor != 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+            images: ghcr.io/xtuml/otel2puml
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+            context: .
+            push: true
+            tags: ${{ steps.meta.outputs.tags }}
+            labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -0,0 +1,40 @@
+FROM python:3.11-bullseye
+
+# Setup folders
+RUN mkdir /otel2puml_app && mkdir /otel2puml_app/tel2puml
+
+WORKDIR /otel2puml_app
+
+# Install system dependencies needed for cvxopt
+RUN apt-get update && apt-get install -y \
+    liblapack-dev \
+    libopenblas-dev \
+    libsuitesparse-dev \
+    libglpk-dev \
+    && apt-get clean
+
+# Set environment variables for cvxopt build
+ENV CPPFLAGS="-I/usr/include/suitesparse"
+ENV CVXOPT_BUILD_GLPK=1
+ENV PYTHONUNBUFFERED=1
+
+# Caches packages installed by pip
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY ./tel2puml/ /otel2puml_app/tel2puml/
+COPY ./scripts/install_repositories.sh /otel2puml_app/
+
+# Create a non-root user and give ownership of the app folder
+RUN useradd -m otel2pumluser && chown -R otel2pumluser /otel2puml_app
+
+# Switch to the non-root user
+USER otel2pumluser
+
+# Install external dependencies
+RUN chmod +x /otel2puml_app/install_repositories.sh
+RUN /otel2puml_app/install_repositories.sh
+
+EXPOSE 8800
+
+ENTRYPOINT [ "python", "-m" , "tel2puml"]

README.md

@@ -7,7 +7,11 @@ This project converts [OpenTelemetry (OTel)](https://opentelemetry.io/) data int
   <ol>
     <li><a href="#why-use-this-tool">Why Use This Tool?</a></li>
     <li><a href="#features">Features</a></li>
-    <li><a href="#quick-start">Quick Start</a></li>
+    <li><a href="#quick-start">Quick Start</a>
+      <ol>
+        <li><a href="#using-docker-image">Using Docker Image</a></li>
+      </ol>
+    </li>
     <li><a href="#example-input">Example Input</a></li>
     <li><a href="#example-output">Example Output</a></li>
     <li><a href="#installation">Installation</a>
@@ -109,6 +113,31 @@ python -m tel2puml pv2puml example_above.json -jn "output_diagram"
 
 ![](docs/images/example_sequence_for_readme.svg)
 
+## Using Docker Image
+
+You can run otel2puml using the provided [Docker image](https://github.com/orgs/xtuml/packages?repo_name=otel2puml). This is especially useful if you want to run the tool in an isolated environment without manually managing dependencies. Here’s how to do it:
+
+Example Command:
+```bash
+docker run \
+ -v /path/to/job_json_files:/job_json_files \
+ -v /path/to/config.yaml:/config.yaml \
+ -v /path/to/puml_output:/puml_output \
+ ghcr.io/xtuml/otel2puml:<version> \
+ -o /puml_output otel2puml -c /config.yaml
+```
+
+Explanation:
+
+* `-v /path/to/job_json_files:/job_json_files`: Mounts a local folder containing your OTel data in JSON format to the Docker container's /job_json_files directory.
+* `-v /path/to/config.yaml:/config.yaml`: Mounts the configuration file for `otel2puml` to the Docker container's /config.yaml.
+* `-v /path/to/puml_output:/puml_output`: Mounts a local folder where the output PlantUML diagrams will be saved.
+* `ghcr.io/xtuml/otel2puml`:latest: Specifies the Docker image to run.
+* `-o /puml_output`: Tells `otel2puml` where to save the generated PlantUML files inside the container (linked to the local `puml_output` folder).
+* `otel2puml -c /config.yaml`: Runs the `otel2puml` command using the provided configuration file.
+
+Replace `/path/to/` with the actual paths on your local machine.
+
 ## Installation
 
 There are two ways to set up this project: manual installation or using a devcontainer (recommended).

tel2puml/__main__.py

@@ -21,6 +21,7 @@
 import os
 import argparse
 import yaml
+import warnings
 from typing import Any, Literal
 
 from .otel_to_puml import otel_to_puml
@@ -219,6 +220,8 @@ def generate_component_options(
 
 
 if __name__ == "__main__":
+    warnings.filterwarnings("ignore")
+
     args: argparse.Namespace = parser.parse_args()
     args_dict = vars(args)
     otel_pv_options, pv_puml_options = generate_component_options(