carverauto/serviceradar

Fork 0

cleanup #2557

Merged

mfreeman451 merged 1 commit from refs/pull/2557/head into main

2025-12-13 22:57:09 +00:00

mfreeman451 commented

2025-12-13 22:36:55 +00:00

(Migrated from github.com)

Owner

Imported from GitHub pull request.

Original GitHub pull request: #2118
Original author: @mfreeman451
Original URL: https://github.com/carverauto/serviceradar/pull/2118
Original created: 2025-12-13T22:36:55Z
Original updated: 2025-12-13T22:57:13Z
Original head: carverauto/serviceradar:chore/cleanup_podman_docker_docs
Original base: main
Original merged: 2025-12-13T22:57:09Z by @mfreeman451

User description

IMPORTANT: Please sign the Developer Certificate of Origin

Thank you for your contribution to ServiceRadar. Please note, when contributing, the developer must include
a DCO sign-off statement indicating the DCO acceptance in one commit message. Here
is an example DCO Signed-off-by line in a commit message:

Signed-off-by: J. Doe <j.doe@domain.com>

Describe your changes

Issue ticket number and link

Code checklist before requesting a review

I have signed the DCO?
The build completes without errors?
All tests are passing when running make test?

PR Type

Documentation, Other

Description

Remove Podman-specific deployment scripts and documentation
Consolidate to Docker Compose as primary deployment method
Remove Podman dependencies from build Dockerfiles
Update references and documentation to reflect Docker-only focus

Diagram Walkthrough

flowchart LR
  A["Podman Scripts<br/>podman-start.sh<br/>podman-test.sh"] -->|removed| B["Docker Compose<br/>Primary Method"]
  C["Podman Docs<br/>README-Docker.md"] -->|simplified| B
  D["Podman Compose File<br/>docker-compose.podman.yml"] -->|removed| B
  E["Build Dockerfiles<br/>Podman deps"] -->|cleaned| F["Ubuntu/RHEL<br/>Build Images"]

File Walkthrough

Relevant files

Deletion

3 files

podman-start.sh `Removed entire Podman startup script`	+0/-294
podman-test.sh `Removed entire Podman testing script`	+0/-203
docker-compose.podman.yml `Removed entire Podman Compose configuration`	+0/-827

Documentation

6 files

README-Docker.md `Removed Podman section and simplified prerequisites`	+16/-102
CHANGELOG `Removed Podman deployment documentation mention`	+0/-1
nginx.conf.template `Updated comment to reflect Docker Compose only`	+2/-2
proposal.md `Updated reference to remove Podman Compose file`	+1/-1
tasks.md `Updated task descriptions to remove Podman references`	+2/-2
tasks.md `Updated task to reference mtls variants only`	+1/-1

Dependencies

2 files

Dockerfile.rbe `Removed Podman and slirp4netns dependencies`	+1/-24
Dockerfile.rbe-ora9 `Removed Podman and container networking plugins`	+0/-5

