Skip to content

docs: review fixes, Mermaid architecture diagrams, licensing details, and troubleshooting playbooks - #823

Merged
blue4209211 merged 15 commits into
mainfrom
fix/pr-822-review-feedback
Aug 20, 2026
Merged

docs: review fixes, Mermaid architecture diagrams, licensing details, and troubleshooting playbooks#823
blue4209211 merged 15 commits into
mainfrom
fix/pr-822-review-feedback

Conversation

@blue4209211

@blue4209211 blue4209211 commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

This PR incorporates all review feedback from PR #822 and introduces comprehensive visual, architectural, and diagnostic enhancements:

1. Licensing Clarifications (editions.md)

  • Explicitly stated BSL 1.1 for the core NudgeBee Server control plane and Apache 2.0 for the Kubernetes Agent (k8s-agent) and Proxy Agent (forager).
  • Clarified Community edition capabilities vs. Enterprise (SAML 2.0, managed models, SLAs) and Cloud (SaaS multi-tenancy).

2. Modern Mermaid Architecture Diagrams

  • Landing Page Overview (index.md): Added a full-stack topology diagram showing Monitored Infrastructure (K8s, VMs, Cloud) $\rightarrow$ Outbound Egress (TCP 443) $\rightarrow$ Server Control Plane (Relay, API, RabbitMQ, PostgreSQL, Qdrant, Temporal) $\rightarrow$ Integrations (LLMs, Slack, GitOps).
  • Server Architecture (installation/server/index.md): Replaced outdated raster PNG with a responsive Mermaid flowchart.
  • Agent Architecture (installation/agent/index.md): Replaced outdated raster PNG with a Mermaid diagram depicting the Runner, Kubewatch forwarder, eBPF Node Agent, OpenCost, and Prometheus.

3. Server Installation Troubleshooting Playbook (installation/server/index.md)

Upgraded Section 7 into a structured diagnostic guide covering:

  • Post-install schema migration timeouts and stale migration locks.
  • Database DNS lookup and connection issues (bundled vs external PostgreSQL).
  • RabbitMQ connection and broker consumer initialization.
  • Ingress 502 Bad Gateway and WebSocket upgrade timeout annotations (proxy-read-timeout: 3600).
  • Control plane pod OOMKilled diagnostics (exit code 137) and memory sizing.

4. In-Depth Agent Troubleshooting Guide (installation/agent/installation/index.md)

Added diagnostic scenarios for:

  • node-agent eBPF probe load failures on Bottlerocket, Talos, and GKE COS (with fallback --set nodeAgent.ebpf.enabled=false).
  • Prometheus DNS resolution and zero-metrics triage.
  • Outbound firewall and Kubernetes default-deny NetworkPolicy definitions.
  • OpenCost cloud pricing and billing credentials.

5. Review & Syntax Fixes

  • Replaced LaTeX arrows with standard unicode arrows ().
  • Added Prometheus Helm install step to GKE setup tab.
  • Clarified AWS Bedrock model IDs vs. cross-region inference profiles.

Verification

  • Tested with npm run build inside doc-server: 0 errors, 0 broken links, 0 broken anchors.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation by replacing LaTeX-style arrows with standard unicode arrows, adding comments about AWS Bedrock model IDs in the LLM integration guide, and introducing a step to install Prometheus via Helm in the agent installation guide. A review comment correctly points out that the Prometheus installation step is missing the registration of the "prometheus-community" Helm repository, which would cause the installation command to fail, and provides a code suggestion to add the repository registration commands.

Comment thread doc-server/docs/installation/agent/installation/index.md
…ehensive server/agent troubleshooting playbooks
@blue4209211 blue4209211 changed the title docs: address review feedback on LaTeX arrows, GKE Prometheus step, and Bedrock model IDs docs: review fixes, Mermaid architecture diagrams, licensing details, and troubleshooting playbooks Aug 20, 2026
…ference architecture and streamline landing page
…rchitecture diagram and structured 9-layer reference table
…eractive Mermaid diagrams for runtime microservices
@blue4209211
blue4209211 merged commit e1a4988 into main Aug 20, 2026
4 checks passed
@blue4209211
blue4209211 deleted the fix/pr-822-review-feedback branch August 20, 2026 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants