carverauto/serviceradar

Fork 0

clenaup #2679

Merged

mfreeman451 merged 6 commits from refs/pull/2679/head into staging

2026-01-15 17:46:43 +00:00

mfreeman451 commented

2026-01-15 07:41:54 +00:00

(Migrated from github.com)

Owner

Imported from GitHub pull request.

Original GitHub pull request: #2318
Original author: @mfreeman451
Original URL: https://github.com/carverauto/serviceradar/pull/2318
Original created: 2026-01-15T07:41:54Z
Original updated: 2026-01-15T17:46:45Z
Original head: carverauto/serviceradar:2316-chore-doc-updates
Original base: staging
Original merged: 2026-01-15T17:46:43Z 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

Description

Update architecture documentation to reflect core-elx and agent-gateway
Clarify platform deployment via Kubernetes and Docker Compose
Simplify installation guidance for edge agents and checkers
Refresh component descriptions and data flow diagrams
Add specification deltas for control plane and edge architecture

Diagram Walkthrough

flowchart LR
  OldDocs["Old Docs<br/>Legacy references"] -->|Update| NewDocs["Updated Docs<br/>core-elx focused"]
  OldDocs -->|Clarify| PlatformDeploy["Platform Deployment<br/>K8s + Docker Compose"]
  OldDocs -->|Simplify| EdgeDeploy["Edge Deployment<br/>Agents + Checkers"]
  NewDocs --> ArchDiagrams["Architecture Diagrams<br/>Mermaid flowcharts"]
  NewDocs --> SpecDeltas["Specification Deltas<br/>Control plane + edge"]

File Walkthrough

Relevant files

Documentation

12 files

DOCKER_QUICKSTART.md `Update docker-compose commands and service references`	+10/-10
INSTALL.md `Restructure installation guide for platform and edge`	+32/-84
README-Docker.md `Update Docker service names and command examples`	+4/-4
README.md `Refresh architecture overview and component descriptions`	+8/-8
architecture.md `Refactor architecture documentation with core-elx focus`	+54/-79
installation.md `Simplify installation guide for platform and edge`	+39/-516
proposal.md `Add proposal for architecture documentation updates`	+16/-0
spec.md `Add agent configuration specification requirements`	+23/-0
spec.md `Add agent connectivity and enrollment specification`	+56/-0
spec.md `Add edge architecture and ingestion specification`	+46/-0
spec.md `Add KV configuration requirements specification`	+25/-0
tasks.md `Add implementation tasks for documentation updates`	+16/-0