Imported from GitHub pull request. Original GitHub pull request: #2118 Original author: @mfreeman451 Original URL: https://github.com/carverauto/serviceradar/pull/2118 Original created: 2025-12-13T22:36:55Z Original updated: 2025-12-13T22:57:13Z Original head: carverauto/serviceradar:chore/cleanup_podman_docker_docs Original base: main Original merged: 2025-12-13T22:57:09Z by @mfreeman451 --- ### **User description** ## IMPORTANT: Please sign the Developer Certificate of Origin Thank you for your contribution to ServiceRadar. Please note, when contributing, the developer must include a [DCO sign-off statement]( https://developercertificate.org/) indicating the DCO acceptance in one commit message. Here is an example DCO Signed-off-by line in a commit message: ``` Signed-off-by: J. Doe <j.doe@domain.com> ``` ## Describe your changes ## Issue ticket number and link ## Code checklist before requesting a review - [ ] I have signed the DCO? - [ ] The build completes without errors? - [ ] All tests are passing when running make test? ___ ### **PR Type** Documentation, Other ___ ### **Description** - Remove Podman-specific deployment scripts and documentation - Consolidate to Docker Compose as primary deployment method - Remove Podman dependencies from build Dockerfiles - Update references and documentation to reflect Docker-only focus ___ ### Diagram Walkthrough ```mermaid flowchart LR A["Podman Scripts<br/>podman-start.sh<br/>podman-test.sh"] -->|removed| B["Docker Compose<br/>Primary Method"] C["Podman Docs<br/>README-Docker.md"] -->|simplified| B D["Podman Compose File<br/>docker-compose.podman.yml"] -->|removed| B E["Build Dockerfiles<br/>Podman deps"] -->|cleaned| F["Ubuntu/RHEL<br/>Build Images"] ``` <details><summary><h3>File Walkthrough</h3></summary> <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Deletion</strong></td><td><details><summary>3 files</summary><table> <tr> <td><strong>podman-start.sh</strong><dd><code>Removed entire Podman startup script</code>                                          </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-b535a8cc079d7b11e8171badcb8d2e359d82db6b2903c688fa463798f9e7a154">+0/-294</a>  </td> </tr> <tr> <td><strong>podman-test.sh</strong><dd><code>Removed entire Podman testing script</code>                                          </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-f20b0066b1969fcb2ae43b23770270e577d11435970aa3415ab1a6a3fdaccf9e">+0/-203</a>  </td> </tr> <tr> <td><strong>docker-compose.podman.yml</strong><dd><code>Removed entire Podman Compose configuration</code>                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-77a7fc5fac1d23ddc900d0f5128aedde1fe22302ba66820a704a8e5d13a15dbb">+0/-827</a>  </td> </tr> </table></details></td></tr><tr><td><strong>Documentation</strong></td><td><details><summary>6 files</summary><table> <tr> <td><strong>README-Docker.md</strong><dd><code>Removed Podman section and simplified prerequisites</code>            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-9fd61d24482efe68c22d8d41e2a1dcc440f39195aa56e7a050f2abe598179efd">+16/-102</a></td> </tr> <tr> <td><strong>CHANGELOG</strong><dd><code>Removed Podman deployment documentation mention</code>                    </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-ecec88c33adb7591ee6aa88e29b62ad52ef443611cba5e0f0ecac9b5725afdba">+0/-1</a>      </td> </tr> <tr> <td><strong>nginx.conf.template</strong><dd><code>Updated comment to reflect Docker Compose only</code>                      </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-62ef305390094ce81632d493253e470ca46e7daa76da1079c131e41502975d07">+2/-2</a>      </td> </tr> <tr> <td><strong>proposal.md</strong><dd><code>Updated reference to remove Podman Compose file</code>                    </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-c63ff67b2df6ce90168759f5124c95908cb7fd27487e49857cdb7fbc800855d3">+1/-1</a>      </td> </tr> <tr> <td><strong>tasks.md</strong><dd><code>Updated task descriptions to remove Podman references</code>        </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-7b1086f0fff9d03a90aec6e9bbed17fdd1501f8fd14f4485077d0159eba86d30">+2/-2</a>      </td> </tr> <tr> <td><strong>tasks.md</strong><dd><code>Updated task to reference mtls variants only</code>                          </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-4eec00439bd8c35c743af0c8455b7797af00593c93c3016de2991b797453e8e5">+1/-1</a>      </td> </tr> </table></details></td></tr><tr><td><strong>Dependencies</strong></td><td><details><summary>2 files</summary><table> <tr> <td><strong>Dockerfile.rbe</strong><dd><code>Removed Podman and slirp4netns dependencies</code>                            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-40936cbae5822a0a5fa8016befa08eb3a7836c93328e8043dcdfb3885a6201b2">+1/-24</a>    </td> </tr> <tr> <td><strong>Dockerfile.rbe-ora9</strong><dd><code>Removed Podman and container networking plugins</code>                    </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2118/files#diff-c4a73a282f345855c6c173679a1f3dcf26b8cc70e3a0f026bdb0ab0a40b6834d">+0/-5</a>      </td> </tr> </table></details></td></tr></tbody></table> </details> ___

qodo-code-review[bot] commented

2025-12-13 22:37:22 +00:00