Imported from GitHub pull request. Original GitHub pull request: #2318 Original author: @mfreeman451 Original URL: https://github.com/carverauto/serviceradar/pull/2318 Original created: 2026-01-15T07:41:54Z Original updated: 2026-01-15T17:46:45Z Original head: carverauto/serviceradar:2316-chore-doc-updates Original base: staging Original merged: 2026-01-15T17:46:43Z 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 ___ ### **Description** - Update architecture documentation to reflect core-elx and agent-gateway - Clarify platform deployment via Kubernetes and Docker Compose - Simplify installation guidance for edge agents and checkers - Refresh component descriptions and data flow diagrams - Add specification deltas for control plane and edge architecture ___ ### Diagram Walkthrough ```mermaid flowchart LR OldDocs["Old Docs Legacy references"] -->|Update| NewDocs["Updated Docs core-elx focused"] OldDocs -->|Clarify| PlatformDeploy["Platform Deployment K8s + Docker Compose"] OldDocs -->|Simplify| EdgeDeploy["Edge Deployment Agents + Checkers"] NewDocs --> ArchDiagrams["Architecture Diagrams Mermaid flowcharts"] NewDocs --> SpecDeltas["Specification Deltas Control plane + edge"] ``` <details><summary><h3>File Walkthrough</h3></summary> <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td>Documentation</td><td><details><summary>12 files</summary><table> <tr> <td>DOCKER_QUICKSTART.md<dd><code>Update docker-compose commands and service references</code>        </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-d39bb63b06e41b96069fe4f289e4d28a4f205f8e953c141e6f4d9c715bbb75b3">+10/-10</a>  </td> </tr> <tr> <td>INSTALL.md<dd><code>Restructure installation guide for platform and edge</code>          </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-09b140a43ebfdd8dbec31ce72cafffd15164d2860fd390692a030bcb932b54a0">+32/-84</a>  </td> </tr> <tr> <td>README-Docker.md<dd><code>Update Docker service names and command examples</code>                  </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-9fd61d24482efe68c22d8d41e2a1dcc440f39195aa56e7a050f2abe598179efd">+4/-4</a>      </td> </tr> <tr> <td>README.md<dd><code>Refresh architecture overview and component descriptions</code>  </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5">+8/-8</a>      </td> </tr> <tr> <td>architecture.md<dd><code>Refactor architecture documentation with core-elx focus</code>    </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-90abd06467420fd89391fd1a4d75ceb1f6a9381de4d13a95fffe606abff38d37">+54/-79</a>  </td> </tr> <tr> <td>installation.md<dd><code>Simplify installation guide for platform and edge</code>                </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-19fd876fb56da88a1becb80817b52db1a40e8491641d547913b93bb7ecda3d22">+39/-516</a></td> </tr> <tr> <td>proposal.md<dd><code>Add proposal for architecture documentation updates</code>            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-9b23a40fa01d70d6a4264d04a0b0ad936e7683e50baa485df638eb9c779fecf7">+16/-0</a>    </td> </tr> <tr> <td>spec.md<dd><code>Add agent configuration specification requirements</code>              </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-78c00fa88285549e85eedaa25455c792a0c9a6e567f2d2ab7005d03137c00b36">+23/-0</a>    </td> </tr> <tr> <td>spec.md<dd><code>Add agent connectivity and enrollment specification</code>            </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-8253e68f23eb774bc74e84636404921925aab5d1bd6cd19c2085cfa76ca25c12">+56/-0</a>    </td> </tr> <tr> <td>spec.md<dd><code>Add edge architecture and ingestion specification</code>                </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-fb3fb88a41d321030595566566a829d12404b2d12017e68c7675c180b3c1470a">+46/-0</a>    </td> </tr> <tr> <td>spec.md<dd><code>Add KV configuration requirements specification</code>                    </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-ac167235025a9e2c2fde6383190f9168cc7656987c80e6b8cc3f3373c023da40">+25/-0</a>    </td> </tr> <tr> <td>tasks.md<dd><code>Add implementation tasks for documentation updates</code>              </dd></td> <td><a href="https://github.com/carverauto/serviceradar/pull/2318/files#diff-e068caa8f1b2cbb81727bab0738a73a34bea206fd3a90bfb39b5ae95920a1246">+16/-0</a>    </td> </tr> </table></details></td></tr></tbody></table> </details> ___

qodo-code-review[bot] commented

2026-01-15 07:42:40 +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/2318#issuecomment-3753277141
Original created: 2026-01-15T07:42:40Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance

⚪

Pipe to shell

Description: The documentation instructs users to run a remote script via curl ... | bash, which is a
realistic supply-chain execution risk if the release asset or transport is compromised.
installation.md [42-46]

Referred Code

curl -sSL https://github.com/carverauto/serviceradar/releases/download/1.0.52/install-serviceradar.sh | bash -s -- --agent --non-interactive

# With optional checkers
curl -sSL https://github.com/carverauto/serviceradar/releases/download/1.0.52/install-serviceradar.sh | bash -s -- --agent --non-interactive --checkers=rperf,snmp


</details></details></td></tr>
<tr><td colspan='2'><strong>Ticket Compliance</strong></td></tr>
<tr><td>🟡</td>
<td>
<details>
<summary>🎫 <a href=https://github.com/carverauto/serviceradar/issues/2316>#2316</a></summary>
<table width='100%'><tbody>
<tr><td rowspan=9>🟢</td>
<td>Update documentation to reflect that <code>serviceradar-core</code> (Go) is replaced by <code>core-elx</code> <br>(Elixir) and describe its responsibilities (Horde/ERTS cluster, DIRE, internal event <br>routing, status/collection ingestion, ERTS RPC over mTLS).</td></tr>
<tr><td>Update documentation to reflect the current <code>serviceradar-agent</code> (Go) role and consolidated <br>capabilities (sync, snmp-checker, mapper/discovery, sweep/scanner, sysmon) and that it <br>pushes results to <code>agent-gateway</code>.</td></tr>
<tr><td>Update documentation to reflect <code>serviceradar-agent-gateway</code> (Elixir) gRPC ingestion (unary <br>+ streaming/chunking) and forwarding to <code>core-elx</code>.</td></tr>
<tr><td>Update docs to reflect configuration delivery changes: agents/checkers get config over <br>gRPC (agent-gateway/core-elx) and collectors use filesystem <code>config.json</code>/yaml (no KV <br>requirement).</td></tr>
<tr><td>Scrub/remove mentions of multi-tenancy from docs/architecture documentation.</td></tr>
<tr><td>Update architecture and Mermaid diagrams to match the new component topology and data <br>flows.</td></tr>
<tr><td>Update `README.md` to reflect the new architecture/components and flows.</td></tr>
<tr><td>Update installation docs to prefer Kubernetes or Docker Compose.</td></tr>
<tr><td>Clarify that standalone installs are supported only for edge agents/checkers due to CNPG <br>requirement.</td></tr>
<tr><td rowspan=4>🔴</td>
<td>Remove/avoid documentation references to the legacy `serviceradar-poller` poller model.</td></tr>
<tr><td>Update docs to reflect that standalone <code>serviceradar-sysmon</code> (Rust) and <br><code>serviceradar-sysmon-osx</code> are consolidated into the agent.</td></tr>
<tr><td>Update docs to reflect that legacy <code>serviceradar-web</code> (Next.js) is removed and replaced by <br><code>web-ng</code> (Phoenix LiveView + react-phoenix).</td></tr>
<tr><td>Update docs to reflect that <code>serviceradar-sync</code> is now baked into the agent and that configs <br>are pushed/compiled via <code>web-ng</code>.</td></tr>
</tbody></table>
</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=6>🟢</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:** 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: 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: 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:** 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 align="center" colspan="2">