(Migrated from github.com)

Author

Owner

Imported GitHub PR comment.

Original author: @qodo-code-review[bot]
Original URL: https://github.com/carverauto/serviceradar/pull/2118#issuecomment-3649880142
Original created: 2025-12-13T22:37:22Z

You are nearing your monthly Qodo Merge usage quota. For more information, please visit here.

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
⚪	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: No audit context: The added documentation and config comments do not introduce or reference logging of critical actions; however, this PR appears documentation/cleanup focused and may not affect runtime audit trails. Referred Code - Docker Engine 20.10+ with Docker Compose 2.0+ - 8GB+ RAM - 50GB+ disk space ## OS-Specific Setup ### AlmaLinux 9 / RHEL 9 / Rocky Linux 9 ```bash # Install Docker sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin # Enable and start Docker sudo systemctl enable --now docker # Add your user to the docker group sudo usermod -aG docker $USER newgrp docker # Install Git (if needed) ... (clipped 162 lines) Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Missing error checks: Newly added Dockerfile directives (e.g., ENV PATH) and modified package lists do not show error handling or validation for potential failures, but Dockerfile steps may be acceptable as-is depending on build CI safeguards. Referred Code `make \ cmake \ bison \ flex \ gperf \ pkg-config \ # Container Tools skopeo \ iptables \ # Database / Libs postgresql-server-dev-16 \ libpq-dev \ libssl-dev \ zlib1g-dev \ liblz4-dev \ libzstd-dev \ libgmp-dev \ libev-dev \ libbpf-dev \ linux-tools-common \ linux-tools-generic \ ... (clipped 28 lines)` Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