- [ ] Update <!-- /compliance --update_compliance=true -->

</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>

Imported GitHub PR comment. Original author: @qodo-code-review[bot] Original URL: https://github.com/carverauto/serviceradar/pull/2318#issuecomment-3753277141 Original created: 2026-01-15T07:42:40Z --- ## PR Compliance Guide 🔍  Below is a summary of compliance checks for this PR: <table><tbody><tr><td colspan='2'>Security Compliance</td></tr> <tr><td rowspan=1>⚪</td> <td><details><summary>Pipe to shell</summary> Description: The documentation instructs users to run a remote script via <code>curl ... | bash</code>, which is a realistic supply-chain execution risk if the release asset or transport is compromised. <a href='https://github.com/carverauto/serviceradar/pull/2318/files#diff-19fd876fb56da88a1becb80817b52db1a40e8491641d547913b93bb7ecda3d22R42-R46'>installation.md [42-46]</a> <details open><summary>Referred Code</summary> ```markdown curl -sSL https://github.com/carverauto/serviceradar/releases/download/1.0.52/install-serviceradar.sh | bash -s -- --agent --non-interactive # With optional checkers curl -sSL https://github.com/carverauto/serviceradar/releases/download/1.0.52/install-serviceradar.sh | bash -s -- --agent --non-interactive --checkers=rperf,snmp ``` ``` </details></details></td></tr> <tr><td colspan='2'>Ticket Compliance</td></tr> <tr><td>🟡</td> <td> <details> <summary>🎫 <a href=https://github.com/carverauto/serviceradar/issues/2316>#2316</a></summary> <table width='100%'><tbody> <tr><td rowspan=9>🟢</td> <td>Update documentation to reflect that <code>serviceradar-core</code> (Go) is replaced by <code>core-elx</code> (Elixir) and describe its responsibilities (Horde/ERTS cluster, DIRE, internal event routing, status/collection ingestion, ERTS RPC over mTLS).</td></tr> <tr><td>Update documentation to reflect the current <code>serviceradar-agent</code> (Go) role and consolidated capabilities (sync, snmp-checker, mapper/discovery, sweep/scanner, sysmon) and that it pushes results to <code>agent-gateway</code>.</td></tr> <tr><td>Update documentation to reflect <code>serviceradar-agent-gateway</code> (Elixir) gRPC ingestion (unary + streaming/chunking) and forwarding to <code>core-elx</code>.</td></tr> <tr><td>Update docs to reflect configuration delivery changes: agents/checkers get config over gRPC (agent-gateway/core-elx) and collectors use filesystem <code>config.json</code>/yaml (no KV requirement).</td></tr> <tr><td>Scrub/remove mentions of multi-tenancy from docs/architecture documentation.</td></tr> <tr><td>Update architecture and Mermaid diagrams to match the new component topology and data flows.</td></tr> <tr><td>Update `README.md` to reflect the new architecture/components and flows.</td></tr> <tr><td>Update installation docs to prefer Kubernetes or Docker Compose.</td></tr> <tr><td>Clarify that standalone installs are supported only for edge agents/checkers due to CNPG requirement.</td></tr> <tr><td rowspan=4>🔴</td> <td>Remove/avoid documentation references to the legacy `serviceradar-poller` poller model.</td></tr> <tr><td>Update docs to reflect that standalone <code>serviceradar-sysmon</code> (Rust) and <code>serviceradar-sysmon-osx</code> are consolidated into the agent.</td></tr> <tr><td>Update docs to reflect that legacy <code>serviceradar-web</code> (Next.js) is removed and replaced by <code>web-ng</code> (Phoenix LiveView + react-phoenix).</td></tr> <tr><td>Update docs to reflect that <code>serviceradar-sync</code> is now baked into the agent and that configs are pushed/compiled via <code>web-ng</code>.</td></tr> </tbody></table> </details> </td></tr> <tr><td colspan='2'>Codebase Duplication Compliance</td></tr> <tr><td>⚪</td><td><details><summary>Codebase context is not defined </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'>Custom Compliance</td></tr> <tr><td rowspan=6>🟢</td><td> <details><summary>Generic: Comprehensive Audit Trails</summary> **Objective:** To create a detailed and reliable record of critical system actions for security analysis and compliance. **Status:** Passed > 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>Generic: Meaningful Naming and Self-Documenting Code</summary> **Objective:** Ensure all identifiers clearly express their purpose and intent, making code self-documenting **Status:** Passed > 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>Generic: Robust Error Handling and Edge Case Management</summary> **Objective:** Ensure comprehensive error handling that provides meaningful context and graceful degradation **Status:** Passed > 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>Generic: Secure Error Handling</summary> **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 <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>Generic: Secure Logging Practices</summary> **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 <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>Generic: Security-First Input Validation and Data Handling</summary> **Objective:** Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities **Status:** Passed > 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"> - [ ] Update  </td></tr></tbody></table> <details><summary>Compliance status legend</summary> 🟢 - Fully Compliant 🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label </details>