Imported GitHub PR comment. Original author: @qodo-code-review[bot] Original URL: https://github.com/carverauto/serviceradar/pull/2118#issuecomment-3649880142 Original created: 2025-12-13T22:37:22Z --- _You are nearing your monthly Qodo Merge usage quota. For more information, please visit [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users)._ ## PR Compliance Guide 🔍  Below is a summary of compliance checks for this PR:<br> <table><tbody><tr><td colspan='2'><strong>Security Compliance</strong></td></tr> <tr><td>🟢</td><td><details><summary><strong>No security concerns identified</strong></summary> No security vulnerabilities detected by AI analysis. Human verification advised for critical code. </details></td></tr> <tr><td colspan='2'><strong>Ticket Compliance</strong></td></tr> <tr><td>⚪</td><td><details><summary>🎫 <strong>No ticket provided </strong></summary> - [ ] Create ticket/issue  </details></td></tr> <tr><td colspan='2'><strong>Codebase Duplication Compliance</strong></td></tr> <tr><td>⚪</td><td><details><summary><strong>Codebase context is not defined </strong></summary> Follow the <a href='https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/'>guide</a> to enable codebase context checks. </details></td></tr> <tr><td colspan='2'><strong>Custom Compliance</strong></td></tr> <tr><td rowspan=4>🟢</td><td> <details><summary><strong>Generic: Meaningful Naming and Self-Documenting Code</strong></summary><br> **Objective:** Ensure all identifiers clearly express their purpose and intent, making code <br>self-documenting<br> **Status:** Passed<br> > Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a> </details></td></tr> <tr><td> <details><summary><strong>Generic: Secure Error Handling</strong></summary><br> **Objective:** To prevent the leakage of sensitive system information through error messages while <br>providing sufficient detail for internal debugging.<br> **Status:** Passed<br> > Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a> </details></td></tr> <tr><td> <details><summary><strong>Generic: Secure Logging Practices</strong></summary><br> **Objective:** To ensure logs are useful for debugging and auditing without exposing sensitive <br>information like PII, PHI, or cardholder data.<br> **Status:** Passed<br> > Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a> </details></td></tr> <tr><td> <details><summary><strong>Generic: Security-First Input Validation and Data Handling</strong></summary><br> **Objective:** Ensure all data inputs are validated, sanitized, and handled securely to prevent <br>vulnerabilities<br> **Status:** Passed<br> > Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a> </details></td></tr> <tr><td rowspan=2>⚪</td> <td><details> <summary><strong>Generic: Comprehensive Audit Trails</strong></summary><br> **Objective:** To create a detailed and reliable record of critical system actions for security analysis <br>and compliance.<br> **Status:** <br><a href='https://github.com/carverauto/serviceradar/pull/2118/files#diff-9fd61d24482efe68c22d8d41e2a1dcc440f39195aa56e7a050f2abe598179efdR7-R189'><strong>No audit context</strong></a>: The added documentation and config comments do not introduce or reference logging of <br>critical actions; however, this PR appears documentation/cleanup focused and may not <br>affect runtime audit trails.<br> <details open><summary>Referred Code</summary> ```markdown - Docker Engine 20.10+ with Docker Compose 2.0+ - 8GB+ RAM - 50GB+ disk space ## OS-Specific Setup ### AlmaLinux 9 / RHEL 9 / Rocky Linux 9 ```bash # Install Docker sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin # Enable and start Docker sudo systemctl enable --now docker # Add your user to the docker group sudo usermod -aG docker $USER newgrp docker # Install Git (if needed) ... (clipped 162 lines) ``` </details> > Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a> </details></td></tr> <tr><td><details> <summary><strong>Generic: Robust Error Handling and Edge Case Management</strong></summary><br> **Objective:** Ensure comprehensive error handling that provides meaningful context and graceful <br>degradation<br> **Status:** <br><a href='https://github.com/carverauto/serviceradar/pull/2118/files#diff-40936cbae5822a0a5fa8016befa08eb3a7836c93328e8043dcdfb3885a6201b2R32-R80'><strong>Missing error checks</strong></a>: Newly added Dockerfile directives (e.g., ENV PATH) and modified package lists do not show <br>error handling or validation for potential failures, but Dockerfile steps may be <br>acceptable as-is depending on build CI safeguards.<br> <details open><summary>Referred Code</summary> ```txt make \ cmake \ bison \ flex \ gperf \ pkg-config \ # Container Tools skopeo \ iptables \ # Database / Libs postgresql-server-dev-16 \ libpq-dev \ libssl-dev \ zlib1g-dev \ liblz4-dev \ libzstd-dev \ libgmp-dev \ libev-dev \ libbpf-dev \ linux-tools-common \ linux-tools-generic \ ... (clipped 28 lines) ``` </details> > Learn more about managing compliance <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#configuration-options'>generic rules</a> or creating your own <a href='https://qodo-merge-docs.qodo.ai/tools/compliance/#custom-compliance'>custom rules</a> </details></td></tr> <tr><td align="center" colspan="2">   </td></tr></tbody></table> <details><summary>Compliance status legend</summary> 🟢 - Fully Compliant<br> 🟡 - Partial Compliant<br> 🔴 - Not Compliant<br> ⚪ - Requires Further Human Verification<br> 🏷️ - Compliance label<br> </details>

qodo-code-review[bot] commented

2025-12-13 22:38:00 +00:00

(Migrated from github.com)

Author

Owner

Imported GitHub PR comment.

Original author: @qodo-code-review[bot]
Original URL: https://github.com/carverauto/serviceradar/pull/2118#issuecomment-3649880502
Original created: 2025-12-13T22:38:00Z

You are nearing your monthly Qodo Merge usage quota. For more information, please visit here.

PR Code Suggestions ✨

Explore these optional code suggestions:

Category Suggestion Impact

General

Category	Suggestion	Impact
General	Improve update instructions for clarity Generalize the stack update instructions by replacing the hardcoded version `v1.0.77` with a placeholder, and add guidance on finding the latest release and setting the `APP_TAG` environment variable. README-Docker.md [82-91] -1. Choose a target image tag: - - Latest release: `APP_TAG=v1.0.77` - - Specific commit: `APP_TAG=sha-<git-sha>` +1. Find the latest release tag (e.g., `v1.0.77`) from the project's GitHub releases page. -2. Pull + restart with the new tag: +2. Set the `APP_TAG` environment variable in your shell. This variable must be available in the environment where you run `docker compose`. ```bash - export APP_TAG=v1.0.77 + # Replace vX.Y.Z with the desired release tag + export APP_TAG=vX.Y.Z + ``` + Alternatively, you can create a `.env` file in the root of the repository and add the line `APP_TAG=vX.Y.Z` to it. + +3. Pull the new images and restart the stack: + ```bash docker compose pull docker compose up -d --force-recreate ``` Apply / Chat Suggestion importance[1-10]: 5 __ Why: The suggestion correctly points out that hardcoding a version in documentation is not ideal and proposes a more robust, user-friendly approach that will not become outdated as quickly.	Low
More