qodo-code-review[bot] commented

2026-01-15 07:43:39 +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/2318#issuecomment-3753279559
Original created: 2026-01-15T07:43:39Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Pin clone to release version Modify the `git clone` command to pin the repository to a specific release tag (e.g., `--branch v1.0.75`) to ensure version consistency. INSTALL.md [12] `-git clone https://github.com/carverauto/serviceradar.git +git clone --branch v1.0.75 https://github.com/carverauto/serviceradar.git` Apply / Chat Suggestion importance[1-10]: 7 __ Why: This is a valuable suggestion that improves the reliability of the installation instructions by ensuring users clone a specific, stable version of the code that matches the documentation.	Medium
	Ensure Helm deployment readiness Add the `--wait` and `--atomic` flags to the `helm upgrade` command to ensure the deployment waits for readiness and rolls back automatically on failure. INSTALL.md [24-27] `helm upgrade --install serviceradar oci://ghcr.io/carverauto/charts/serviceradar \ --version 1.0.75 \ -n serviceradar --create-namespace \ - --set global.imageTag="v1.0.75" + --set global.imageTag="v1.0.75" \ + --wait --atomic` Apply / Chat Suggestion importance[1-10]: 7 __ Why: This suggestion improves the robustness of the Helm deployment command by ensuring the deployment completes successfully and rolls back on failure, providing a better user experience.	Medium
	Add missing service entries Update the "What's Running?" list to include missing core services like `datasvc`, `agent-gateway`, and `agent` for a more complete description of the Docker stack. DOCKER_QUICKSTART.md [85] `+- datasvc: ServiceRadar Data Service (KV store) - core-elx: ServiceRadar control plane and business logic +- agent-gateway: Edge ingestion ingress for agent data +- agent: Deployed agent service on hosts` Apply / Chat Suggestion importance[1-10]: 5 __ Why: The suggestion correctly notes that the list of running services is incomplete. Adding the missing services provides a more accurate and helpful overview for users running the Docker stack.	Low
Possible issue	Restore missing firewall rules for checkers Add specific firewall rule examples for optional checkers like `rperf`, `Dusk` `Checker`, and `SNMP Checker` to the "Firewall Notes" section. docs/docs/installation.md [85-88] ## Firewall Notes - Edge agents require outbound access to the Agent-Gateway gRPC port (default 50052). -- Optional checkers may require additional ports depending on their protocol. +- Optional checkers may require additional ports depending on their protocol. For example: + - rperf: Requires TCP port `5199` for control, a range like `5200-5210` for data, and TCP port `50081` for the gRPC client. + - Dusk Checker: Requires TCP port `50082`. + - SNMP Checker: Requires TCP port `50080`. Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that useful firewall configuration details for optional checkers were removed in the refactoring, and restoring them improves the documentation's completeness and usability.	Low
Update