Improve update instructions for clarity

Generalize the stack update instructions by replacing the hardcoded version
v1.0.77 with a placeholder, and add guidance on finding the latest release and
setting the APP_TAG environment variable.

README-Docker.md [82-91]

-1. Choose a target image tag:
-   - Latest release: `APP_TAG=v1.0.77`
-   - Specific commit: `APP_TAG=sha-<git-sha>`
+1. Find the latest release tag (e.g., `v1.0.77`) from the project's GitHub releases page.
 
-2. Pull + restart with the new tag:
+2. Set the `APP_TAG` environment variable in your shell. This variable must be available in the environment where you run `docker compose`.
    ```bash
-   export APP_TAG=v1.0.77
+   # Replace vX.Y.Z with the desired release tag
+   export APP_TAG=vX.Y.Z
+   ```
+   Alternatively, you can create a `.env` file in the root of the repository and add the line `APP_TAG=vX.Y.Z` to it.
+
+3. Pull the new images and restart the stack:
+   ```bash
    docker compose pull
    docker compose up -d --force-recreate
    ```

Apply / Chat

Suggestion importance[1-10]: 5

Why: The suggestion correctly points out that hardcoding a version in documentation is not ideal and proposes a more robust, user-friendly approach that will not become outdated as quickly.

Low

Imported GitHub PR comment. Original author: @qodo-code-review[bot] Original URL: https://github.com/carverauto/serviceradar/pull/2118#issuecomment-3649880502 Original created: 2025-12-13T22:38:00Z --- _You are nearing your monthly Qodo Merge usage quota. For more information, please visit [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users)._ ## PR Code Suggestions ✨  Explore these optional code suggestions: <table><thead><tr><td><strong>Category</strong></td><td align=left><strong>Suggestion                                                                                                                                    </strong></td><td align=center><strong>Impact</strong></td></tr><tbody><tr><td rowspan=1>General</td> <td> <details><summary>Improve update instructions for clarity</summary> ___ **Generalize the stack update instructions by replacing the hardcoded version <br><code>v1.0.77</code> with a placeholder, and add guidance on finding the latest release and <br>setting the <code>APP_TAG</code> environment variable.** [README-Docker.md [82-91]](https://github.com/carverauto/serviceradar/pull/2118/files#diff-9fd61d24482efe68c22d8d41e2a1dcc440f39195aa56e7a050f2abe598179efdR82-R91) ```diff -1. Choose a target image tag: - - Latest release: `APP_TAG=v1.0.77` - - Specific commit: `APP_TAG=sha-<git-sha>` +1. Find the latest release tag (e.g., `v1.0.77`) from the project's GitHub releases page. -2. Pull + restart with the new tag: +2. Set the `APP_TAG` environment variable in your shell. This variable must be available in the environment where you run `docker compose`. ```bash - export APP_TAG=v1.0.77 + # Replace vX.Y.Z with the desired release tag + export APP_TAG=vX.Y.Z + ``` + Alternatively, you can create a `.env` file in the root of the repository and add the line `APP_TAG=vX.Y.Z` to it. + +3. Pull the new images and restart the stack: + ```bash docker compose pull docker compose up -d --force-recreate ``` ``` - [ ] **Apply / Chat**  <details><summary>Suggestion importance[1-10]: 5</summary> __ Why: The suggestion correctly points out that hardcoding a version in documentation is not ideal and proposes a more robust, user-friendly approach that will not become outdated as quickly. </details></details></td><td align=center>Low </td></tr> <tr><td align="center" colspan="2"> - [ ] More  </td><td></td></tr></tbody></table>