Imported GitHub PR comment. Original author: @qodo-code-review[bot] Original URL: https://github.com/carverauto/serviceradar/pull/2318#issuecomment-3753279559 Original created: 2026-01-15T07:43:39Z --- ## PR Code Suggestions ✨  Explore these optional code suggestions: <table><thead><tr><td>Category</td><td align=left>Suggestion                                                                                                                                    </td><td align=center>Impact</td></tr><tbody><tr><td rowspan=3>General</td> <td> <details><summary>Pin clone to release version</summary> ___ **Modify the <code>git clone</code> command to pin the repository to a specific release tag (e.g., <code>--branch v1.0.75</code>) to ensure version consistency.** [INSTALL.md [12]](https://github.com/carverauto/serviceradar/pull/2318/files#diff-09b140a43ebfdd8dbec31ce72cafffd15164d2860fd390692a030bcb932b54a0R12-R12) ```diff -git clone https://github.com/carverauto/serviceradar.git +git clone --branch v1.0.75 https://github.com/carverauto/serviceradar.git ``` - [ ] **Apply / Chat**  <details><summary>Suggestion importance[1-10]: 7</summary> __ Why: This is a valuable suggestion that improves the reliability of the installation instructions by ensuring users clone a specific, stable version of the code that matches the documentation. </details></details></td><td align=center>Medium </td></tr><tr><td> <details><summary>Ensure Helm deployment readiness</summary> ___ **Add the <code>--wait</code> and <code>--atomic</code> flags to the <code>helm upgrade</code> command to ensure the deployment waits for readiness and rolls back automatically on failure.** [INSTALL.md [24-27]](https://github.com/carverauto/serviceradar/pull/2318/files#diff-09b140a43ebfdd8dbec31ce72cafffd15164d2860fd390692a030bcb932b54a0R24-R27) ```diff helm upgrade --install serviceradar oci://ghcr.io/carverauto/charts/serviceradar \ --version 1.0.75 \ -n serviceradar --create-namespace \ - --set global.imageTag="v1.0.75" + --set global.imageTag="v1.0.75" \ + --wait --atomic ``` - [ ] **Apply / Chat**  <details><summary>Suggestion importance[1-10]: 7</summary> __ Why: This suggestion improves the robustness of the Helm deployment command by ensuring the deployment completes successfully and rolls back on failure, providing a better user experience. </details></details></td><td align=center>Medium </td></tr><tr><td> <details><summary>Add missing service entries</summary> ___ **Update the "What's Running?" list to include missing core services like <code>datasvc</code>, <code>agent-gateway</code>, and <code>agent</code> for a more complete description of the Docker stack.** [DOCKER_QUICKSTART.md [85]](https://github.com/carverauto/serviceradar/pull/2318/files#diff-d39bb63b06e41b96069fe4f289e4d28a4f205f8e953c141e6f4d9c715bbb75b3R85-R85) ```diff +- **datasvc**: ServiceRadar Data Service (KV store) - **core-elx**: ServiceRadar control plane and business logic +- **agent-gateway**: Edge ingestion ingress for agent data +- **agent**: Deployed agent service on hosts ``` - [ ] **Apply / Chat**  <details><summary>Suggestion importance[1-10]: 5</summary> __ Why: The suggestion correctly notes that the list of running services is incomplete. Adding the missing services provides a more accurate and helpful overview for users running the Docker stack. </details></details></td><td align=center>Low </td></tr><tr><td rowspan=1>Possible issue</td> <td> <details><summary>Restore missing firewall rules for checkers</summary> ___ **Add specific firewall rule examples for optional checkers like <code>rperf</code>, <code>Dusk </code> <code>Checker</code>, and <code>SNMP Checker</code> to the "Firewall Notes" section.** [docs/docs/installation.md [85-88]](https://github.com/carverauto/serviceradar/pull/2318/files#diff-19fd876fb56da88a1becb80817b52db1a40e8491641d547913b93bb7ecda3d22R85-R88) ```diff ## Firewall Notes - Edge agents require outbound access to the Agent-Gateway gRPC port (default 50052). -- Optional checkers may require additional ports depending on their protocol. +- Optional checkers may require additional ports depending on their protocol. For example: + - **rperf**: Requires TCP port `5199` for control, a range like `5200-5210` for data, and TCP port `50081` for the gRPC client. + - **Dusk Checker**: Requires TCP port `50082`. + - **SNMP Checker**: Requires TCP port `50080`. ``` - [ ] **Apply / Chat**  <details><summary>Suggestion importance[1-10]: 6</summary> __ Why: The suggestion correctly identifies that useful firewall configuration details for optional checkers were removed in the refactoring, and restoring them improves the documentation's completeness and usability. </details></details></td><td align=center>Low </td></tr> <tr><td align="center" colspan="2"> - [ ] Update  </td><td></td></tr></tbody></table>